Universal API Implementation Guide
1.1.19 - ci-build

Universal API Implementation Guide - Local Development build (v1.1.19). See the Directory of published versions

Resource Profile: UAPI MedicationRequest

Official URL: https://fhir.developer.gene.com/StructureDefinition/uapi-medicationrequest Version: 1.1.19
Active as of 2021-06-04 Responsible: Genentech USIX PE Realm: United States of America flag Computable Name: UapiMedicationRequest

This profile constrains the MedicationRequest resource to be included in UAPI data exchanges

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from MedicationRequest

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationRequest 0..*MedicationRequestOrdering of medication for patient or group
... status 1..1codeactive | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown
Required Pattern: active
... intent 1..1codeproposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
Required Pattern: order
... Slices for medication[x] 1..1CodeableConceptMedication to be taken
Slice: Unordered, Open by type:$this
.... medication[x]:medicationCodeableConcept S1..1CodeableConceptMedication to be taken
..... coding
...... system 1..1uriIdentity of the terminology system
Required Pattern: https://fhir.developer.gene.com/CodeSystem/uapi-product-name
...... code 1..1codeSymbol in syntax defined by the system
Binding: UAPI Value Set - Product Name (required)
.... reference 0..1stringPatient resource UUID
.... type 0..1uriType the reference refers to (e.g. "Patient")
Required Pattern: Patient
... requester 1..1Reference(UAPI Practitioner)Who/What requested the Request
.... reference 0..1stringPractitioner resource UUID
.... type 0..1uriType the reference refers to (e.g. "Patient")
Required Pattern: Practitioner
... insurance 0..*Reference(UAPI Coverage)Associated insurance coverage
.... reference 0..1stringCoverage resource UUID
.... type 0..1uriType the reference refers to (e.g. "Patient")
Required Pattern: Coverage
... note
.... text 1..1markdownAdditional dosage instruction
... dosageInstruction 0..1DosageHow the medication should be taken
.... doseAndRate 1..*ElementAmount of medication administered
..... Slices for dose[x] 1..1SimpleQuantityAmount of medication per dose
Slice: Unordered, Open by type:$this
...... dose[x]:doseQuantity 1..1SimpleQuantityA fixed quantity (no comparator)
....... value 1..1decimalNumerical value (with implicit precision)
....... unit 1..1stringUnit representation
... dispenseRequest
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... dispenserInstruction 0..*AnnotationUAPI MedicationRequest Dispenser Instructions
URL: https://fhir.developer.gene.com/StructureDefinition/dispenser-instruction
.... dispenseQuantityDetail 0..*(Complex)UAPI MedicationRequest Dispense Quantity Detailed Breakdown
URL: https://fhir.developer.gene.com/StructureDefinition/dispense-quantity-detail

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
MedicationRequest.medication[x]:medicationCodeableConcept.coding.coderequiredUapiValueSetProductName (a valid code from UAPI Code System - Product Names)
NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationRequest 0..*MedicationRequestOrdering of medication for patient or group
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!Σ1..1codeactive | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown
Binding: medicationrequest Status (required): A coded concept specifying the state of the prescribing event. Describes the lifecycle of the prescription.


Required Pattern: active
... doNotPerform ?!Σ0..1booleanTrue if request is prohibiting action
... Slices for medication[x] Σ1..1CodeableConceptMedication to be taken
Slice: Unordered, Closed by type:$this
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered.

.... medication[x]:medicationCodeableConcept SΣ1..1CodeableConceptMedication to be taken
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered.

... subject Σ1..1Reference(UAPI Patient)Who or group medication request is for
.... reference ΣC0..1stringPatient resource UUID
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
Required Pattern: Patient
... requester Σ1..1Reference(UAPI Practitioner)Who/What requested the Request
.... reference ΣC0..1stringPractitioner resource UUID
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
Required Pattern: Practitioner
... insurance 0..*Reference(UAPI Coverage)Associated insurance coverage
.... reference ΣC0..1stringCoverage resource UUID
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
Required Pattern: Coverage
... dosageInstruction 0..1DosageHow the medication should be taken
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... doseAndRate Σ1..*ElementAmount of medication administered
..... Slices for dose[x] Σ1..1SimpleQuantityAmount of medication per dose
Slice: Unordered, Closed by type:$this
...... dose[x]:doseQuantity C1..1SimpleQuantityA fixed quantity (no comparator)
....... value Σ1..1decimalNumerical value (with implicit precision)
....... unit Σ1..1stringUnit representation

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
MedicationRequest.statusrequiredPattern: active
MedicationRequest.intentrequiredPattern: order
MedicationRequest.medication[x]exampleSNOMEDCTMedicationCodes
MedicationRequest.medication[x]:medicationCodeableConceptexampleSNOMEDCTMedicationCodes
MedicationRequest.subject.typeextensiblePattern: Patient
MedicationRequest.requester.typeextensiblePattern: Practitioner
MedicationRequest.insurance.typeextensiblePattern: Coverage
NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationRequest 0..*MedicationRequestOrdering of medication for patient or group
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): IETF language tag

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*IdentifierExternal ids for this request
... status ?!Σ1..1codeactive | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown
Binding: medicationrequest Status (required): A coded concept specifying the state of the prescribing event. Describes the lifecycle of the prescription.


Required Pattern: active
... statusReason 0..1CodeableConceptReason for current status
Binding: medicationRequest Status Reason Codes (example): Identifies the reasons for a given status.

... intent ?!Σ1..1codeproposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
Binding: medicationRequest Intent (required): The kind of medication order.


Required Pattern: order
... category 0..*CodeableConceptType of medication usage
Binding: medicationRequest Category Codes (example): A coded concept identifying the category of medication request. For example, where the medication is to be consumed or administered, or the type of medication treatment.


... priority Σ0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.

... doNotPerform ?!Σ0..1booleanTrue if request is prohibiting action
... reported[x] Σ0..1Reported rather than primary record
.... reportedBooleanboolean
.... reportedReferenceReference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization)
... Slices for medication[x] Σ1..1CodeableConceptMedication to be taken
Slice: Unordered, Closed by type:$this
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered.

.... medication[x]:medicationCodeableConcept SΣ1..1CodeableConceptMedication to be taken
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered.

..... id 0..1idUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..*CodingCode defined by a terminology system
...... id 0..1idUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Required Pattern: https://fhir.developer.gene.com/CodeSystem/uapi-product-name
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ1..1codeSymbol in syntax defined by the system
Binding: UAPI Value Set - Product Name (required)
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ0..1stringPlain text representation of the concept
... subject Σ1..1Reference(UAPI Patient)Who or group medication request is for
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC0..1stringPatient resource UUID
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
Required Pattern: Patient
.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ0..1stringText alternative for the resource
... encounter 0..1Reference(Encounter)Encounter created as part of encounter/admission/stay
... supportingInformation 0..*Reference(Resource)Information to support ordering of the medication
... authoredOn Σ0..1dateTimeWhen request was initially authored
... requester Σ1..1Reference(UAPI Practitioner)Who/What requested the Request
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC0..1stringPractitioner resource UUID
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
Required Pattern: Practitioner
.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ0..1stringText alternative for the resource
... performer 0..1Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson | CareTeam)Intended performer of administration
... performerType Σ0..1CodeableConceptDesired kind of performer of the medication administration
Binding: ProcedurePerformerRoleCodes (example): Identifies the type of individual that is desired to administer the medication.

... recorder 0..1Reference(Practitioner | PractitionerRole)Person who entered the request
... reasonCode 0..*CodeableConceptReason or indication for ordering or not ordering the medication
Binding: Condition/Problem/DiagnosisCodes (example): A coded concept indicating why the medication was ordered.


... reasonReference 0..*Reference(Condition | Observation)Condition or observation that supports why the prescription is being written
... instantiatesCanonical Σ0..*canonical()Instantiates FHIR protocol or definition
... instantiatesUri Σ0..*uriInstantiates external protocol or definition
... basedOn Σ0..*Reference(CarePlan | MedicationRequest | ServiceRequest | ImmunizationRecommendation)What request fulfills
... groupIdentifier Σ0..1IdentifierComposite request this is part of
... courseOfTherapyType 0..1CodeableConceptOverall pattern of medication administration
Binding: medicationRequest Course of Therapy Codes (example): Identifies the overall pattern of medication administratio.

... insurance 0..*Reference(UAPI Coverage)Associated insurance coverage
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC0..1stringCoverage resource UUID
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
Required Pattern: Coverage
.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ0..1stringText alternative for the resource
... note 0..*AnnotationInformation about the prescription
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... author[x] Σ0..1Individual responsible for the annotation
..... authorReferenceReference(Practitioner | Patient | RelatedPerson | Organization)
..... authorStringstring
.... time Σ0..1dateTimeWhen the annotation was made
.... text Σ1..1markdownAdditional dosage instruction
... dosageInstruction 0..1DosageHow the medication should be taken
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... sequence Σ0..1integerThe order of the dosage instructions
.... text Σ0..1stringFree text dosage instructions e.g. SIG
.... additionalInstruction Σ0..*CodeableConceptSupplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness"
Binding: SNOMEDCTAdditionalDosageInstructions (example)
.... patientInstruction Σ0..1stringPatient or consumer oriented instructions
.... timing Σ0..1TimingWhen medication should be administered
.... asNeeded[x] Σ0..1Take "as needed" (for x)
Binding: SNOMEDCTMedicationAsNeededReasonCodes (example)
..... asNeededBooleanboolean
..... asNeededCodeableConceptCodeableConcept
.... site Σ0..1CodeableConceptBody site to administer to
Binding: SNOMEDCTAnatomicalStructureForAdministrationSiteCodes (example)
.... route Σ0..1CodeableConceptHow drug should enter body
Binding: SNOMEDCTRouteCodes (example)
.... method Σ0..1CodeableConceptTechnique for administering medication
Binding: SNOMEDCTAdministrationMethodCodes (example)
.... doseAndRate Σ1..*ElementAmount of medication administered
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... type Σ0..1CodeableConceptThe kind of dose or rate specified
Binding: DoseAndRateType (example)
..... Slices for dose[x] Σ1..1SimpleQuantityAmount of medication per dose
Slice: Unordered, Closed by type:$this
...... dose[x]:doseQuantity C1..1SimpleQuantityA fixed quantity (no comparator)
....... id 0..1idUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... value Σ1..1decimalNumerical value (with implicit precision)
....... unit Σ1..1stringUnit representation
....... system ΣC0..1uriSystem that defines coded unit form
....... code Σ0..1codeCoded form of the unit
..... rate[x] Σ0..1Amount of medication per unit of time
...... rateRatioRatio
...... rateRangeRange
...... rateQuantityQuantity(SimpleQuantity)
.... maxDosePerPeriod Σ0..1RatioUpper limit on medication per unit of time
.... maxDosePerAdministration Σ0..1SimpleQuantityUpper limit on medication per administration
.... maxDosePerLifetime Σ0..1SimpleQuantityUpper limit on medication per lifetime of the patient
... dispenseRequest 0..1BackboneElementMedication supply authorization
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... dispenserInstruction 0..*AnnotationUAPI MedicationRequest Dispenser Instructions
URL: https://fhir.developer.gene.com/StructureDefinition/dispenser-instruction
.... dispenseQuantityDetail 0..*(Complex)UAPI MedicationRequest Dispense Quantity Detailed Breakdown
URL: https://fhir.developer.gene.com/StructureDefinition/dispense-quantity-detail
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... initialFill 0..1BackboneElementFirst fill details
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... quantity 0..1SimpleQuantityFirst fill quantity
..... duration 0..1DurationFirst fill duration
.... dispenseInterval 0..1DurationMinimum period of time between dispenses
.... validityPeriod 0..1PeriodTime period supply is authorized for
.... numberOfRepeatsAllowed 0..1unsignedIntNumber of refills authorized
.... quantity 0..1SimpleQuantityAmount of medication to supply per dispense
.... expectedSupplyDuration 0..1DurationNumber of days supply per dispense
.... performer 0..1Reference(Organization)Intended dispenser
... substitution 0..1BackboneElementAny restrictions on medication substitution
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... allowed[x] 1..1Whether substitution is allowed or not
Binding: ActSubstanceAdminSubstitutionCode (example): Identifies the type of substitution allowed.

..... allowedBooleanboolean
..... allowedCodeableConceptCodeableConcept
.... reason 0..1CodeableConceptWhy should (not) substitution be made
Binding: SubstanceAdminSubstitutionReason (example): SubstanceAdminSubstitutionReason

... priorPrescription 0..1Reference(MedicationRequest)An order/prescription that is being replaced
... detectedIssue 0..*Reference(DetectedIssue)Clinical Issue with action
... eventHistory 0..*Reference(Provenance)A list of events of interest in the lifecycle

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
MedicationRequest.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
MedicationRequest.statusrequiredPattern: active
MedicationRequest.statusReasonexamplemedicationRequest Status Reason Codes
MedicationRequest.intentrequiredPattern: order
MedicationRequest.categoryexamplemedicationRequest Category Codes
MedicationRequest.priorityrequiredRequestPriority
MedicationRequest.medication[x]exampleSNOMEDCTMedicationCodes
MedicationRequest.medication[x]:medicationCodeableConceptexampleSNOMEDCTMedicationCodes
MedicationRequest.medication[x]:medicationCodeableConcept.coding.coderequiredUapiValueSetProductName (a valid code from UAPI Code System - Product Names)
MedicationRequest.subject.typeextensiblePattern: Patient
MedicationRequest.requester.typeextensiblePattern: Practitioner
MedicationRequest.performerTypeexampleProcedurePerformerRoleCodes
MedicationRequest.reasonCodeexampleCondition/Problem/DiagnosisCodes
MedicationRequest.courseOfTherapyTypeexamplemedicationRequest Course of Therapy Codes
MedicationRequest.insurance.typeextensiblePattern: Coverage
MedicationRequest.dosageInstruction.additionalInstructionexampleSNOMEDCTAdditionalDosageInstructions
MedicationRequest.dosageInstruction.asNeeded[x]exampleSNOMEDCTMedicationAsNeededReasonCodes
MedicationRequest.dosageInstruction.siteexampleSNOMEDCTAnatomicalStructureForAdministrationSiteCodes
MedicationRequest.dosageInstruction.routeexampleSNOMEDCTRouteCodes
MedicationRequest.dosageInstruction.methodexampleSNOMEDCTAdministrationMethodCodes
MedicationRequest.dosageInstruction.doseAndRate.typeexampleDoseAndRateType
MedicationRequest.substitution.allowed[x]exampleActSubstanceAdminSubstitutionCode
MedicationRequest.substitution.reasonexampleSubstanceAdminSubstitutionReason

This structure is derived from MedicationRequest

Summary

Mandatory: 2 elements (7 nested mandatory elements)
Must-Support: 1 element

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element MedicationRequest.medication[x] is sliced based on the value of type:$this
  • The element MedicationRequest.dosageInstruction.doseAndRate.dose[x] is sliced based on the value of type:$this

Differential View

This structure is derived from MedicationRequest

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationRequest 0..*MedicationRequestOrdering of medication for patient or group
... status 1..1codeactive | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown
Required Pattern: active
... intent 1..1codeproposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
Required Pattern: order
... Slices for medication[x] 1..1CodeableConceptMedication to be taken
Slice: Unordered, Open by type:$this
.... medication[x]:medicationCodeableConcept S1..1CodeableConceptMedication to be taken
..... coding
...... system 1..1uriIdentity of the terminology system
Required Pattern: https://fhir.developer.gene.com/CodeSystem/uapi-product-name
...... code 1..1codeSymbol in syntax defined by the system
Binding: UAPI Value Set - Product Name (required)
.... reference 0..1stringPatient resource UUID
.... type 0..1uriType the reference refers to (e.g. "Patient")
Required Pattern: Patient
... requester 1..1Reference(UAPI Practitioner)Who/What requested the Request
.... reference 0..1stringPractitioner resource UUID
.... type 0..1uriType the reference refers to (e.g. "Patient")
Required Pattern: Practitioner
... insurance 0..*Reference(UAPI Coverage)Associated insurance coverage
.... reference 0..1stringCoverage resource UUID
.... type 0..1uriType the reference refers to (e.g. "Patient")
Required Pattern: Coverage
... note
.... text 1..1markdownAdditional dosage instruction
... dosageInstruction 0..1DosageHow the medication should be taken
.... doseAndRate 1..*ElementAmount of medication administered
..... Slices for dose[x] 1..1SimpleQuantityAmount of medication per dose
Slice: Unordered, Open by type:$this
...... dose[x]:doseQuantity 1..1SimpleQuantityA fixed quantity (no comparator)
....... value 1..1decimalNumerical value (with implicit precision)
....... unit 1..1stringUnit representation
... dispenseRequest
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... dispenserInstruction 0..*AnnotationUAPI MedicationRequest Dispenser Instructions
URL: https://fhir.developer.gene.com/StructureDefinition/dispenser-instruction
.... dispenseQuantityDetail 0..*(Complex)UAPI MedicationRequest Dispense Quantity Detailed Breakdown
URL: https://fhir.developer.gene.com/StructureDefinition/dispense-quantity-detail

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
MedicationRequest.medication[x]:medicationCodeableConcept.coding.coderequiredUapiValueSetProductName (a valid code from UAPI Code System - Product Names)

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationRequest 0..*MedicationRequestOrdering of medication for patient or group
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!Σ1..1codeactive | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown
Binding: medicationrequest Status (required): A coded concept specifying the state of the prescribing event. Describes the lifecycle of the prescription.


Required Pattern: active
... doNotPerform ?!Σ0..1booleanTrue if request is prohibiting action
... Slices for medication[x] Σ1..1CodeableConceptMedication to be taken
Slice: Unordered, Closed by type:$this
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered.

.... medication[x]:medicationCodeableConcept SΣ1..1CodeableConceptMedication to be taken
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered.

... subject Σ1..1Reference(UAPI Patient)Who or group medication request is for
.... reference ΣC0..1stringPatient resource UUID
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
Required Pattern: Patient
... requester Σ1..1Reference(UAPI Practitioner)Who/What requested the Request
.... reference ΣC0..1stringPractitioner resource UUID
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
Required Pattern: Practitioner
... insurance 0..*Reference(UAPI Coverage)Associated insurance coverage
.... reference ΣC0..1stringCoverage resource UUID
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
Required Pattern: Coverage
... dosageInstruction 0..1DosageHow the medication should be taken
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... doseAndRate Σ1..*ElementAmount of medication administered
..... Slices for dose[x] Σ1..1SimpleQuantityAmount of medication per dose
Slice: Unordered, Closed by type:$this
...... dose[x]:doseQuantity C1..1SimpleQuantityA fixed quantity (no comparator)
....... value Σ1..1decimalNumerical value (with implicit precision)
....... unit Σ1..1stringUnit representation

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
MedicationRequest.statusrequiredPattern: active
MedicationRequest.intentrequiredPattern: order
MedicationRequest.medication[x]exampleSNOMEDCTMedicationCodes
MedicationRequest.medication[x]:medicationCodeableConceptexampleSNOMEDCTMedicationCodes
MedicationRequest.subject.typeextensiblePattern: Patient
MedicationRequest.requester.typeextensiblePattern: Practitioner
MedicationRequest.insurance.typeextensiblePattern: Coverage

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationRequest 0..*MedicationRequestOrdering of medication for patient or group
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): IETF language tag

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*IdentifierExternal ids for this request
... status ?!Σ1..1codeactive | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown
Binding: medicationrequest Status (required): A coded concept specifying the state of the prescribing event. Describes the lifecycle of the prescription.


Required Pattern: active
... statusReason 0..1CodeableConceptReason for current status
Binding: medicationRequest Status Reason Codes (example): Identifies the reasons for a given status.

... intent ?!Σ1..1codeproposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
Binding: medicationRequest Intent (required): The kind of medication order.


Required Pattern: order
... category 0..*CodeableConceptType of medication usage
Binding: medicationRequest Category Codes (example): A coded concept identifying the category of medication request. For example, where the medication is to be consumed or administered, or the type of medication treatment.


... priority Σ0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.

... doNotPerform ?!Σ0..1booleanTrue if request is prohibiting action
... reported[x] Σ0..1Reported rather than primary record
.... reportedBooleanboolean
.... reportedReferenceReference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization)
... Slices for medication[x] Σ1..1CodeableConceptMedication to be taken
Slice: Unordered, Closed by type:$this
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered.

.... medication[x]:medicationCodeableConcept SΣ1..1CodeableConceptMedication to be taken
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered.

..... id 0..1idUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..*CodingCode defined by a terminology system
...... id 0..1idUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Required Pattern: https://fhir.developer.gene.com/CodeSystem/uapi-product-name
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ1..1codeSymbol in syntax defined by the system
Binding: UAPI Value Set - Product Name (required)
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ0..1stringPlain text representation of the concept
... subject Σ1..1Reference(UAPI Patient)Who or group medication request is for
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC0..1stringPatient resource UUID
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
Required Pattern: Patient
.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ0..1stringText alternative for the resource
... encounter 0..1Reference(Encounter)Encounter created as part of encounter/admission/stay
... supportingInformation 0..*Reference(Resource)Information to support ordering of the medication
... authoredOn Σ0..1dateTimeWhen request was initially authored
... requester Σ1..1Reference(UAPI Practitioner)Who/What requested the Request
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC0..1stringPractitioner resource UUID
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
Required Pattern: Practitioner
.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ0..1stringText alternative for the resource
... performer 0..1Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson | CareTeam)Intended performer of administration
... performerType Σ0..1CodeableConceptDesired kind of performer of the medication administration
Binding: ProcedurePerformerRoleCodes (example): Identifies the type of individual that is desired to administer the medication.

... recorder 0..1Reference(Practitioner | PractitionerRole)Person who entered the request
... reasonCode 0..*CodeableConceptReason or indication for ordering or not ordering the medication
Binding: Condition/Problem/DiagnosisCodes (example): A coded concept indicating why the medication was ordered.


... reasonReference 0..*Reference(Condition | Observation)Condition or observation that supports why the prescription is being written
... instantiatesCanonical Σ0..*canonical()Instantiates FHIR protocol or definition
... instantiatesUri Σ0..*uriInstantiates external protocol or definition
... basedOn Σ0..*Reference(CarePlan | MedicationRequest | ServiceRequest | ImmunizationRecommendation)What request fulfills
... groupIdentifier Σ0..1IdentifierComposite request this is part of
... courseOfTherapyType 0..1CodeableConceptOverall pattern of medication administration
Binding: medicationRequest Course of Therapy Codes (example): Identifies the overall pattern of medication administratio.

... insurance 0..*Reference(UAPI Coverage)Associated insurance coverage
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC0..1stringCoverage resource UUID
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
Required Pattern: Coverage
.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ0..1stringText alternative for the resource
... note 0..*AnnotationInformation about the prescription
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... author[x] Σ0..1Individual responsible for the annotation
..... authorReferenceReference(Practitioner | Patient | RelatedPerson | Organization)
..... authorStringstring
.... time Σ0..1dateTimeWhen the annotation was made
.... text Σ1..1markdownAdditional dosage instruction
... dosageInstruction 0..1DosageHow the medication should be taken
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... sequence Σ0..1integerThe order of the dosage instructions
.... text Σ0..1stringFree text dosage instructions e.g. SIG
.... additionalInstruction Σ0..*CodeableConceptSupplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness"
Binding: SNOMEDCTAdditionalDosageInstructions (example)
.... patientInstruction Σ0..1stringPatient or consumer oriented instructions
.... timing Σ0..1TimingWhen medication should be administered
.... asNeeded[x] Σ0..1Take "as needed" (for x)
Binding: SNOMEDCTMedicationAsNeededReasonCodes (example)
..... asNeededBooleanboolean
..... asNeededCodeableConceptCodeableConcept
.... site Σ0..1CodeableConceptBody site to administer to
Binding: SNOMEDCTAnatomicalStructureForAdministrationSiteCodes (example)
.... route Σ0..1CodeableConceptHow drug should enter body
Binding: SNOMEDCTRouteCodes (example)
.... method Σ0..1CodeableConceptTechnique for administering medication
Binding: SNOMEDCTAdministrationMethodCodes (example)
.... doseAndRate Σ1..*ElementAmount of medication administered
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... type Σ0..1CodeableConceptThe kind of dose or rate specified
Binding: DoseAndRateType (example)
..... Slices for dose[x] Σ1..1SimpleQuantityAmount of medication per dose
Slice: Unordered, Closed by type:$this
...... dose[x]:doseQuantity C1..1SimpleQuantityA fixed quantity (no comparator)
....... id 0..1idUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... value Σ1..1decimalNumerical value (with implicit precision)
....... unit Σ1..1stringUnit representation
....... system ΣC0..1uriSystem that defines coded unit form
....... code Σ0..1codeCoded form of the unit
..... rate[x] Σ0..1Amount of medication per unit of time
...... rateRatioRatio
...... rateRangeRange
...... rateQuantityQuantity(SimpleQuantity)
.... maxDosePerPeriod Σ0..1RatioUpper limit on medication per unit of time
.... maxDosePerAdministration Σ0..1SimpleQuantityUpper limit on medication per administration
.... maxDosePerLifetime Σ0..1SimpleQuantityUpper limit on medication per lifetime of the patient
... dispenseRequest 0..1BackboneElementMedication supply authorization
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... dispenserInstruction 0..*AnnotationUAPI MedicationRequest Dispenser Instructions
URL: https://fhir.developer.gene.com/StructureDefinition/dispenser-instruction
.... dispenseQuantityDetail 0..*(Complex)UAPI MedicationRequest Dispense Quantity Detailed Breakdown
URL: https://fhir.developer.gene.com/StructureDefinition/dispense-quantity-detail
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... initialFill 0..1BackboneElementFirst fill details
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... quantity 0..1SimpleQuantityFirst fill quantity
..... duration 0..1DurationFirst fill duration
.... dispenseInterval 0..1DurationMinimum period of time between dispenses
.... validityPeriod 0..1PeriodTime period supply is authorized for
.... numberOfRepeatsAllowed 0..1unsignedIntNumber of refills authorized
.... quantity 0..1SimpleQuantityAmount of medication to supply per dispense
.... expectedSupplyDuration 0..1DurationNumber of days supply per dispense
.... performer 0..1Reference(Organization)Intended dispenser
... substitution 0..1BackboneElementAny restrictions on medication substitution
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... allowed[x] 1..1Whether substitution is allowed or not
Binding: ActSubstanceAdminSubstitutionCode (example): Identifies the type of substitution allowed.

..... allowedBooleanboolean
..... allowedCodeableConceptCodeableConcept
.... reason 0..1CodeableConceptWhy should (not) substitution be made
Binding: SubstanceAdminSubstitutionReason (example): SubstanceAdminSubstitutionReason

... priorPrescription 0..1Reference(MedicationRequest)An order/prescription that is being replaced
... detectedIssue 0..*Reference(DetectedIssue)Clinical Issue with action
... eventHistory 0..*Reference(Provenance)A list of events of interest in the lifecycle

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
MedicationRequest.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
MedicationRequest.statusrequiredPattern: active
MedicationRequest.statusReasonexamplemedicationRequest Status Reason Codes
MedicationRequest.intentrequiredPattern: order
MedicationRequest.categoryexamplemedicationRequest Category Codes
MedicationRequest.priorityrequiredRequestPriority
MedicationRequest.medication[x]exampleSNOMEDCTMedicationCodes
MedicationRequest.medication[x]:medicationCodeableConceptexampleSNOMEDCTMedicationCodes
MedicationRequest.medication[x]:medicationCodeableConcept.coding.coderequiredUapiValueSetProductName (a valid code from UAPI Code System - Product Names)
MedicationRequest.subject.typeextensiblePattern: Patient
MedicationRequest.requester.typeextensiblePattern: Practitioner
MedicationRequest.performerTypeexampleProcedurePerformerRoleCodes
MedicationRequest.reasonCodeexampleCondition/Problem/DiagnosisCodes
MedicationRequest.courseOfTherapyTypeexamplemedicationRequest Course of Therapy Codes
MedicationRequest.insurance.typeextensiblePattern: Coverage
MedicationRequest.dosageInstruction.additionalInstructionexampleSNOMEDCTAdditionalDosageInstructions
MedicationRequest.dosageInstruction.asNeeded[x]exampleSNOMEDCTMedicationAsNeededReasonCodes
MedicationRequest.dosageInstruction.siteexampleSNOMEDCTAnatomicalStructureForAdministrationSiteCodes
MedicationRequest.dosageInstruction.routeexampleSNOMEDCTRouteCodes
MedicationRequest.dosageInstruction.methodexampleSNOMEDCTAdministrationMethodCodes
MedicationRequest.dosageInstruction.doseAndRate.typeexampleDoseAndRateType
MedicationRequest.substitution.allowed[x]exampleActSubstanceAdminSubstitutionCode
MedicationRequest.substitution.reasonexampleSubstanceAdminSubstitutionReason

This structure is derived from MedicationRequest

Summary

Mandatory: 2 elements (7 nested mandatory elements)
Must-Support: 1 element

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element MedicationRequest.medication[x] is sliced based on the value of type:$this
  • The element MedicationRequest.dosageInstruction.doseAndRate.dose[x] is sliced based on the value of type:$this

 

Other representations of profile: CSV, Excel, Schematron