WHO Antenatal Care Guideline Implementation Guide
0.3.0 - CI Build
WHO Antenatal Care Guideline Implementation Guide
0.3.0 - CI Build
WHO Antenatal Care Guideline Implementation Guide, published by World Health Organization (WHO). This guide is not an authorized publication; it is the continuous build for version 0.3.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/WorldHealthOrganization/smart-anc/ and changes regularly. See the Directory of published versions
| Official URL: http://smart.who.int/anc/StructureDefinition/iron-supplement | Version: 0.3.0 | |||
| Draft as of 2026-10-16 | Computable Name: IronSupplement | |||
Usage:Workflow Task: Nutrition supplementation |
||||
Iron Supplement
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:  |
|---|---|---|---|---|
  MedicationRequest |
0..* | ANCMedicationRequest | Ordering of medication for patient or group | |
  implicitRules |
0..1 | uri | A set of rules under which this content was created | |
  Slices for extension |
Content/Rules for all slices | |||
   extension:rationale |
0..1 | markdown | Explanation URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-rationale | |
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
 identifier |
1..* | Identifier | External ids for this request | |
| use |
1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |
| system |
1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | |
 value |
1..1 | string | The value that is unique Example General: 123456 | |
| 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. | |
| 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. | |
| category |
0..* | CodeableConcept | Type of medication usage Binding: medicationRequest Category Codes (preferred): Type of medication usage | |
| 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 Fixed Value: false (no extensions allowed) | |
 medication[x] |
1..1 | Medication to be taken Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered. | ||
| medicationCodeableConcept |
CodeableConcept | |||
 medicationReference |
Reference(Medication) | |||
| subject |
1..1 | Reference(ANC Base Patient) | Who or group medication request is for | |
| encounter |
0..1 | Reference(ANC Base Encounter) | Encounter created as part of encounter/admission/stay | |
| supportingInformation |
0..* | Reference(Resource) | Pertinent information | |
| authoredOn |
1..1 | dateTime | When request was initially authored | |
| requester |
0..1 | Reference(ANC Practitioner | ANC PractitionerRole | ANC Base Patient | ANC RelatedPerson) | Who/What requested the Request | |
| recorder |
0..1 | Reference(ANC Practitioner | ANC 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. | |
| instantiatesCanonical |
0..* | canonical() | Source | |
| dosageInstruction |
0..* | Dosage | How the medication should be taken | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| timing |
0..1 | Timing | When medication should be administered | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
 repeat |
C | 0..1 | Element | When the event is to occur Constraints: tim-1, tim-2, tim-4, tim-5, tim-6, tim-7, tim-8, tim-9, tim-10 |
 frequency |
0..1 | positiveInt | Event occurs frequency times per period | |
| frequencyMax |
0..1 | positiveInt | Event occurs up to frequencyMax times per period | |
| period |
0..1 | decimal | Event occurs frequency times per period | |
| periodMax |
0..1 | decimal | Upper limit of period (3-4 hours) | |
| periodUnit |
0..1 | code | Type of iron supplement dosage provided Binding: Type of iron supplement dosage provided Choices (required) | |
| 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 | How drug should enter body 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 | |
| dose[x] |
1..1 | Quantity | Amount of iron prescribed | |
| dispenseRequest |
0..1 | BackboneElement | Medication supply authorization | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| 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 |
C | 0..1 | SimpleQuantity | Amount of medication to supply per dispense Constraints: sqty-1 |
| expectedSupplyDuration |
0..1 | Duration | Number of days supply per dispense | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| MedicationRequest.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| MedicationRequest.status | Base | required | Medicationrequest status | 📍4.0.1 | FHIR Std. |
| MedicationRequest.intent | Base | required | Medication request intent | 📍4.0.1 | FHIR Std. |
| MedicationRequest.category | Base | preferred | Medication request category codes | 📦4.0.1 | FHIR Std. |
| MedicationRequest.priority | Base | required | Request priority | 📍4.0.1 | FHIR Std. |
| MedicationRequest.medication[x] | Base | example | SNOMED CT Medication Codes | 📦4.0.1 | FHIR Std. |
| MedicationRequest.reasonCode | Base | example | Condition/Problem/Diagnosis Codes | 📦4.0.1 | FHIR Std. |
| MedicationRequest.dosageInstruction.timing.repeat.periodUnit | Base | required | Type of iron supplement dosage provided Choices | 📦0.3.0 | This IG |
| MedicationRequest.dosageInstruction.asNeeded[x] | Base | example | SNOMED CT Medication As Needed Reason Codes | 📍4.0.1 | FHIR Std. |
| MedicationRequest.dosageInstruction.site | Base | example | SNOMED CT Anatomical Structure for Administration Site Codes | 📍4.0.1 | FHIR Std. |
| MedicationRequest.dosageInstruction.route | Base | example | SNOMED CT Route Codes | 📍4.0.1 | FHIR Std. |
| MedicationRequest.dosageInstruction.method | Base | example | SNOMED CT Administration Method Codes | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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()
|
| sqty-1 | error | MedicationRequest.dispenseRequest.quantity | 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 ANCMedicationRequest
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| MedicationRequest |
0..* | ANCMedicationRequest | Ordering of medication for patient or group | |
 dosageInstruction |
0..* | Dosage | How the medication should be taken | |
| timing |
0..1 | Timing | When medication should be administered | |
| repeat |
0..1 | Element | When the event is to occur | |
| periodUnit |
0..1 | code | Type of iron supplement dosage provided Binding: Type of iron supplement dosage provided Choices (required) | |
| doseAndRate |
0..* | Element | Amount of medication administered | |
| dose[x] |
1..1 | Quantity | Amount of iron prescribed | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| MedicationRequest.dosageInstruction.timing.repeat.periodUnit | Base | required | Type of iron supplement dosage provided Choices | 📦0.3.0 | This IG |
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| MedicationRequest |
0..* | ANCMedicationRequest | 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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
 Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:rationale |
0..1 | markdown | Explanation URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-rationale | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| identifier |
1..* | Identifier | External ids for this request | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |||||
| type |
0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | |||||
| system |
1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | |||||
| value |
1..1 | string | The value that is unique Example General: 123456 | |||||
| period |
0..1 | Period | Time period when id is/was valid for use | |||||
| assigner |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
| 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. | |||||
| 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. | |||||
| category |
0..* | CodeableConcept | Type of medication usage Binding: medicationRequest Category Codes (preferred): Type of medication usage | |||||
| 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 Fixed Value: false (no extensions allowed) | |||||
| reported[x] |
0..1 | Reported rather than primary record | ||||||
| reportedBoolean |
boolean | |||||||
| reportedReference |
Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization) | |||||||
| medication[x] |
1..1 | Medication to be taken Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered. | ||||||
| medicationCodeableConcept |
CodeableConcept | |||||||
| medicationReference |
Reference(Medication) | |||||||
| subject |
1..1 | Reference(ANC Base Patient) | Who or group medication request is for | |||||
| encounter |
0..1 | Reference(ANC Base Encounter) | Encounter created as part of encounter/admission/stay | |||||
| supportingInformation |
0..* | Reference(Resource) | Pertinent information | |||||
| authoredOn |
1..1 | dateTime | When request was initially authored | |||||
| requester |
0..1 | Reference(ANC Practitioner | ANC PractitionerRole | ANC Base Patient | ANC RelatedPerson) | 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(ANC Practitioner | ANC 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() | Source | |||||
| 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(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 e.g. SIG | |||||
| 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 | When medication should be 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 | |||||
| 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 Constraints: tim-1, tim-2, tim-4, tim-5, tim-6, tim-7, tim-8, tim-9, tim-10 | ||||
| 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 | How long when it happens | |||||
| 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 | Event occurs frequency times per period | |||||
| frequencyMax |
0..1 | positiveInt | Event occurs up to frequencyMax times per period | |||||
| period |
0..1 | decimal | Event occurs frequency times per period | |||||
| periodMax |
0..1 | decimal | Upper limit of period (3-4 hours) | |||||
| periodUnit |
0..1 | code | Type of iron supplement dosage provided Binding: Type of iron supplement dosage provided Choices (required) | |||||
| 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 | BID | TID | QID | AM | PM | QD | QOD | + 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 | How drug should enter body 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. | |||||
| dose[x] |
1..1 | Quantity | Amount of iron prescribed | |||||
| 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 |
C | 0..1 | SimpleQuantity(4.0.1) | Upper limit on medication per administration Constraints: sqty-1 | ||||
| maxDosePerLifetime |
C | 0..1 | SimpleQuantity(4.0.1) | Upper limit on medication per lifetime of the patient Constraints: sqty-1 | ||||
| dispenseRequest |
0..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 | |||||
| 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 |
C | 0..1 | SimpleQuantity | Amount of medication to supply per dispense Constraints: sqty-1 | ||||
| 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): 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 | Status | Usage | ValueSet | Version | Source |
| MedicationRequest.language | Base | preferred | Common Languages | 📦4.0.1 | FHIR Std. |
| MedicationRequest.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| MedicationRequest.identifier.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| MedicationRequest.status | Base | required | Medicationrequest status | 📍4.0.1 | FHIR Std. |
| MedicationRequest.statusReason | Base | example | Medication request status reason codes | 📦4.0.1 | FHIR Std. |
| MedicationRequest.intent | Base | required | Medication request intent | 📍4.0.1 | FHIR Std. |
| MedicationRequest.category | Base | preferred | Medication request category codes | 📦4.0.1 | FHIR Std. |
| MedicationRequest.priority | Base | required | Request priority | 📍4.0.1 | FHIR Std. |
| MedicationRequest.medication[x] | Base | example | SNOMED CT Medication Codes | 📦4.0.1 | FHIR Std. |
| MedicationRequest.performerType | Base | example | Procedure Performer Role Codes | 📦4.0.1 | FHIR Std. |
| MedicationRequest.reasonCode | Base | example | Condition/Problem/Diagnosis Codes | 📦4.0.1 | FHIR Std. |
| MedicationRequest.courseOfTherapyType | Base | example | Medication request course of therapy codes | 📦4.0.1 | FHIR Std. |
| MedicationRequest.dosageInstruction.additionalInstruction | Base | example | SNOMED CT Additional Dosage Instructions | 📍4.0.1 | FHIR Std. |
| MedicationRequest.dosageInstruction.timing.repeat.durationUnit | Base | required | UnitsOfTime | 📍4.0.1 | FHIR Std. |
| MedicationRequest.dosageInstruction.timing.repeat.periodUnit | Base | required | Type of iron supplement dosage provided Choices | 📦0.3.0 | This IG |
| MedicationRequest.dosageInstruction.timing.repeat.dayOfWeek | Base | required | DaysOfWeek | 📍4.0.1 | FHIR Std. |
| MedicationRequest.dosageInstruction.timing.repeat.when | Base | required | EventTiming | 📍4.0.1 | FHIR Std. |
| MedicationRequest.dosageInstruction.timing.code | Base | preferred | TimingAbbreviation | 📍4.0.1 | FHIR Std. |
| MedicationRequest.dosageInstruction.asNeeded[x] | Base | example | SNOMED CT Medication As Needed Reason Codes | 📍4.0.1 | FHIR Std. |
| MedicationRequest.dosageInstruction.site | Base | example | SNOMED CT Anatomical Structure for Administration Site Codes | 📍4.0.1 | FHIR Std. |
| MedicationRequest.dosageInstruction.route | Base | example | SNOMED CT Route Codes | 📍4.0.1 | FHIR Std. |
| MedicationRequest.dosageInstruction.method | Base | example | SNOMED CT Administration Method Codes | 📍4.0.1 | FHIR Std. |
| MedicationRequest.dosageInstruction.doseAndRate.type | Base | example | DoseAndRateType | 📍4.0.1 | FHIR Std. |
| MedicationRequest.substitution.allowed[x] | Base | example | ActSubstanceAdminSubstitutionCode | 📦3.0.0 | THO v7.4 |
| MedicationRequest.substitution.reason | Base | example | SubstanceAdminSubstitutionReason | 📦3.0.0 | THO v7.4 |
| Id | Grade | Path(s) | Description | Expression |
| 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()
|
| sqty-1 | error | MedicationRequest.dosageInstruction.maxDosePerAdministration, MedicationRequest.dosageInstruction.maxDosePerLifetime, MedicationRequest.dispenseRequest.initialFill.quantity, MedicationRequest.dispenseRequest.quantity | 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 ANCMedicationRequest
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| MedicationRequest |
0..* | ANCMedicationRequest | Ordering of medication for patient or group | |
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:rationale |
0..1 | markdown | Explanation URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-rationale | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
| identifier |
1..* | Identifier | External ids for this request | |
| use |
1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |
| system |
1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | |
| value |
1..1 | string | The value that is unique Example General: 123456 | |
| 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. | |
| 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. | |
| category |
0..* | CodeableConcept | Type of medication usage Binding: medicationRequest Category Codes (preferred): Type of medication usage | |
| 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 Fixed Value: false (no extensions allowed) | |
| medication[x] |
1..1 | Medication to be taken Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered. | ||
| medicationCodeableConcept |
CodeableConcept | |||
| medicationReference |
Reference(Medication) | |||
| subject |
1..1 | Reference(ANC Base Patient) | Who or group medication request is for | |
| encounter |
0..1 | Reference(ANC Base Encounter) | Encounter created as part of encounter/admission/stay | |
| supportingInformation |
0..* | Reference(Resource) | Pertinent information | |
| authoredOn |
1..1 | dateTime | When request was initially authored | |
| requester |
0..1 | Reference(ANC Practitioner | ANC PractitionerRole | ANC Base Patient | ANC RelatedPerson) | Who/What requested the Request | |
| recorder |
0..1 | Reference(ANC Practitioner | ANC 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. | |
| instantiatesCanonical |
0..* | canonical() | Source | |
| dosageInstruction |
0..* | Dosage | How the medication should be taken | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| timing |
0..1 | Timing | When medication should be administered | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| repeat |
C | 0..1 | Element | When the event is to occur Constraints: tim-1, tim-2, tim-4, tim-5, tim-6, tim-7, tim-8, tim-9, tim-10 |
| frequency |
0..1 | positiveInt | Event occurs frequency times per period | |
| frequencyMax |
0..1 | positiveInt | Event occurs up to frequencyMax times per period | |
| period |
0..1 | decimal | Event occurs frequency times per period | |
| periodMax |
0..1 | decimal | Upper limit of period (3-4 hours) | |
| periodUnit |
0..1 | code | Type of iron supplement dosage provided Binding: Type of iron supplement dosage provided Choices (required) | |
| 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 | How drug should enter body 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 | |
| dose[x] |
1..1 | Quantity | Amount of iron prescribed | |
| dispenseRequest |
0..1 | BackboneElement | Medication supply authorization | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| 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 |
C | 0..1 | SimpleQuantity | Amount of medication to supply per dispense Constraints: sqty-1 |
| expectedSupplyDuration |
0..1 | Duration | Number of days supply per dispense | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| MedicationRequest.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| MedicationRequest.status | Base | required | Medicationrequest status | 📍4.0.1 | FHIR Std. |
| MedicationRequest.intent | Base | required | Medication request intent | 📍4.0.1 | FHIR Std. |
| MedicationRequest.category | Base | preferred | Medication request category codes | 📦4.0.1 | FHIR Std. |
| MedicationRequest.priority | Base | required | Request priority | 📍4.0.1 | FHIR Std. |
| MedicationRequest.medication[x] | Base | example | SNOMED CT Medication Codes | 📦4.0.1 | FHIR Std. |
| MedicationRequest.reasonCode | Base | example | Condition/Problem/Diagnosis Codes | 📦4.0.1 | FHIR Std. |
| MedicationRequest.dosageInstruction.timing.repeat.periodUnit | Base | required | Type of iron supplement dosage provided Choices | 📦0.3.0 | This IG |
| MedicationRequest.dosageInstruction.asNeeded[x] | Base | example | SNOMED CT Medication As Needed Reason Codes | 📍4.0.1 | FHIR Std. |
| MedicationRequest.dosageInstruction.site | Base | example | SNOMED CT Anatomical Structure for Administration Site Codes | 📍4.0.1 | FHIR Std. |
| MedicationRequest.dosageInstruction.route | Base | example | SNOMED CT Route Codes | 📍4.0.1 | FHIR Std. |
| MedicationRequest.dosageInstruction.method | Base | example | SNOMED CT Administration Method Codes | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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()
|
| sqty-1 | error | MedicationRequest.dispenseRequest.quantity | 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()
|
Differential View
This structure is derived from ANCMedicationRequest
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| MedicationRequest |
0..* | ANCMedicationRequest | Ordering of medication for patient or group | |
| dosageInstruction |
0..* | Dosage | How the medication should be taken | |
| timing |
0..1 | Timing | When medication should be administered | |
| repeat |
0..1 | Element | When the event is to occur | |
| periodUnit |
0..1 | code | Type of iron supplement dosage provided Binding: Type of iron supplement dosage provided Choices (required) | |
| doseAndRate |
0..* | Element | Amount of medication administered | |
| dose[x] |
1..1 | Quantity | Amount of iron prescribed | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| MedicationRequest.dosageInstruction.timing.repeat.periodUnit | Base | required | Type of iron supplement dosage provided Choices | 📦0.3.0 | This IG |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| MedicationRequest |
0..* | ANCMedicationRequest | 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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:rationale |
0..1 | markdown | Explanation URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-rationale | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| identifier |
1..* | Identifier | External ids for this request | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |||||
| type |
0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | |||||
| system |
1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | |||||
| value |
1..1 | string | The value that is unique Example General: 123456 | |||||
| period |
0..1 | Period | Time period when id is/was valid for use | |||||
| assigner |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
| 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. | |||||
| 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. | |||||
| category |
0..* | CodeableConcept | Type of medication usage Binding: medicationRequest Category Codes (preferred): Type of medication usage | |||||
| 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 Fixed Value: false (no extensions allowed) | |||||
| reported[x] |
0..1 | Reported rather than primary record | ||||||
| reportedBoolean |
boolean | |||||||
| reportedReference |
Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization) | |||||||
| medication[x] |
1..1 | Medication to be taken Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered. | ||||||
| medicationCodeableConcept |
CodeableConcept | |||||||
| medicationReference |
Reference(Medication) | |||||||
| subject |
1..1 | Reference(ANC Base Patient) | Who or group medication request is for | |||||
| encounter |
0..1 | Reference(ANC Base Encounter) | Encounter created as part of encounter/admission/stay | |||||
| supportingInformation |
0..* | Reference(Resource) | Pertinent information | |||||
| authoredOn |
1..1 | dateTime | When request was initially authored | |||||
| requester |
0..1 | Reference(ANC Practitioner | ANC PractitionerRole | ANC Base Patient | ANC RelatedPerson) | 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(ANC Practitioner | ANC 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() | Source | |||||
| 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(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 e.g. SIG | |||||
| 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 | When medication should be 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 | |||||
| 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 Constraints: tim-1, tim-2, tim-4, tim-5, tim-6, tim-7, tim-8, tim-9, tim-10 | ||||
| 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 | How long when it happens | |||||
| 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 | Event occurs frequency times per period | |||||
| frequencyMax |
0..1 | positiveInt | Event occurs up to frequencyMax times per period | |||||
| period |
0..1 | decimal | Event occurs frequency times per period | |||||
| periodMax |
0..1 | decimal | Upper limit of period (3-4 hours) | |||||
| periodUnit |
0..1 | code | Type of iron supplement dosage provided Binding: Type of iron supplement dosage provided Choices (required) | |||||
| 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 | BID | TID | QID | AM | PM | QD | QOD | + 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 | How drug should enter body 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. | |||||
| dose[x] |
1..1 | Quantity | Amount of iron prescribed | |||||
| 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 |
C | 0..1 | SimpleQuantity(4.0.1) | Upper limit on medication per administration Constraints: sqty-1 | ||||
| maxDosePerLifetime |
C | 0..1 | SimpleQuantity(4.0.1) | Upper limit on medication per lifetime of the patient Constraints: sqty-1 | ||||
| dispenseRequest |
0..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 | |||||
| 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 |
C | 0..1 | SimpleQuantity | Amount of medication to supply per dispense Constraints: sqty-1 | ||||
| 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): 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 | Status | Usage | ValueSet | Version | Source |
| MedicationRequest.language | Base | preferred | Common Languages | 📦4.0.1 | FHIR Std. |
| MedicationRequest.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| MedicationRequest.identifier.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| MedicationRequest.status | Base | required | Medicationrequest status | 📍4.0.1 | FHIR Std. |
| MedicationRequest.statusReason | Base | example | Medication request status reason codes | 📦4.0.1 | FHIR Std. |
| MedicationRequest.intent | Base | required | Medication request intent | 📍4.0.1 | FHIR Std. |
| MedicationRequest.category | Base | preferred | Medication request category codes | 📦4.0.1 | FHIR Std. |
| MedicationRequest.priority | Base | required | Request priority | 📍4.0.1 | FHIR Std. |
| MedicationRequest.medication[x] | Base | example | SNOMED CT Medication Codes | 📦4.0.1 | FHIR Std. |
| MedicationRequest.performerType | Base | example | Procedure Performer Role Codes | 📦4.0.1 | FHIR Std. |
| MedicationRequest.reasonCode | Base | example | Condition/Problem/Diagnosis Codes | 📦4.0.1 | FHIR Std. |
| MedicationRequest.courseOfTherapyType | Base | example | Medication request course of therapy codes | 📦4.0.1 | FHIR Std. |
| MedicationRequest.dosageInstruction.additionalInstruction | Base | example | SNOMED CT Additional Dosage Instructions | 📍4.0.1 | FHIR Std. |
| MedicationRequest.dosageInstruction.timing.repeat.durationUnit | Base | required | UnitsOfTime | 📍4.0.1 | FHIR Std. |
| MedicationRequest.dosageInstruction.timing.repeat.periodUnit | Base | required | Type of iron supplement dosage provided Choices | 📦0.3.0 | This IG |
| MedicationRequest.dosageInstruction.timing.repeat.dayOfWeek | Base | required | DaysOfWeek | 📍4.0.1 | FHIR Std. |
| MedicationRequest.dosageInstruction.timing.repeat.when | Base | required | EventTiming | 📍4.0.1 | FHIR Std. |
| MedicationRequest.dosageInstruction.timing.code | Base | preferred | TimingAbbreviation | 📍4.0.1 | FHIR Std. |
| MedicationRequest.dosageInstruction.asNeeded[x] | Base | example | SNOMED CT Medication As Needed Reason Codes | 📍4.0.1 | FHIR Std. |
| MedicationRequest.dosageInstruction.site | Base | example | SNOMED CT Anatomical Structure for Administration Site Codes | 📍4.0.1 | FHIR Std. |
| MedicationRequest.dosageInstruction.route | Base | example | SNOMED CT Route Codes | 📍4.0.1 | FHIR Std. |
| MedicationRequest.dosageInstruction.method | Base | example | SNOMED CT Administration Method Codes | 📍4.0.1 | FHIR Std. |
| MedicationRequest.dosageInstruction.doseAndRate.type | Base | example | DoseAndRateType | 📍4.0.1 | FHIR Std. |
| MedicationRequest.substitution.allowed[x] | Base | example | ActSubstanceAdminSubstitutionCode | 📦3.0.0 | THO v7.4 |
| MedicationRequest.substitution.reason | Base | example | SubstanceAdminSubstitutionReason | 📦3.0.0 | THO v7.4 |
| Id | Grade | Path(s) | Description | Expression |
| 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()
|
| sqty-1 | error | MedicationRequest.dosageInstruction.maxDosePerAdministration, MedicationRequest.dosageInstruction.maxDosePerLifetime, MedicationRequest.dispenseRequest.initialFill.quantity, MedicationRequest.dispenseRequest.quantity | 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 ANCMedicationRequest
Other representations of profile: CSV, Excel, Schematron