XpanDH Project Medication (e)Prescription and (e)Dispensation
0.1.0 - ci-build
150
XpanDH Project Medication (e)Prescription and (e)Dispensation
0.1.0 - ci-build
150
XpanDH Project Medication (e)Prescription and (e)Dispensation, published by XpanDH Project. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-eu/xpandh-mpd/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.eu/fhir/ig/xpandh-mpd/StructureDefinition/MedicationRequest-eu-xpandh | Version: 0.1.0 | |||
| Draft as of 2024-12-12 | Computable Name: MedicationRequestXpandh | |||
This profile defines how to represent MedicationRequest in FHIR for the purpose of the XpanDH project.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from MedicationRequest
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  MedicationRequest |
MedicationRequest | |||
  identifier |
0..* | Identifier | Prescription/prescribed item ID | |
| status |
1..1 | code | Current state of the order | |
| 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 | Reference(Medication) | Medication to be taken Slice: Unordered, Open by type:$this | |
   medication[x]:medicationReference |
1..1 | Reference(Medication: XpanDH) | Medication to be taken | |
 subject |
1..1 | Reference(Patient: XpanDH) | Who or group medication request is for | |
| authoredOn |
1..1 | dateTime | When request was initially authored | |
| requester |
1..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Who/What requested the Request | |
| reasonCode |
0..* | CodeableConcept | Reason or indication for this prescription | |
| reasonReference |
0..* | Reference(Condition | Observation) | Condition or observation that supports this prescription | |
| groupIdentifier |
0..1 | Identifier | Prescription this is part of | |
| dosageInstruction |
0..* | Dosage | How the medication should be taken. | |
| text |
0..1 | string | Free text dosage instructions | |
| timing |
0..1 | Timing | Administration schedule | |
| repeat |
||||
| duration |
0..1 | decimal | Duration of the treatment | |
| frequency |
0..1 | positiveInt | Frequency times per period | |
| period |
0..1 | decimal | Duration of time over which repetitions are to occur | |
 periodUnit |
0..1 | code | Unit of the period (e.g. day) | |
| code |
0..1 | CodeableConcept | A code for the timing schedule. | |
| route |
0..1 | CodeableConcept | Route of administration | |
 doseAndRate |
||||
 Slices for dose[x] |
0..1 | Range, SimpleQuantity | Amount of medication per dose Slice: Unordered, Open by type:$this | |
| dose[x]:doseQuantity |
0..1 | SimpleQuantity | A fixed quantity (no comparator) | |
| dispenseRequest |
1..1 | BackboneElement | Medication supply authorization | |
| quantity |
1..1 | SimpleQuantity | Amount of medication to supply per dispense | |
| substitution |
||||
| Slices for allowed[x] |
1..1 | CodeableConcept | Whether substitution is allowed or not Slice: Unordered, Open by type:$this | |
| allowed[x]:allowedCodeableConcept |
1..1 | CodeableConcept | Whether substitution is allowed or not | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MedicationRequest |
0..* | MedicationRequest | Ordering of medication for patient or group dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
 implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
 identifier |
0..* | Identifier | Prescription/prescribed item ID ele-1: All FHIR elements must have a @value or children | |
| status |
?!Σ | 1..1 | code | Current state of the order Binding: medicationrequest Status (required): A coded concept specifying the state of the prescribing event. Describes the lifecycle of the prescription. ele-1: All FHIR elements must have a @value or children |
| 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. ele-1: All FHIR elements must have a @value or children Required Pattern: order |
| doNotPerform |
?!Σ | 0..1 | boolean | True if request is prohibiting action ele-1: All FHIR elements must have a @value or children |
| Slices for medication[x] |
Σ | 1..1 | Reference(Medication) | Medication to be taken Slice: Unordered, Closed by type:$this Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered. ele-1: All FHIR elements must have a @value or children |
| medication[x]:medicationReference |
Σ | 1..1 | Reference(Medication: XpanDH) | Medication to be taken ele-1: All FHIR elements must have a @value or children |
| subject |
Σ | 1..1 | Reference(Patient: XpanDH) | Who or group medication request is for ele-1: All FHIR elements must have a @value or children |
| authoredOn |
Σ | 1..1 | dateTime | When request was initially authored ele-1: All FHIR elements must have a @value or children |
| requester |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Who/What requested the Request ele-1: All FHIR elements must have a @value or children |
| reasonCode |
0..* | CodeableConcept | Reason or indication for this prescription Binding: Condition/Problem/DiagnosisCodes (example): A coded concept indicating why the medication was ordered. ele-1: All FHIR elements must have a @value or children | |
| reasonReference |
0..* | Reference(Condition | Observation) | Condition or observation that supports this prescription ele-1: All FHIR elements must have a @value or children | |
| groupIdentifier |
Σ | 0..1 | Identifier | Prescription this is part of ele-1: All FHIR elements must have a @value or children |
| dosageInstruction |
0..* | Dosage | How the medication should be taken. ele-1: All FHIR elements must have a @value or children | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| text |
Σ | 0..1 | string | Free text dosage instructions ele-1: All FHIR elements must have a @value or children |
| timing |
Σ | 0..1 | Timing | Administration schedule ele-1: All FHIR elements must have a @value or children |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| code |
Σ | 0..1 | CodeableConcept | A code for the timing schedule. Binding: TimingAbbreviation (preferred): Code for a known / defined timing pattern. ele-1: All FHIR elements must have a @value or children |
| route |
Σ | 0..1 | CodeableConcept | Route of administration Binding: SNOMEDCTRouteCodes (example): A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject. ele-1: All FHIR elements must have a @value or children |
| dispenseRequest |
1..1 | BackboneElement | Medication supply authorization ele-1: All FHIR elements must have a @value or children | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| quantity |
1..1 | SimpleQuantity | Amount of medication to supply per dispense ele-1: All FHIR elements must have a @value or children | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| MedicationRequest.status | required | medicationrequest Statushttp://hl7.org/fhir/ValueSet/medicationrequest-status|4.0.1from the FHIR Standard | |
| MedicationRequest.intent | required | Pattern: orderhttp://hl7.org/fhir/ValueSet/medicationrequest-intent|4.0.1from the FHIR Standard | |
| MedicationRequest.medication[x] | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codesfrom the FHIR Standard | |
| MedicationRequest.reasonCode | example | Condition/Problem/DiagnosisCodeshttp://hl7.org/fhir/ValueSet/condition-codefrom the FHIR Standard | |
| MedicationRequest.dosageInstruction.timing.code | preferred | TimingAbbreviationhttp://hl7.org/fhir/ValueSet/timing-abbreviationfrom the FHIR Standard | |
| MedicationRequest.dosageInstruction.route | example | SNOMEDCTRouteCodeshttp://hl7.org/fhir/ValueSet/route-codesfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | MedicationRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | MedicationRequest | If 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 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(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | MedicationRequest | If 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-5 | error | MedicationRequest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | MedicationRequest | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| 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): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
 extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
0..* | Identifier | Prescription/prescribed item ID | |||||
| status |
?!Σ | 1..1 | code | Current state of the order Binding: medicationrequest Status (required): A coded concept specifying the state of the prescribing event. Describes the lifecycle of the prescription. | ||||
| 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 | Reference(Medication) | 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]:medicationReference |
Σ | 1..1 | Reference(Medication: XpanDH) | Medication to be taken | ||||
| subject |
Σ | 1..1 | Reference(Patient: XpanDH) | Who or group medication request is for | ||||
| 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 |
Σ | 1..1 | dateTime | When request was initially authored | ||||
| requester |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Who/What requested the Request | ||||
| 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 this prescription Binding: Condition/Problem/DiagnosisCodes (example): A coded concept indicating why the medication was ordered. | |||||
| reasonReference |
0..* | Reference(Condition | Observation) | Condition or observation that supports this prescription | |||||
| 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 | Prescription 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(Coverage | ClaimResponse) | Associated insurance coverage | |||||
| note |
0..* | Annotation | Information about the prescription | |||||
| dosageInstruction |
0..* | Dosage | How the medication should be taken. | |||||
| id |
0..1 | string | 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 | ||||
| additionalInstruction |
Σ | 0..* | CodeableConcept | Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness" Binding: SNOMEDCTAdditionalDosageInstructions (example): A coded concept identifying additional instructions such as "take with water" or "avoid operating heavy machinery". | ||||
| patientInstruction |
Σ | 0..1 | string | Patient or consumer oriented instructions | ||||
| timing |
Σ | 0..1 | Timing | Administration schedule | ||||
| id |
0..1 | string | 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 | ||||
| event |
Σ | 0..* | dateTime | When the event occurs | ||||
| repeat |
ΣC | 0..1 | Element | When the event is to occur tim-1: if there's a duration, there needs to be duration units tim-2: if there's a period, there needs to be period units tim-4: duration SHALL be a non-negative value tim-5: period SHALL be a non-negative value tim-6: If there's a periodMax, there must be a period tim-7: If there's a durationMax, there must be a duration tim-8: If there's a countMax, there must be a count tim-9: If there's an offset, there must be a when (and not C, CM, CD, CV) tim-10: If there's a timeOfDay, there cannot be a when, or vice versa | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| bounds[x] |
Σ | 0..1 | Length/Range of lengths, or (Start and/or end) limits | |||||
| boundsDuration |
Duration | |||||||
| boundsRange |
Range | |||||||
| boundsPeriod |
Period | |||||||
| count |
Σ | 0..1 | positiveInt | Number of times to repeat | ||||
| countMax |
Σ | 0..1 | positiveInt | Maximum number of times to repeat | ||||
| duration |
Σ | 0..1 | decimal | Duration of the treatment | ||||
| durationMax |
Σ | 0..1 | decimal | How long when it happens (Max) | ||||
| durationUnit |
Σ | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required): A unit of time (units from UCUM). | ||||
| frequency |
Σ | 0..1 | positiveInt | Frequency times per period | ||||
| frequencyMax |
Σ | 0..1 | positiveInt | Event occurs up to frequencyMax times per period | ||||
| period |
Σ | 0..1 | decimal | Duration of time over which repetitions are to occur | ||||
| periodMax |
Σ | 0..1 | decimal | Upper limit of period (3-4 hours) | ||||
| periodUnit |
Σ | 0..1 | code | Unit of the period (e.g. day) Binding: UnitsOfTime (required): A unit of time (units from UCUM). | ||||
| dayOfWeek |
Σ | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required) | ||||
| timeOfDay |
Σ | 0..* | time | Time of day for action | ||||
| when |
Σ | 0..* | code | Code for time period of occurrence Binding: EventTiming (required): Real world event relating to the schedule. | ||||
| offset |
Σ | 0..1 | unsignedInt | Minutes from event (before or after) | ||||
| code |
Σ | 0..1 | CodeableConcept | A code for the timing schedule. Binding: TimingAbbreviation (preferred): Code for a known / defined timing pattern. | ||||
| asNeeded[x] |
Σ | 0..1 | Take "as needed" (for x) Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the precondition that should be met or evaluated prior to consuming or administering a medication dose. For example "pain", "30 minutes prior to sexual intercourse", "on flare-up" etc. | |||||
| asNeededBoolean |
boolean | |||||||
| asNeededCodeableConcept |
CodeableConcept | |||||||
| site |
Σ | 0..1 | CodeableConcept | Body site to administer to Binding: SNOMEDCTAnatomicalStructureForAdministrationSiteCodes (example): A coded concept describing the site location the medicine enters into or onto the body. | ||||
| route |
Σ | 0..1 | CodeableConcept | Route of administration Binding: SNOMEDCTRouteCodes (example): A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject. | ||||
| method |
Σ | 0..1 | CodeableConcept | Technique for administering medication Binding: SNOMEDCTAdministrationMethodCodes (example): A coded concept describing the technique by which the medicine is administered. | ||||
| doseAndRate |
Σ | 0..* | 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): The kind of dose or rate specified. | ||||
| Slices for dose[x] |
Σ | 0..1 | Amount of medication per dose Slice: Unordered, Open by type:$this | |||||
 doseRange |
Range | |||||||
| doseQuantity |
Quantity(SimpleQuantity) | |||||||
| dose[x]:doseQuantity |
C | 0..1 | SimpleQuantity | A fixed quantity (no comparator) qty-3: If a code for the unit is present, the system SHALL also be present sqty-1: The comparator is not used on a SimpleQuantity | ||||
| 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 |
1..1 | BackboneElement | Medication supply authorization | |||||
| 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 | ||||
| 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 |
1..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 | ||||
| Slices for allowed[x] |
1..1 | CodeableConcept | Whether substitution is allowed or not Slice: Unordered, Closed by type:$this Binding: ActSubstanceAdminSubstitutionCode (example): Identifies the type of substitution allowed. | |||||
| allowed[x]:allowedCodeableConcept |
1..1 | CodeableConcept | Whether substitution is allowed or not Binding: ActSubstanceAdminSubstitutionCode (example): Identifies the type of substitution allowed. | |||||
| reason |
0..1 | CodeableConcept | Why should (not) substitution be made Binding: SubstanceAdminSubstitutionReason (example): A coded concept describing the reason that a different medication should (or should not) be substituted from what was prescribed. | |||||
| 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 | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| MedicationRequest.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| MedicationRequest.status | required | medicationrequest Statushttp://hl7.org/fhir/ValueSet/medicationrequest-status|4.0.1from the FHIR Standard | ||||
| MedicationRequest.statusReason | example | medicationRequest Status Reason Codeshttp://hl7.org/fhir/ValueSet/medicationrequest-status-reasonfrom the FHIR Standard | ||||
| MedicationRequest.intent | required | Pattern: orderhttp://hl7.org/fhir/ValueSet/medicationrequest-intent|4.0.1from the FHIR Standard | ||||
| MedicationRequest.category | example | medicationRequest Category Codeshttp://hl7.org/fhir/ValueSet/medicationrequest-categoryfrom the FHIR Standard | ||||
| MedicationRequest.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1from the FHIR Standard | ||||
| MedicationRequest.medication[x] | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codesfrom the FHIR Standard | ||||
| MedicationRequest.performerType | example | ProcedurePerformerRoleCodeshttp://hl7.org/fhir/ValueSet/performer-rolefrom the FHIR Standard | ||||
| MedicationRequest.reasonCode | example | Condition/Problem/DiagnosisCodeshttp://hl7.org/fhir/ValueSet/condition-codefrom the FHIR Standard | ||||
| MedicationRequest.courseOfTherapyType | example | medicationRequest Course of Therapy Codeshttp://hl7.org/fhir/ValueSet/medicationrequest-course-of-therapyfrom the FHIR Standard | ||||
| MedicationRequest.dosageInstruction.additionalInstruction | example | SNOMEDCTAdditionalDosageInstructionshttp://hl7.org/fhir/ValueSet/additional-instruction-codesfrom the FHIR Standard | ||||
| MedicationRequest.dosageInstruction.timing.repeat.durationUnit | required | UnitsOfTimehttp://hl7.org/fhir/ValueSet/units-of-time|4.0.1from the FHIR Standard | ||||
| MedicationRequest.dosageInstruction.timing.repeat.periodUnit | required | UnitsOfTimehttp://hl7.org/fhir/ValueSet/units-of-time|4.0.1from the FHIR Standard | ||||
| MedicationRequest.dosageInstruction.timing.repeat.dayOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.1from the FHIR Standard | ||||
| MedicationRequest.dosageInstruction.timing.repeat.when | required | EventTiminghttp://hl7.org/fhir/ValueSet/event-timing|4.0.1from the FHIR Standard | ||||
| MedicationRequest.dosageInstruction.timing.code | preferred | TimingAbbreviationhttp://hl7.org/fhir/ValueSet/timing-abbreviationfrom the FHIR Standard | ||||
| MedicationRequest.dosageInstruction.asNeeded[x] | example | SNOMEDCTMedicationAsNeededReasonCodeshttp://hl7.org/fhir/ValueSet/medication-as-needed-reasonfrom the FHIR Standard | ||||
| MedicationRequest.dosageInstruction.site | example | SNOMEDCTAnatomicalStructureForAdministrationSiteCodeshttp://hl7.org/fhir/ValueSet/approach-site-codesfrom the FHIR Standard | ||||
| MedicationRequest.dosageInstruction.route | example | SNOMEDCTRouteCodeshttp://hl7.org/fhir/ValueSet/route-codesfrom the FHIR Standard | ||||
| MedicationRequest.dosageInstruction.method | example | SNOMEDCTAdministrationMethodCodeshttp://hl7.org/fhir/ValueSet/administration-method-codesfrom the FHIR Standard | ||||
| MedicationRequest.dosageInstruction.doseAndRate.type | example | DoseAndRateTypehttp://hl7.org/fhir/ValueSet/dose-rate-typefrom the FHIR Standard | ||||
| MedicationRequest.substitution.allowed[x] | example | ActSubstanceAdminSubstitutionCodehttp://terminology.hl7.org/ValueSet/v3-ActSubstanceAdminSubstitutionCode | ||||
| MedicationRequest.substitution.allowed[x]:allowedCodeableConcept | example | ActSubstanceAdminSubstitutionCodehttp://terminology.hl7.org/ValueSet/v3-ActSubstanceAdminSubstitutionCode | ||||
| MedicationRequest.substitution.reason | example | SubstanceAdminSubstitutionReasonhttp://terminology.hl7.org/ValueSet/v3-SubstanceAdminSubstitutionReason |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | MedicationRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | MedicationRequest | If 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 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(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | MedicationRequest | If 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-5 | error | MedicationRequest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | MedicationRequest | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| qty-3 | error | MedicationRequest.dosageInstruction.doseAndRate.dose[x]:doseQuantity | If a code for the unit is present, the system SHALL also be present : code.empty() or system.exists() | |
| sqty-1 | error | MedicationRequest.dosageInstruction.doseAndRate.dose[x]:doseQuantity | The comparator is not used on a SimpleQuantity : comparator.empty() | |
| tim-1 | error | MedicationRequest.dosageInstruction.timing.repeat | if there's a duration, there needs to be duration units : duration.empty() or durationUnit.exists() | |
| tim-2 | error | MedicationRequest.dosageInstruction.timing.repeat | if there's a period, there needs to be period units : period.empty() or periodUnit.exists() | |
| tim-4 | error | MedicationRequest.dosageInstruction.timing.repeat | duration SHALL be a non-negative value : duration.exists() implies duration >= 0 | |
| tim-5 | error | MedicationRequest.dosageInstruction.timing.repeat | period SHALL be a non-negative value : period.exists() implies period >= 0 | |
| tim-6 | error | MedicationRequest.dosageInstruction.timing.repeat | If there's a periodMax, there must be a period : periodMax.empty() or period.exists() | |
| tim-7 | error | MedicationRequest.dosageInstruction.timing.repeat | If there's a durationMax, there must be a duration : durationMax.empty() or duration.exists() | |
| tim-8 | error | MedicationRequest.dosageInstruction.timing.repeat | If there's a countMax, there must be a count : countMax.empty() or count.exists() | |
| tim-9 | error | MedicationRequest.dosageInstruction.timing.repeat | If there's an offset, there must be a when (and not C, CM, CD, CV) : offset.empty() or (when.exists() and ((when in ('C' | 'CM' | 'CD' | 'CV')).not())) | |
| tim-10 | error | MedicationRequest.dosageInstruction.timing.repeat | If there's a timeOfDay, there cannot be a when, or vice versa : timeOfDay.empty() or when.empty() |
This structure is derived from MedicationRequest
Summary
Mandatory: 5 elements(1 nested mandatory element)
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from MedicationRequest
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MedicationRequest |
MedicationRequest | |||
| identifier |
0..* | Identifier | Prescription/prescribed item ID | |
| status |
1..1 | code | Current state of the order | |
| 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 | Reference(Medication) | Medication to be taken Slice: Unordered, Open by type:$this | |
| medication[x]:medicationReference |
1..1 | Reference(Medication: XpanDH) | Medication to be taken | |
| subject |
1..1 | Reference(Patient: XpanDH) | Who or group medication request is for | |
| authoredOn |
1..1 | dateTime | When request was initially authored | |
| requester |
1..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Who/What requested the Request | |
| reasonCode |
0..* | CodeableConcept | Reason or indication for this prescription | |
| reasonReference |
0..* | Reference(Condition | Observation) | Condition or observation that supports this prescription | |
| groupIdentifier |
0..1 | Identifier | Prescription this is part of | |
| dosageInstruction |
0..* | Dosage | How the medication should be taken. | |
| text |
0..1 | string | Free text dosage instructions | |
| timing |
0..1 | Timing | Administration schedule | |
| repeat |
||||
| duration |
0..1 | decimal | Duration of the treatment | |
| frequency |
0..1 | positiveInt | Frequency times per period | |
| period |
0..1 | decimal | Duration of time over which repetitions are to occur | |
| periodUnit |
0..1 | code | Unit of the period (e.g. day) | |
| code |
0..1 | CodeableConcept | A code for the timing schedule. | |
| route |
0..1 | CodeableConcept | Route of administration | |
| doseAndRate |
||||
| Slices for dose[x] |
0..1 | Range, SimpleQuantity | Amount of medication per dose Slice: Unordered, Open by type:$this | |
| dose[x]:doseQuantity |
0..1 | SimpleQuantity | A fixed quantity (no comparator) | |
| dispenseRequest |
1..1 | BackboneElement | Medication supply authorization | |
| quantity |
1..1 | SimpleQuantity | Amount of medication to supply per dispense | |
| substitution |
||||
| Slices for allowed[x] |
1..1 | CodeableConcept | Whether substitution is allowed or not Slice: Unordered, Open by type:$this | |
| allowed[x]:allowedCodeableConcept |
1..1 | CodeableConcept | Whether substitution is allowed or not | |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MedicationRequest |
0..* | MedicationRequest | Ordering of medication for patient or group dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| identifier |
0..* | Identifier | Prescription/prescribed item ID ele-1: All FHIR elements must have a @value or children | |
| status |
?!Σ | 1..1 | code | Current state of the order Binding: medicationrequest Status (required): A coded concept specifying the state of the prescribing event. Describes the lifecycle of the prescription. ele-1: All FHIR elements must have a @value or children |
| 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. ele-1: All FHIR elements must have a @value or children Required Pattern: order |
| doNotPerform |
?!Σ | 0..1 | boolean | True if request is prohibiting action ele-1: All FHIR elements must have a @value or children |
| Slices for medication[x] |
Σ | 1..1 | Reference(Medication) | Medication to be taken Slice: Unordered, Closed by type:$this Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered. ele-1: All FHIR elements must have a @value or children |
| medication[x]:medicationReference |
Σ | 1..1 | Reference(Medication: XpanDH) | Medication to be taken ele-1: All FHIR elements must have a @value or children |
| subject |
Σ | 1..1 | Reference(Patient: XpanDH) | Who or group medication request is for ele-1: All FHIR elements must have a @value or children |
| authoredOn |
Σ | 1..1 | dateTime | When request was initially authored ele-1: All FHIR elements must have a @value or children |
| requester |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Who/What requested the Request ele-1: All FHIR elements must have a @value or children |
| reasonCode |
0..* | CodeableConcept | Reason or indication for this prescription Binding: Condition/Problem/DiagnosisCodes (example): A coded concept indicating why the medication was ordered. ele-1: All FHIR elements must have a @value or children | |
| reasonReference |
0..* | Reference(Condition | Observation) | Condition or observation that supports this prescription ele-1: All FHIR elements must have a @value or children | |
| groupIdentifier |
Σ | 0..1 | Identifier | Prescription this is part of ele-1: All FHIR elements must have a @value or children |
| dosageInstruction |
0..* | Dosage | How the medication should be taken. ele-1: All FHIR elements must have a @value or children | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| text |
Σ | 0..1 | string | Free text dosage instructions ele-1: All FHIR elements must have a @value or children |
| timing |
Σ | 0..1 | Timing | Administration schedule ele-1: All FHIR elements must have a @value or children |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| code |
Σ | 0..1 | CodeableConcept | A code for the timing schedule. Binding: TimingAbbreviation (preferred): Code for a known / defined timing pattern. ele-1: All FHIR elements must have a @value or children |
| route |
Σ | 0..1 | CodeableConcept | Route of administration Binding: SNOMEDCTRouteCodes (example): A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject. ele-1: All FHIR elements must have a @value or children |
| dispenseRequest |
1..1 | BackboneElement | Medication supply authorization ele-1: All FHIR elements must have a @value or children | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| quantity |
1..1 | SimpleQuantity | Amount of medication to supply per dispense ele-1: All FHIR elements must have a @value or children | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| MedicationRequest.status | required | medicationrequest Statushttp://hl7.org/fhir/ValueSet/medicationrequest-status|4.0.1from the FHIR Standard | |
| MedicationRequest.intent | required | Pattern: orderhttp://hl7.org/fhir/ValueSet/medicationrequest-intent|4.0.1from the FHIR Standard | |
| MedicationRequest.medication[x] | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codesfrom the FHIR Standard | |
| MedicationRequest.reasonCode | example | Condition/Problem/DiagnosisCodeshttp://hl7.org/fhir/ValueSet/condition-codefrom the FHIR Standard | |
| MedicationRequest.dosageInstruction.timing.code | preferred | TimingAbbreviationhttp://hl7.org/fhir/ValueSet/timing-abbreviationfrom the FHIR Standard | |
| MedicationRequest.dosageInstruction.route | example | SNOMEDCTRouteCodeshttp://hl7.org/fhir/ValueSet/route-codesfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | MedicationRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | MedicationRequest | If 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 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(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | MedicationRequest | If 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-5 | error | MedicationRequest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | MedicationRequest | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| 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): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
0..* | Identifier | Prescription/prescribed item ID | |||||
| status |
?!Σ | 1..1 | code | Current state of the order Binding: medicationrequest Status (required): A coded concept specifying the state of the prescribing event. Describes the lifecycle of the prescription. | ||||
| 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 | Reference(Medication) | 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]:medicationReference |
Σ | 1..1 | Reference(Medication: XpanDH) | Medication to be taken | ||||
| subject |
Σ | 1..1 | Reference(Patient: XpanDH) | Who or group medication request is for | ||||
| 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 |
Σ | 1..1 | dateTime | When request was initially authored | ||||
| requester |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Who/What requested the Request | ||||
| 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 this prescription Binding: Condition/Problem/DiagnosisCodes (example): A coded concept indicating why the medication was ordered. | |||||
| reasonReference |
0..* | Reference(Condition | Observation) | Condition or observation that supports this prescription | |||||
| 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 | Prescription 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(Coverage | ClaimResponse) | Associated insurance coverage | |||||
| note |
0..* | Annotation | Information about the prescription | |||||
| dosageInstruction |
0..* | Dosage | How the medication should be taken. | |||||
| id |
0..1 | string | 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 | ||||
| additionalInstruction |
Σ | 0..* | CodeableConcept | Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness" Binding: SNOMEDCTAdditionalDosageInstructions (example): A coded concept identifying additional instructions such as "take with water" or "avoid operating heavy machinery". | ||||
| patientInstruction |
Σ | 0..1 | string | Patient or consumer oriented instructions | ||||
| timing |
Σ | 0..1 | Timing | Administration schedule | ||||
| id |
0..1 | string | 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 | ||||
| event |
Σ | 0..* | dateTime | When the event occurs | ||||
| repeat |
ΣC | 0..1 | Element | When the event is to occur tim-1: if there's a duration, there needs to be duration units tim-2: if there's a period, there needs to be period units tim-4: duration SHALL be a non-negative value tim-5: period SHALL be a non-negative value tim-6: If there's a periodMax, there must be a period tim-7: If there's a durationMax, there must be a duration tim-8: If there's a countMax, there must be a count tim-9: If there's an offset, there must be a when (and not C, CM, CD, CV) tim-10: If there's a timeOfDay, there cannot be a when, or vice versa | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| bounds[x] |
Σ | 0..1 | Length/Range of lengths, or (Start and/or end) limits | |||||
| boundsDuration |
Duration | |||||||
| boundsRange |
Range | |||||||
| boundsPeriod |
Period | |||||||
| count |
Σ | 0..1 | positiveInt | Number of times to repeat | ||||
| countMax |
Σ | 0..1 | positiveInt | Maximum number of times to repeat | ||||
| duration |
Σ | 0..1 | decimal | Duration of the treatment | ||||
| durationMax |
Σ | 0..1 | decimal | How long when it happens (Max) | ||||
| durationUnit |
Σ | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required): A unit of time (units from UCUM). | ||||
| frequency |
Σ | 0..1 | positiveInt | Frequency times per period | ||||
| frequencyMax |
Σ | 0..1 | positiveInt | Event occurs up to frequencyMax times per period | ||||
| period |
Σ | 0..1 | decimal | Duration of time over which repetitions are to occur | ||||
| periodMax |
Σ | 0..1 | decimal | Upper limit of period (3-4 hours) | ||||
| periodUnit |
Σ | 0..1 | code | Unit of the period (e.g. day) Binding: UnitsOfTime (required): A unit of time (units from UCUM). | ||||
| dayOfWeek |
Σ | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required) | ||||
| timeOfDay |
Σ | 0..* | time | Time of day for action | ||||
| when |
Σ | 0..* | code | Code for time period of occurrence Binding: EventTiming (required): Real world event relating to the schedule. | ||||
| offset |
Σ | 0..1 | unsignedInt | Minutes from event (before or after) | ||||
| code |
Σ | 0..1 | CodeableConcept | A code for the timing schedule. Binding: TimingAbbreviation (preferred): Code for a known / defined timing pattern. | ||||
| asNeeded[x] |
Σ | 0..1 | Take "as needed" (for x) Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the precondition that should be met or evaluated prior to consuming or administering a medication dose. For example "pain", "30 minutes prior to sexual intercourse", "on flare-up" etc. | |||||
| asNeededBoolean |
boolean | |||||||
| asNeededCodeableConcept |
CodeableConcept | |||||||
| site |
Σ | 0..1 | CodeableConcept | Body site to administer to Binding: SNOMEDCTAnatomicalStructureForAdministrationSiteCodes (example): A coded concept describing the site location the medicine enters into or onto the body. | ||||
| route |
Σ | 0..1 | CodeableConcept | Route of administration Binding: SNOMEDCTRouteCodes (example): A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject. | ||||
| method |
Σ | 0..1 | CodeableConcept | Technique for administering medication Binding: SNOMEDCTAdministrationMethodCodes (example): A coded concept describing the technique by which the medicine is administered. | ||||
| doseAndRate |
Σ | 0..* | 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): The kind of dose or rate specified. | ||||
| Slices for dose[x] |
Σ | 0..1 | Amount of medication per dose Slice: Unordered, Open by type:$this | |||||
| doseRange |
Range | |||||||
| doseQuantity |
Quantity(SimpleQuantity) | |||||||
| dose[x]:doseQuantity |
C | 0..1 | SimpleQuantity | A fixed quantity (no comparator) qty-3: If a code for the unit is present, the system SHALL also be present sqty-1: The comparator is not used on a SimpleQuantity | ||||
| 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 |
1..1 | BackboneElement | Medication supply authorization | |||||
| 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 | ||||
| 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 |
1..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 | ||||
| Slices for allowed[x] |
1..1 | CodeableConcept | Whether substitution is allowed or not Slice: Unordered, Closed by type:$this Binding: ActSubstanceAdminSubstitutionCode (example): Identifies the type of substitution allowed. | |||||
| allowed[x]:allowedCodeableConcept |
1..1 | CodeableConcept | Whether substitution is allowed or not Binding: ActSubstanceAdminSubstitutionCode (example): Identifies the type of substitution allowed. | |||||
| reason |
0..1 | CodeableConcept | Why should (not) substitution be made Binding: SubstanceAdminSubstitutionReason (example): A coded concept describing the reason that a different medication should (or should not) be substituted from what was prescribed. | |||||
| 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 | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| MedicationRequest.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| MedicationRequest.status | required | medicationrequest Statushttp://hl7.org/fhir/ValueSet/medicationrequest-status|4.0.1from the FHIR Standard | ||||
| MedicationRequest.statusReason | example | medicationRequest Status Reason Codeshttp://hl7.org/fhir/ValueSet/medicationrequest-status-reasonfrom the FHIR Standard | ||||
| MedicationRequest.intent | required | Pattern: orderhttp://hl7.org/fhir/ValueSet/medicationrequest-intent|4.0.1from the FHIR Standard | ||||
| MedicationRequest.category | example | medicationRequest Category Codeshttp://hl7.org/fhir/ValueSet/medicationrequest-categoryfrom the FHIR Standard | ||||
| MedicationRequest.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1from the FHIR Standard | ||||
| MedicationRequest.medication[x] | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codesfrom the FHIR Standard | ||||
| MedicationRequest.performerType | example | ProcedurePerformerRoleCodeshttp://hl7.org/fhir/ValueSet/performer-rolefrom the FHIR Standard | ||||
| MedicationRequest.reasonCode | example | Condition/Problem/DiagnosisCodeshttp://hl7.org/fhir/ValueSet/condition-codefrom the FHIR Standard | ||||
| MedicationRequest.courseOfTherapyType | example | medicationRequest Course of Therapy Codeshttp://hl7.org/fhir/ValueSet/medicationrequest-course-of-therapyfrom the FHIR Standard | ||||
| MedicationRequest.dosageInstruction.additionalInstruction | example | SNOMEDCTAdditionalDosageInstructionshttp://hl7.org/fhir/ValueSet/additional-instruction-codesfrom the FHIR Standard | ||||
| MedicationRequest.dosageInstruction.timing.repeat.durationUnit | required | UnitsOfTimehttp://hl7.org/fhir/ValueSet/units-of-time|4.0.1from the FHIR Standard | ||||
| MedicationRequest.dosageInstruction.timing.repeat.periodUnit | required | UnitsOfTimehttp://hl7.org/fhir/ValueSet/units-of-time|4.0.1from the FHIR Standard | ||||
| MedicationRequest.dosageInstruction.timing.repeat.dayOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.1from the FHIR Standard | ||||
| MedicationRequest.dosageInstruction.timing.repeat.when | required | EventTiminghttp://hl7.org/fhir/ValueSet/event-timing|4.0.1from the FHIR Standard | ||||
| MedicationRequest.dosageInstruction.timing.code | preferred | TimingAbbreviationhttp://hl7.org/fhir/ValueSet/timing-abbreviationfrom the FHIR Standard | ||||
| MedicationRequest.dosageInstruction.asNeeded[x] | example | SNOMEDCTMedicationAsNeededReasonCodeshttp://hl7.org/fhir/ValueSet/medication-as-needed-reasonfrom the FHIR Standard | ||||
| MedicationRequest.dosageInstruction.site | example | SNOMEDCTAnatomicalStructureForAdministrationSiteCodeshttp://hl7.org/fhir/ValueSet/approach-site-codesfrom the FHIR Standard | ||||
| MedicationRequest.dosageInstruction.route | example | SNOMEDCTRouteCodeshttp://hl7.org/fhir/ValueSet/route-codesfrom the FHIR Standard | ||||
| MedicationRequest.dosageInstruction.method | example | SNOMEDCTAdministrationMethodCodeshttp://hl7.org/fhir/ValueSet/administration-method-codesfrom the FHIR Standard | ||||
| MedicationRequest.dosageInstruction.doseAndRate.type | example | DoseAndRateTypehttp://hl7.org/fhir/ValueSet/dose-rate-typefrom the FHIR Standard | ||||
| MedicationRequest.substitution.allowed[x] | example | ActSubstanceAdminSubstitutionCodehttp://terminology.hl7.org/ValueSet/v3-ActSubstanceAdminSubstitutionCode | ||||
| MedicationRequest.substitution.allowed[x]:allowedCodeableConcept | example | ActSubstanceAdminSubstitutionCodehttp://terminology.hl7.org/ValueSet/v3-ActSubstanceAdminSubstitutionCode | ||||
| MedicationRequest.substitution.reason | example | SubstanceAdminSubstitutionReasonhttp://terminology.hl7.org/ValueSet/v3-SubstanceAdminSubstitutionReason |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | MedicationRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | MedicationRequest | If 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 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(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | MedicationRequest | If 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-5 | error | MedicationRequest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | MedicationRequest | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| qty-3 | error | MedicationRequest.dosageInstruction.doseAndRate.dose[x]:doseQuantity | If a code for the unit is present, the system SHALL also be present : code.empty() or system.exists() | |
| sqty-1 | error | MedicationRequest.dosageInstruction.doseAndRate.dose[x]:doseQuantity | The comparator is not used on a SimpleQuantity : comparator.empty() | |
| tim-1 | error | MedicationRequest.dosageInstruction.timing.repeat | if there's a duration, there needs to be duration units : duration.empty() or durationUnit.exists() | |
| tim-2 | error | MedicationRequest.dosageInstruction.timing.repeat | if there's a period, there needs to be period units : period.empty() or periodUnit.exists() | |
| tim-4 | error | MedicationRequest.dosageInstruction.timing.repeat | duration SHALL be a non-negative value : duration.exists() implies duration >= 0 | |
| tim-5 | error | MedicationRequest.dosageInstruction.timing.repeat | period SHALL be a non-negative value : period.exists() implies period >= 0 | |
| tim-6 | error | MedicationRequest.dosageInstruction.timing.repeat | If there's a periodMax, there must be a period : periodMax.empty() or period.exists() | |
| tim-7 | error | MedicationRequest.dosageInstruction.timing.repeat | If there's a durationMax, there must be a duration : durationMax.empty() or duration.exists() | |
| tim-8 | error | MedicationRequest.dosageInstruction.timing.repeat | If there's a countMax, there must be a count : countMax.empty() or count.exists() | |
| tim-9 | error | MedicationRequest.dosageInstruction.timing.repeat | If there's an offset, there must be a when (and not C, CM, CD, CV) : offset.empty() or (when.exists() and ((when in ('C' | 'CM' | 'CD' | 'CV')).not())) | |
| tim-10 | error | MedicationRequest.dosageInstruction.timing.repeat | If there's a timeOfDay, there cannot be a when, or vice versa : timeOfDay.empty() or when.empty() |
This structure is derived from MedicationRequest
Summary
Mandatory: 5 elements(1 nested mandatory element)
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron
IG © 2023+ XpanDH Project. Package hl7.eu.fhir.xpandh.mpd#0.1.0 based on FHIR 4.0.1. Generated 2024-12-12
