Universal API Implementation Guide
1.1.20 - ci-build

Universal API Implementation Guide - Local Development build (v1.1.20) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: UAPI MedicationRequest

Official URL: https://fhir.developer.gene.com/StructureDefinition/uapi-medicationrequest Version: 1.1.20
Active as of 2021-06-04 Computable Name: UapiMedicationRequest

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

Usages:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationRequest 0..* MedicationRequest Ordering of medication for patient or group
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!Σ 1..1 code active | 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..1 boolean True if request is prohibiting action
... Slices for medication[x] Σ 1..1 CodeableConcept Medication 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..1 CodeableConcept Medication to be taken
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered.
..... Slices for coding Σ 1..* Coding Code defined by a terminology system
Slice: Unordered, Closed by value:system
...... coding:codingFromSystem1 Σ 0..* Coding Code defined by a terminology system
....... system Σ 1..1 uri Identity of the terminology system
Required Pattern: https://fhir.developer.gene.com/CodeSystem/uapi-product-name
....... code Σ 0..1 code Symbol in syntax defined by the system
Binding: UAPI Value Set - Product Name (required)
...... coding:codingFromSystem2 Σ 0..* Coding Code defined by a terminology system
....... system Σ 1..1 uri Identity of the terminology system
Required Pattern: https://fhir.developer.gene.com/CodeSystem/uapi-regimen-product-name
....... code Σ 0..1 code Symbol in syntax defined by the system
Binding: UAPI Value Set - Regimen Product Name (required)
... subject Σ 1..1 Reference(UAPI Patient) Who or group medication request is for
.... reference ΣC 0..1 string Patient resource UUID
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
Required Pattern: Patient
... requester Σ 1..1 Reference(UAPI Practitioner) Who/What requested the Request
.... reference ΣC 0..1 string Practitioner resource UUID
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
Required Pattern: Practitioner
... insurance 0..* Reference(UAPI Coverage) Associated insurance coverage
.... reference ΣC 0..1 string Coverage resource UUID
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
Required Pattern: Coverage
... dosageInstruction 0..1 Dosage How the medication should be taken
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... doseAndRate Σ 1..* Element Amount of medication administered
..... Slices for dose[x] Σ 1..1 SimpleQuantity Amount of medication per dose
Slice: Unordered, Closed by type:$this
...... dose[x]:doseQuantity Σ 1..1 SimpleQuantity Amount of medication per dose
....... value Σ 1..1 decimal Numerical value (with implicit precision)
....... unit Σ 1..1 string Unit representation

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
MedicationRequest.statusrequiredPattern Value: active
http://hl7.org/fhir/ValueSet/medicationrequest-status|4.3.0
From the FHIR Standard
MedicationRequest.intentrequiredPattern Value: order
http://hl7.org/fhir/ValueSet/medicationrequest-intent|4.3.0
From the FHIR Standard
MedicationRequest.medication[x]exampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
From the FHIR Standard
MedicationRequest.medication[x]:medicationCodeableConceptexampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
From the FHIR Standard
MedicationRequest.medication[x]:medicationCodeableConcept.coding:codingFromSystem1.coderequiredUapiValueSetProductName(a valid code from UAPI Code System - Product Names)
https://fhir.developer.gene.com/ValueSet/uapi-prod-name
From this IG
MedicationRequest.medication[x]:medicationCodeableConcept.coding:codingFromSystem2.coderequiredUapiValueSetRegimenProductName(a valid code from UAPI Code System - Regimen Product Names)
https://fhir.developer.gene.com/ValueSet/uapi-regimen-prod-name
From this IG
MedicationRequest.subject.typeextensiblePattern Value: Patient
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
MedicationRequest.requester.typeextensiblePattern Value: Practitioner
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
MedicationRequest.insurance.typeextensiblePattern Value: Coverage
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMedicationRequestIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationRequestIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorMedicationRequestIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorMedicationRequestIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationRequestA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from MedicationRequest

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationRequest MedicationRequest
... status 1..1 code active | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown
Required Pattern: active
... intent 1..1 code proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
Required Pattern: order
... Slices for medication[x] 1..1 CodeableConcept Medication to be taken
Slice: Unordered, Open by type:$this
.... medication[x]:medicationCodeableConcept S 1..1 CodeableConcept Medication to be taken
..... Slices for coding 1..* Coding Code defined by a terminology system
Slice: Unordered, Closed by value:system
...... coding:codingFromSystem1 0..* Coding Code defined by a terminology system
....... system 1..1 uri Identity of the terminology system
Required Pattern: https://fhir.developer.gene.com/CodeSystem/uapi-product-name
....... code 0..1 code Symbol in syntax defined by the system
Binding: UAPI Value Set - Product Name (required)
...... coding:codingFromSystem2 0..* Coding Code defined by a terminology system
....... system 1..1 uri Identity of the terminology system
Required Pattern: https://fhir.developer.gene.com/CodeSystem/uapi-regimen-product-name
....... code 0..1 code Symbol in syntax defined by the system
Binding: UAPI Value Set - Regimen Product Name (required)
.... reference 0..1 string Patient resource UUID
.... type 0..1 uri Type the reference refers to (e.g. "Patient")
Required Pattern: Patient
... requester 1..1 Reference(UAPI Practitioner) Who/What requested the Request
.... reference 0..1 string Practitioner resource UUID
.... type 0..1 uri Type the reference refers to (e.g. "Patient")
Required Pattern: Practitioner
... insurance 0..* Reference(UAPI Coverage) Associated insurance coverage
.... reference 0..1 string Coverage resource UUID
.... type 0..1 uri Type the reference refers to (e.g. "Patient")
Required Pattern: Coverage
... note
.... text 1..1 markdown Additional dosage instruction
... dosageInstruction 0..1 Dosage How the medication should be taken
.... doseAndRate 1..* Element Amount of medication administered
..... Slices for dose[x] 1..1 SimpleQuantity Amount of medication per dose
Slice: Unordered, Open by type:$this
...... dose[x]:doseQuantity 1..1 SimpleQuantity Amount of medication per dose
....... value 1..1 decimal Numerical value (with implicit precision)
....... unit 1..1 string Unit representation
... dispenseRequest
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:dispenserInstruction 0..* Annotation UAPI MedicationRequest Dispenser Instructions
URL: https://fhir.developer.gene.com/StructureDefinition/dispenser-instruction
..... extension: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)

PathConformanceValueSetURI
MedicationRequest.medication[x]:medicationCodeableConcept.coding:codingFromSystem1.coderequiredUapiValueSetProductName(a valid code from UAPI Code System - Product Names)
https://fhir.developer.gene.com/ValueSet/uapi-prod-name
From this IG
MedicationRequest.medication[x]:medicationCodeableConcept.coding:codingFromSystem2.coderequiredUapiValueSetRegimenProductName(a valid code from UAPI Code System - Regimen Product Names)
https://fhir.developer.gene.com/ValueSet/uapi-regimen-prod-name
From this IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationRequest 0..* MedicationRequest Ordering of medication for patient or group
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): IETF language tag
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
Constraints: dom-r4b
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier 0..* Identifier External ids for this request
... status ?!Σ 1..1 code active | 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..1 CodeableConcept Reason for current status
Binding: medicationRequest Status Reason Codes (example): Identifies the reasons for a given status.
... intent ?!Σ 1..1 code proposal | 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..* CodeableConcept Type 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..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
... doNotPerform ?!Σ 0..1 boolean True if request is prohibiting action
... reported[x] Σ 0..1 Reported rather than primary record
.... reportedBoolean boolean
.... reportedReference Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization)
... Slices for medication[x] Σ 1..1 CodeableConcept Medication 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..1 CodeableConcept Medication to be taken
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered.
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... Slices for coding Σ 1..* Coding Code defined by a terminology system
Slice: Unordered, Closed by value:system
...... coding:codingFromSystem1 Σ 0..* Coding Code defined by a terminology system
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ 1..1 uri Identity of the terminology system
Required Pattern: https://fhir.developer.gene.com/CodeSystem/uapi-product-name
....... version Σ 0..1 string Version of the system - if relevant
....... code Σ 0..1 code Symbol in syntax defined by the system
Binding: UAPI Value Set - Product Name (required)
....... display Σ 0..1 string Representation defined by the system
....... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
...... coding:codingFromSystem2 Σ 0..* Coding Code defined by a terminology system
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ 1..1 uri Identity of the terminology system
Required Pattern: https://fhir.developer.gene.com/CodeSystem/uapi-regimen-product-name
....... version Σ 0..1 string Version of the system - if relevant
....... code Σ 0..1 code Symbol in syntax defined by the system
Binding: UAPI Value Set - Regimen Product Name (required)
....... display Σ 0..1 string Representation defined by the system
....... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Plain text representation of the concept
... subject Σ 1..1 Reference(UAPI Patient) Who or group medication request is for
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string Patient resource UUID
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
Required Pattern: Patient
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... encounter 0..1 Reference(Encounter) Encounter created as part of encounter/admission/stay
... supportingInformation 0..* Reference(Resource) Information to support ordering of the medication
... authoredOn Σ 0..1 dateTime When request was initially authored
... requester Σ 1..1 Reference(UAPI Practitioner) Who/What requested the Request
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string Practitioner resource UUID
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
Required Pattern: Practitioner
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... performer 0..1 Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson | CareTeam) Intended performer of administration
... performerType Σ 0..1 CodeableConcept Desired kind of performer of the medication administration
Binding: ProcedurePerformerRoleCodes (example): Identifies the type of individual that is desired to administer the medication.
... recorder 0..1 Reference(Practitioner | PractitionerRole) Person who entered the request
... reasonCode 0..* CodeableConcept Reason 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..* uri Instantiates external protocol or definition
... basedOn Σ 0..* Reference(CarePlan | MedicationRequest | ServiceRequest | ImmunizationRecommendation) What request fulfills
... groupIdentifier Σ 0..1 Identifier Composite request this is part of
... courseOfTherapyType 0..1 CodeableConcept Overall 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..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string Coverage resource UUID
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
Required Pattern: Coverage
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... note 0..* Annotation Information about the prescription
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... author[x] Σ 0..1 Individual responsible for the annotation
..... authorReference Reference(Practitioner | Patient | RelatedPerson | Organization)
..... authorString string
.... time Σ 0..1 dateTime When the annotation was made
.... text Σ 1..1 markdown Additional dosage instruction
... dosageInstruction 0..1 Dosage How the medication should be taken
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... sequence Σ 0..1 integer The order of the dosage instructions
.... text Σ 0..1 string Free text dosage instructions e.g. SIG
.... additionalInstruction Σ 0..* CodeableConcept Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness"
Binding: SNOMEDCTAdditionalDosageInstructions (example)
.... patientInstruction Σ 0..1 string Patient or consumer oriented instructions
.... timing Σ 0..1 Timing When medication should be administered
.... asNeeded[x] Σ 0..1 Take "as needed" (for x)
Binding: SNOMEDCTMedicationAsNeededReasonCodes (example)
..... asNeededBoolean boolean
..... asNeededCodeableConcept CodeableConcept
.... site Σ 0..1 CodeableConcept Body site to administer to
Binding: SNOMEDCTAnatomicalStructureForAdministrationSiteCodes (example)
.... route Σ 0..1 CodeableConcept How drug should enter body
Binding: SNOMEDCTRouteCodes (example)
.... method Σ 0..1 CodeableConcept Technique for administering medication
Binding: SNOMEDCTAdministrationMethodCodes (example)
.... doseAndRate Σ 1..* Element Amount of medication administered
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... type Σ 0..1 CodeableConcept The kind of dose or rate specified
Binding: DoseAndRateType (example)
..... Slices for dose[x] Σ 1..1 SimpleQuantity Amount of medication per dose
Slice: Unordered, Closed by type:$this
...... dose[x]:doseQuantity Σ 1..1 SimpleQuantity Amount of medication per dose
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... value Σ 1..1 decimal Numerical value (with implicit precision)
....... unit Σ 1..1 string Unit representation
....... system ΣC 0..1 uri System that defines coded unit form
....... code Σ 0..1 code Coded form of the unit
..... rate[x] Σ 0..1 Amount of medication per unit of time
...... rateRatio Ratio
...... rateRange Range
...... rateQuantity Quantity(SimpleQuantity)
.... maxDosePerPeriod Σ 0..1 Ratio Upper limit on medication per unit of time
.... maxDosePerAdministration Σ 0..1 SimpleQuantity Upper limit on medication per administration
.... maxDosePerLifetime Σ 0..1 SimpleQuantity Upper limit on medication per lifetime of the patient
... dispenseRequest 0..1 BackboneElement Medication supply authorization
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:dispenserInstruction 0..* Annotation UAPI MedicationRequest Dispenser Instructions
URL: https://fhir.developer.gene.com/StructureDefinition/dispenser-instruction
..... extension:dispenseQuantityDetail 0..* (Complex) UAPI MedicationRequest Dispense Quantity Detailed Breakdown
URL: https://fhir.developer.gene.com/StructureDefinition/dispense-quantity-detail
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... initialFill 0..1 BackboneElement First fill details
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... quantity 0..1 SimpleQuantity First fill quantity
..... duration 0..1 Duration First fill duration
.... dispenseInterval 0..1 Duration Minimum period of time between dispenses
.... validityPeriod 0..1 Period Time period supply is authorized for
.... numberOfRepeatsAllowed 0..1 unsignedInt Number of refills authorized
.... quantity 0..1 SimpleQuantity Amount of medication to supply per dispense
.... expectedSupplyDuration 0..1 Duration Number of days supply per dispense
.... performer 0..1 Reference(Organization) Intended dispenser
... substitution 0..1 BackboneElement Any restrictions on medication substitution
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... allowed[x] 1..1 Whether substitution is allowed or not
Binding: ActSubstanceAdminSubstitutionCode (example): Identifies the type of substitution allowed.
..... allowedBoolean boolean
..... allowedCodeableConcept CodeableConcept
.... reason 0..1 CodeableConcept Why should (not) substitution be made
Binding: SubstanceAdminSubstitutionReason (example): SubstanceAdminSubstitutionReason
... priorPrescription 0..1 Reference(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 / CodeURI
MedicationRequest.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
MedicationRequest.statusrequiredPattern Value: active
http://hl7.org/fhir/ValueSet/medicationrequest-status|4.3.0
From the FHIR Standard
MedicationRequest.statusReasonexamplemedicationRequest Status Reason Codes
http://hl7.org/fhir/ValueSet/medicationrequest-status-reason
From the FHIR Standard
MedicationRequest.intentrequiredPattern Value: order
http://hl7.org/fhir/ValueSet/medicationrequest-intent|4.3.0
From the FHIR Standard
MedicationRequest.categoryexamplemedicationRequest Category Codes
http://hl7.org/fhir/ValueSet/medicationrequest-category
From the FHIR Standard
MedicationRequest.priorityrequiredRequestPriority
http://hl7.org/fhir/ValueSet/request-priority|4.3.0
From the FHIR Standard
MedicationRequest.medication[x]exampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
From the FHIR Standard
MedicationRequest.medication[x]:medicationCodeableConceptexampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
From the FHIR Standard
MedicationRequest.medication[x]:medicationCodeableConcept.coding:codingFromSystem1.coderequiredUapiValueSetProductName(a valid code from UAPI Code System - Product Names)
https://fhir.developer.gene.com/ValueSet/uapi-prod-name
From this IG
MedicationRequest.medication[x]:medicationCodeableConcept.coding:codingFromSystem2.coderequiredUapiValueSetRegimenProductName(a valid code from UAPI Code System - Regimen Product Names)
https://fhir.developer.gene.com/ValueSet/uapi-regimen-prod-name
From this IG
MedicationRequest.subject.typeextensiblePattern Value: Patient
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
MedicationRequest.requester.typeextensiblePattern Value: Practitioner
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
MedicationRequest.performerTypeexampleProcedurePerformerRoleCodes
http://hl7.org/fhir/ValueSet/performer-role
From the FHIR Standard
MedicationRequest.reasonCodeexampleCondition/Problem/DiagnosisCodes
http://hl7.org/fhir/ValueSet/condition-code
From the FHIR Standard
MedicationRequest.courseOfTherapyTypeexamplemedicationRequest Course of Therapy Codes
http://hl7.org/fhir/ValueSet/medicationrequest-course-of-therapy
From the FHIR Standard
MedicationRequest.insurance.typeextensiblePattern Value: Coverage
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
MedicationRequest.dosageInstruction.additionalInstructionexampleSNOMEDCTAdditionalDosageInstructions
http://hl7.org/fhir/ValueSet/additional-instruction-codes
From the FHIR Standard
MedicationRequest.dosageInstruction.asNeeded[x]exampleSNOMEDCTMedicationAsNeededReasonCodes
http://hl7.org/fhir/ValueSet/medication-as-needed-reason
From the FHIR Standard
MedicationRequest.dosageInstruction.siteexampleSNOMEDCTAnatomicalStructureForAdministrationSiteCodes
http://hl7.org/fhir/ValueSet/approach-site-codes
From the FHIR Standard
MedicationRequest.dosageInstruction.routeexampleSNOMEDCTRouteCodes
http://hl7.org/fhir/ValueSet/route-codes
From the FHIR Standard
MedicationRequest.dosageInstruction.methodexampleSNOMEDCTAdministrationMethodCodes
http://hl7.org/fhir/ValueSet/administration-method-codes
From the FHIR Standard
MedicationRequest.dosageInstruction.doseAndRate.typeexampleDoseAndRateType
http://hl7.org/fhir/ValueSet/dose-rate-type
From the FHIR Standard
MedicationRequest.substitution.allowed[x]exampleActSubstanceAdminSubstitutionCode
http://terminology.hl7.org/ValueSet/v3-ActSubstanceAdminSubstitutionCode
MedicationRequest.substitution.reasonexampleSubstanceAdminSubstitutionReason
http://terminology.hl7.org/ValueSet/v3-SubstanceAdminSubstitutionReason

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMedicationRequestIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationRequestIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorMedicationRequestIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorMedicationRequestIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationRequestA resource should have narrative for robust management
: text.`div`.exists()
dom-r4bwarningMedicationRequest.containedContaining new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems
: ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from MedicationRequest

Summary

Mandatory: 3 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 1 is sliced based on the value of MedicationRequest.medication[x]
  • The element 1 is sliced based on the value of MedicationRequest.medication[x].coding (Closed)
  • The element 1 is sliced based on the value of MedicationRequest.dosageInstruction.doseAndRate.dose[x]

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationRequest 0..* MedicationRequest Ordering of medication for patient or group
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!Σ 1..1 code active | 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..1 boolean True if request is prohibiting action
... Slices for medication[x] Σ 1..1 CodeableConcept Medication 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..1 CodeableConcept Medication to be taken
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered.
..... Slices for coding Σ 1..* Coding Code defined by a terminology system
Slice: Unordered, Closed by value:system
...... coding:codingFromSystem1 Σ 0..* Coding Code defined by a terminology system
....... system Σ 1..1 uri Identity of the terminology system
Required Pattern: https://fhir.developer.gene.com/CodeSystem/uapi-product-name
....... code Σ 0..1 code Symbol in syntax defined by the system
Binding: UAPI Value Set - Product Name (required)
...... coding:codingFromSystem2 Σ 0..* Coding Code defined by a terminology system
....... system Σ 1..1 uri Identity of the terminology system
Required Pattern: https://fhir.developer.gene.com/CodeSystem/uapi-regimen-product-name
....... code Σ 0..1 code Symbol in syntax defined by the system
Binding: UAPI Value Set - Regimen Product Name (required)
... subject Σ 1..1 Reference(UAPI Patient) Who or group medication request is for
.... reference ΣC 0..1 string Patient resource UUID
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
Required Pattern: Patient
... requester Σ 1..1 Reference(UAPI Practitioner) Who/What requested the Request
.... reference ΣC 0..1 string Practitioner resource UUID
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
Required Pattern: Practitioner
... insurance 0..* Reference(UAPI Coverage) Associated insurance coverage
.... reference ΣC 0..1 string Coverage resource UUID
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
Required Pattern: Coverage
... dosageInstruction 0..1 Dosage How the medication should be taken
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... doseAndRate Σ 1..* Element Amount of medication administered
..... Slices for dose[x] Σ 1..1 SimpleQuantity Amount of medication per dose
Slice: Unordered, Closed by type:$this
...... dose[x]:doseQuantity Σ 1..1 SimpleQuantity Amount of medication per dose
....... value Σ 1..1 decimal Numerical value (with implicit precision)
....... unit Σ 1..1 string Unit representation

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
MedicationRequest.statusrequiredPattern Value: active
http://hl7.org/fhir/ValueSet/medicationrequest-status|4.3.0
From the FHIR Standard
MedicationRequest.intentrequiredPattern Value: order
http://hl7.org/fhir/ValueSet/medicationrequest-intent|4.3.0
From the FHIR Standard
MedicationRequest.medication[x]exampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
From the FHIR Standard
MedicationRequest.medication[x]:medicationCodeableConceptexampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
From the FHIR Standard
MedicationRequest.medication[x]:medicationCodeableConcept.coding:codingFromSystem1.coderequiredUapiValueSetProductName(a valid code from UAPI Code System - Product Names)
https://fhir.developer.gene.com/ValueSet/uapi-prod-name
From this IG
MedicationRequest.medication[x]:medicationCodeableConcept.coding:codingFromSystem2.coderequiredUapiValueSetRegimenProductName(a valid code from UAPI Code System - Regimen Product Names)
https://fhir.developer.gene.com/ValueSet/uapi-regimen-prod-name
From this IG
MedicationRequest.subject.typeextensiblePattern Value: Patient
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
MedicationRequest.requester.typeextensiblePattern Value: Practitioner
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
MedicationRequest.insurance.typeextensiblePattern Value: Coverage
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMedicationRequestIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationRequestIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorMedicationRequestIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorMedicationRequestIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationRequestA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Differential View

This structure is derived from MedicationRequest

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationRequest MedicationRequest
... status 1..1 code active | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown
Required Pattern: active
... intent 1..1 code proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
Required Pattern: order
... Slices for medication[x] 1..1 CodeableConcept Medication to be taken
Slice: Unordered, Open by type:$this
.... medication[x]:medicationCodeableConcept S 1..1 CodeableConcept Medication to be taken
..... Slices for coding 1..* Coding Code defined by a terminology system
Slice: Unordered, Closed by value:system
...... coding:codingFromSystem1 0..* Coding Code defined by a terminology system
....... system 1..1 uri Identity of the terminology system
Required Pattern: https://fhir.developer.gene.com/CodeSystem/uapi-product-name
....... code 0..1 code Symbol in syntax defined by the system
Binding: UAPI Value Set - Product Name (required)
...... coding:codingFromSystem2 0..* Coding Code defined by a terminology system
....... system 1..1 uri Identity of the terminology system
Required Pattern: https://fhir.developer.gene.com/CodeSystem/uapi-regimen-product-name
....... code 0..1 code Symbol in syntax defined by the system
Binding: UAPI Value Set - Regimen Product Name (required)
.... reference 0..1 string Patient resource UUID
.... type 0..1 uri Type the reference refers to (e.g. "Patient")
Required Pattern: Patient
... requester 1..1 Reference(UAPI Practitioner) Who/What requested the Request
.... reference 0..1 string Practitioner resource UUID
.... type 0..1 uri Type the reference refers to (e.g. "Patient")
Required Pattern: Practitioner
... insurance 0..* Reference(UAPI Coverage) Associated insurance coverage
.... reference 0..1 string Coverage resource UUID
.... type 0..1 uri Type the reference refers to (e.g. "Patient")
Required Pattern: Coverage
... note
.... text 1..1 markdown Additional dosage instruction
... dosageInstruction 0..1 Dosage How the medication should be taken
.... doseAndRate 1..* Element Amount of medication administered
..... Slices for dose[x] 1..1 SimpleQuantity Amount of medication per dose
Slice: Unordered, Open by type:$this
...... dose[x]:doseQuantity 1..1 SimpleQuantity Amount of medication per dose
....... value 1..1 decimal Numerical value (with implicit precision)
....... unit 1..1 string Unit representation
... dispenseRequest
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:dispenserInstruction 0..* Annotation UAPI MedicationRequest Dispenser Instructions
URL: https://fhir.developer.gene.com/StructureDefinition/dispenser-instruction
..... extension: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)

PathConformanceValueSetURI
MedicationRequest.medication[x]:medicationCodeableConcept.coding:codingFromSystem1.coderequiredUapiValueSetProductName(a valid code from UAPI Code System - Product Names)
https://fhir.developer.gene.com/ValueSet/uapi-prod-name
From this IG
MedicationRequest.medication[x]:medicationCodeableConcept.coding:codingFromSystem2.coderequiredUapiValueSetRegimenProductName(a valid code from UAPI Code System - Regimen Product Names)
https://fhir.developer.gene.com/ValueSet/uapi-regimen-prod-name
From this IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationRequest 0..* MedicationRequest Ordering of medication for patient or group
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): IETF language tag
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
Constraints: dom-r4b
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier 0..* Identifier External ids for this request
... status ?!Σ 1..1 code active | 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..1 CodeableConcept Reason for current status
Binding: medicationRequest Status Reason Codes (example): Identifies the reasons for a given status.
... intent ?!Σ 1..1 code proposal | 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..* CodeableConcept Type 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..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
... doNotPerform ?!Σ 0..1 boolean True if request is prohibiting action
... reported[x] Σ 0..1 Reported rather than primary record
.... reportedBoolean boolean
.... reportedReference Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization)
... Slices for medication[x] Σ 1..1 CodeableConcept Medication 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..1 CodeableConcept Medication to be taken
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered.
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... Slices for coding Σ 1..* Coding Code defined by a terminology system
Slice: Unordered, Closed by value:system
...... coding:codingFromSystem1 Σ 0..* Coding Code defined by a terminology system
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ 1..1 uri Identity of the terminology system
Required Pattern: https://fhir.developer.gene.com/CodeSystem/uapi-product-name
....... version Σ 0..1 string Version of the system - if relevant
....... code Σ 0..1 code Symbol in syntax defined by the system
Binding: UAPI Value Set - Product Name (required)
....... display Σ 0..1 string Representation defined by the system
....... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
...... coding:codingFromSystem2 Σ 0..* Coding Code defined by a terminology system
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ 1..1 uri Identity of the terminology system
Required Pattern: https://fhir.developer.gene.com/CodeSystem/uapi-regimen-product-name
....... version Σ 0..1 string Version of the system - if relevant
....... code Σ 0..1 code Symbol in syntax defined by the system
Binding: UAPI Value Set - Regimen Product Name (required)
....... display Σ 0..1 string Representation defined by the system
....... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Plain text representation of the concept
... subject Σ 1..1 Reference(UAPI Patient) Who or group medication request is for
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string Patient resource UUID
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
Required Pattern: Patient
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... encounter 0..1 Reference(Encounter) Encounter created as part of encounter/admission/stay
... supportingInformation 0..* Reference(Resource) Information to support ordering of the medication
... authoredOn Σ 0..1 dateTime When request was initially authored
... requester Σ 1..1 Reference(UAPI Practitioner) Who/What requested the Request
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string Practitioner resource UUID
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
Required Pattern: Practitioner
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... performer 0..1 Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson | CareTeam) Intended performer of administration
... performerType Σ 0..1 CodeableConcept Desired kind of performer of the medication administration
Binding: ProcedurePerformerRoleCodes (example): Identifies the type of individual that is desired to administer the medication.
... recorder 0..1 Reference(Practitioner | PractitionerRole) Person who entered the request
... reasonCode 0..* CodeableConcept Reason 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..* uri Instantiates external protocol or definition
... basedOn Σ 0..* Reference(CarePlan | MedicationRequest | ServiceRequest | ImmunizationRecommendation) What request fulfills
... groupIdentifier Σ 0..1 Identifier Composite request this is part of
... courseOfTherapyType 0..1 CodeableConcept Overall 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..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string Coverage resource UUID
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
Required Pattern: Coverage
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... note 0..* Annotation Information about the prescription
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... author[x] Σ 0..1 Individual responsible for the annotation
..... authorReference Reference(Practitioner | Patient | RelatedPerson | Organization)
..... authorString string
.... time Σ 0..1 dateTime When the annotation was made
.... text Σ 1..1 markdown Additional dosage instruction
... dosageInstruction 0..1 Dosage How the medication should be taken
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... sequence Σ 0..1 integer The order of the dosage instructions
.... text Σ 0..1 string Free text dosage instructions e.g. SIG
.... additionalInstruction Σ 0..* CodeableConcept Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness"
Binding: SNOMEDCTAdditionalDosageInstructions (example)
.... patientInstruction Σ 0..1 string Patient or consumer oriented instructions
.... timing Σ 0..1 Timing When medication should be administered
.... asNeeded[x] Σ 0..1 Take "as needed" (for x)
Binding: SNOMEDCTMedicationAsNeededReasonCodes (example)
..... asNeededBoolean boolean
..... asNeededCodeableConcept CodeableConcept
.... site Σ 0..1 CodeableConcept Body site to administer to
Binding: SNOMEDCTAnatomicalStructureForAdministrationSiteCodes (example)
.... route Σ 0..1 CodeableConcept How drug should enter body
Binding: SNOMEDCTRouteCodes (example)
.... method Σ 0..1 CodeableConcept Technique for administering medication
Binding: SNOMEDCTAdministrationMethodCodes (example)
.... doseAndRate Σ 1..* Element Amount of medication administered
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... type Σ 0..1 CodeableConcept The kind of dose or rate specified
Binding: DoseAndRateType (example)
..... Slices for dose[x] Σ 1..1 SimpleQuantity Amount of medication per dose
Slice: Unordered, Closed by type:$this
...... dose[x]:doseQuantity Σ 1..1 SimpleQuantity Amount of medication per dose
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... value Σ 1..1 decimal Numerical value (with implicit precision)
....... unit Σ 1..1 string Unit representation
....... system ΣC 0..1 uri System that defines coded unit form
....... code Σ 0..1 code Coded form of the unit
..... rate[x] Σ 0..1 Amount of medication per unit of time
...... rateRatio Ratio
...... rateRange Range
...... rateQuantity Quantity(SimpleQuantity)
.... maxDosePerPeriod Σ 0..1 Ratio Upper limit on medication per unit of time
.... maxDosePerAdministration Σ 0..1 SimpleQuantity Upper limit on medication per administration
.... maxDosePerLifetime Σ 0..1 SimpleQuantity Upper limit on medication per lifetime of the patient
... dispenseRequest 0..1 BackboneElement Medication supply authorization
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:dispenserInstruction 0..* Annotation UAPI MedicationRequest Dispenser Instructions
URL: https://fhir.developer.gene.com/StructureDefinition/dispenser-instruction
..... extension:dispenseQuantityDetail 0..* (Complex) UAPI MedicationRequest Dispense Quantity Detailed Breakdown
URL: https://fhir.developer.gene.com/StructureDefinition/dispense-quantity-detail
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... initialFill 0..1 BackboneElement First fill details
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... quantity 0..1 SimpleQuantity First fill quantity
..... duration 0..1 Duration First fill duration
.... dispenseInterval 0..1 Duration Minimum period of time between dispenses
.... validityPeriod 0..1 Period Time period supply is authorized for
.... numberOfRepeatsAllowed 0..1 unsignedInt Number of refills authorized
.... quantity 0..1 SimpleQuantity Amount of medication to supply per dispense
.... expectedSupplyDuration 0..1 Duration Number of days supply per dispense
.... performer 0..1 Reference(Organization) Intended dispenser
... substitution 0..1 BackboneElement Any restrictions on medication substitution
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... allowed[x] 1..1 Whether substitution is allowed or not
Binding: ActSubstanceAdminSubstitutionCode (example): Identifies the type of substitution allowed.
..... allowedBoolean boolean
..... allowedCodeableConcept CodeableConcept
.... reason 0..1 CodeableConcept Why should (not) substitution be made
Binding: SubstanceAdminSubstitutionReason (example): SubstanceAdminSubstitutionReason
... priorPrescription 0..1 Reference(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 / CodeURI
MedicationRequest.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
MedicationRequest.statusrequiredPattern Value: active
http://hl7.org/fhir/ValueSet/medicationrequest-status|4.3.0
From the FHIR Standard
MedicationRequest.statusReasonexamplemedicationRequest Status Reason Codes
http://hl7.org/fhir/ValueSet/medicationrequest-status-reason
From the FHIR Standard
MedicationRequest.intentrequiredPattern Value: order
http://hl7.org/fhir/ValueSet/medicationrequest-intent|4.3.0
From the FHIR Standard
MedicationRequest.categoryexamplemedicationRequest Category Codes
http://hl7.org/fhir/ValueSet/medicationrequest-category
From the FHIR Standard
MedicationRequest.priorityrequiredRequestPriority
http://hl7.org/fhir/ValueSet/request-priority|4.3.0
From the FHIR Standard
MedicationRequest.medication[x]exampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
From the FHIR Standard
MedicationRequest.medication[x]:medicationCodeableConceptexampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
From the FHIR Standard
MedicationRequest.medication[x]:medicationCodeableConcept.coding:codingFromSystem1.coderequiredUapiValueSetProductName(a valid code from UAPI Code System - Product Names)
https://fhir.developer.gene.com/ValueSet/uapi-prod-name
From this IG
MedicationRequest.medication[x]:medicationCodeableConcept.coding:codingFromSystem2.coderequiredUapiValueSetRegimenProductName(a valid code from UAPI Code System - Regimen Product Names)
https://fhir.developer.gene.com/ValueSet/uapi-regimen-prod-name
From this IG
MedicationRequest.subject.typeextensiblePattern Value: Patient
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
MedicationRequest.requester.typeextensiblePattern Value: Practitioner
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
MedicationRequest.performerTypeexampleProcedurePerformerRoleCodes
http://hl7.org/fhir/ValueSet/performer-role
From the FHIR Standard
MedicationRequest.reasonCodeexampleCondition/Problem/DiagnosisCodes
http://hl7.org/fhir/ValueSet/condition-code
From the FHIR Standard
MedicationRequest.courseOfTherapyTypeexamplemedicationRequest Course of Therapy Codes
http://hl7.org/fhir/ValueSet/medicationrequest-course-of-therapy
From the FHIR Standard
MedicationRequest.insurance.typeextensiblePattern Value: Coverage
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
MedicationRequest.dosageInstruction.additionalInstructionexampleSNOMEDCTAdditionalDosageInstructions
http://hl7.org/fhir/ValueSet/additional-instruction-codes
From the FHIR Standard
MedicationRequest.dosageInstruction.asNeeded[x]exampleSNOMEDCTMedicationAsNeededReasonCodes
http://hl7.org/fhir/ValueSet/medication-as-needed-reason
From the FHIR Standard
MedicationRequest.dosageInstruction.siteexampleSNOMEDCTAnatomicalStructureForAdministrationSiteCodes
http://hl7.org/fhir/ValueSet/approach-site-codes
From the FHIR Standard
MedicationRequest.dosageInstruction.routeexampleSNOMEDCTRouteCodes
http://hl7.org/fhir/ValueSet/route-codes
From the FHIR Standard
MedicationRequest.dosageInstruction.methodexampleSNOMEDCTAdministrationMethodCodes
http://hl7.org/fhir/ValueSet/administration-method-codes
From the FHIR Standard
MedicationRequest.dosageInstruction.doseAndRate.typeexampleDoseAndRateType
http://hl7.org/fhir/ValueSet/dose-rate-type
From the FHIR Standard
MedicationRequest.substitution.allowed[x]exampleActSubstanceAdminSubstitutionCode
http://terminology.hl7.org/ValueSet/v3-ActSubstanceAdminSubstitutionCode
MedicationRequest.substitution.reasonexampleSubstanceAdminSubstitutionReason
http://terminology.hl7.org/ValueSet/v3-SubstanceAdminSubstitutionReason

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMedicationRequestIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationRequestIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorMedicationRequestIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorMedicationRequestIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationRequestA resource should have narrative for robust management
: text.`div`.exists()
dom-r4bwarningMedicationRequest.containedContaining new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems
: ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from MedicationRequest

Summary

Mandatory: 3 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 1 is sliced based on the value of MedicationRequest.medication[x]
  • The element 1 is sliced based on the value of MedicationRequest.medication[x].coding (Closed)
  • The element 1 is sliced based on the value of MedicationRequest.dosageInstruction.doseAndRate.dose[x]

 

Other representations of profile: CSV, Excel, Schematron