Digital Child Health Service - Events Catalogue

CareConnect-DCH-MedicationOrder-1

This MedicationOrder Resource represents an order for both supply of the medication and the instructions for administration of the medication to a patient. Further constraints have been applied within the scope of a Child Health event.

NameCard.TypeDescription & Constraints
..MedicationOrderDomainResourcePrescription of medication to for patient

...id0..1IdLogical id of this artifact

...meta0..1MetaMetadata about the resource

...implicitRules0..1UriA set of rules under which this content was created

...language0..1CodeLanguage of the resource content
Binding A human language. (http://tools.ietf.org/html/bcp47)
Binding Strength Required

...text0..1NarrativeText summary of the resource, for human interpretation

...contained0..*ResourceContained, inline Resources

...reason0..*ExtensionReason or indication for writing the prescription
Extension https://fhir.nhs.uk/StructureDefinition/Extension-CareConnect-DCH-ReasonCondition-1

...supplyType1..1ExtensionMedication supply type
Extension https://fhir.hl7.org.uk/StructureDefinition/Extension-CareConnect-MedicationSupplyType-1

...statement0..1ExtensionMedication Statement link
Extension https://fhir.nhs.uk/StructureDefinition/Extension-CareConnect-DCH-MedicationOrderStatement-1

...flag0..*ExtensionFlags related to the patient's medications
Extension https://fhir.nhs.uk/StructureDefinition/Extension-CareConnect-DCH-MedicationFlag-1

...identifier1..1IdentifierExternal identifier

....id0..1Idxml:id (or equivalent in JSON)

....use0..1Codeusual | official | temp | secondary (If known)
Binding Identifies the purpose for this identifier, if known . (http://hl7.org/fhir/ValueSet/identifier-use)
Binding Strength Required

....type0..1CodeableConceptDescription of identifier
Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. (http://hl7.org/fhir/ValueSet/identifier-type)
Binding Strength Extensible

.....id0..1Idxml:id (or equivalent in JSON)

.....coding0..*CodingCode defined by a terminology system

......id0..1Idxml:id (or equivalent in JSON)

......system0..1UriIdentity of the terminology system

......version0..1StringVersion of the system - if relevant

......code0..1CodeSymbol in syntax defined by the system

......display0..1StringRepresentation defined by the system

......userSelected0..1BooleanIf this coding was chosen directly by the user

.....text0..1StringPlain text representation of the concept

....system1..1UriThe namespace for the identifier
Example Value http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri

....value1..1StringThe value that is unique
Example Value 123456

....period0..1PeriodTime period when id is/was valid for use

.....id0..1Idxml:id (or equivalent in JSON)

.....start0..1DateTimeStarting time with inclusive boundary

.....end0..1DateTimeEnd time with inclusive boundary, if not ongoing

....assigner0..1Reference (CareConnect-DCH-Organization-1)Organization that issued id (may be just text)

.....id0..1Idxml:id (or equivalent in JSON)

.....reference0..1StringRelative, internal or absolute URL reference

.....display0..1StringText alternative for the resource

...dateWritten1..1DateTimeWhen prescription was authorized

...status1..1Codeactive | on-hold | completed | entered-in-error | stopped | draft
Binding A code specifying the state of the prescribing event. Describes the lifecycle of the prescription. (http://hl7.org/fhir/ValueSet/medication-order-status)
Binding Strength Required

...dateEnded0..1DateTimeWhen prescription was stopped

...reasonEnded0..1CodeableConceptWhy prescription was stopped
Binding Codes indicating why the medication was terminated; e.g. Adverse reaction, medication change, issue resolved, etc. (http://example.com/valueset)
Binding Strength Example

....id0..1Idxml:id (or equivalent in JSON)

....coding0..*Code defined by a terminology system
Slice: Ordering: Unordered, Discriminator: system, Rules: Open

....coding (SNOMED CT)0..1CodingCode defined by a terminology system

.....id0..1Idxml:id (or equivalent in JSON)

.....snomedCTDescriptionID0..1ExtensionThe SNOMED CT Description ID for the display
Extension https://fhir.hl7.org.uk/StructureDefinition/Extension-coding-sctdescid

.....system1..1UriIdentity of the terminology system
Fixed Value http://snomed.info/sct

.....code1..1CodeSymbol in syntax defined by the system

.....display1..1StringRepresentation defined by the system

.....userSelected0..1BooleanIf this coding was chosen directly by the user

....text0..1StringPlain text representation of the concept

...patient1..1Reference (CareConnect-DCH-Patient-1)Who prescription is for

....id0..1Idxml:id (or equivalent in JSON)

....reference1..1StringRelative, internal or absolute URL reference

....display0..1StringText alternative for the resource

...prescriber1..1Reference (CareConnect-DCH-Practitioner-1)Who ordered the medication(s)

....id0..1Idxml:id (or equivalent in JSON)

....reference1..1StringRelative, internal or absolute URL reference

....display0..1StringText alternative for the resource

...encounter1..1Reference (CareConnect-DCH-Encounter-1)Created during encounter/admission/stay

....id0..1Idxml:id (or equivalent in JSON)

....reference1..1StringRelative, internal or absolute URL reference

....display0..1StringText alternative for the resource

...note0..1StringInformation about the prescription

...medication[x]1..1CodeableConcept | CareConnect-DCH-Medication-1Medication to be taken
Binding A code from the SNOMED Clinical Terminology UK coding system that describes a manufactured material (e.g. a pharmaceutical product or personal medical device). (https://fhir.hl7.org.uk/ValueSet/CareConnect-ManufacturedMaterialSnCT-1)
Binding Strength Required

...dosageInstruction1..1BackboneElementHow medication should be taken

....id0..1Idxml:id (or equivalent in JSON)

....text1..1StringDosage instructions expressed as text

....additionalInstructions0..1CodeableConceptSupplemental instructions - e.g. "with meals"
Binding Codes identifying additional instructions such as "take with water" or "avoid operating heavy machinery". (http://example.com/valueset)
Binding Strength Example

.....id0..1Idxml:id (or equivalent in JSON)

.....coding0..*Code defined by a terminology system
Slice: Ordering: Unordered, Discriminator: system, Rules: Open

.....coding (SNOMED CT)0..1CodingCode defined by a terminology system

......id0..1Idxml:id (or equivalent in JSON)

......snomedCTDescriptionID0..1ExtensionThe SNOMED CT Description ID for the display
Extension https://fhir.hl7.org.uk/StructureDefinition/Extension-coding-sctdescid

......system1..1UriIdentity of the terminology system

......code1..1CodeSymbol in syntax defined by the system

......display1..1StringRepresentation defined by the system

......userSelected0..1BooleanIf this coding was chosen directly by the user

.....text0..1StringPlain text representation of the concept

....timing0..1TimingWhen medication should be administered

.....id0..1Idxml:id (or equivalent in JSON)

.....event0..1DateTimeWhen the event occurs

.....repeat0..1ElementWhen the event is to occur

......id0..1Idxml:id (or equivalent in JSON)

......boundsPeriod (Duration)0..1PeriodLength/Range of lengths, or (Start and/or end) limits

......count0..1IntegerNumber of times to repeat

......duration0..1DecimalHow long when it happens

......durationMax0..1DecimalHow long when it happens (Max)

......durationUnits0..1Codes | min | h | d | wk | mo | a - unit of time (UCUM)
Binding A unit of time (units from UCUM). (http://hl7.org/fhir/ValueSet/units-of-time)
Binding Strength Required

......frequency0..1IntegerEvent occurs frequency times per period
Default Value 1

......frequencyMax0..1IntegerEvent occurs up to frequencyMax times per period

......period0..1DecimalEvent occurs frequency times per period

......periodMax0..1DecimalUpper limit of period (3-4 hours)

......periodUnits0..1Codes | min | h | d | wk | mo | a - unit of time (UCUM)
Binding A unit of time (units from UCUM). (http://hl7.org/fhir/ValueSet/units-of-time)
Binding Strength Required

......when0..1CodeRegular life events the event is tied to
Binding Real world event that the relating to the schedule. (http://hl7.org/fhir/ValueSet/event-timing)
Binding Strength Required

.....code0..1CodeableConceptQD | QOD | Q4H | Q6H | BID | TID | QID | AM | PM +
Binding Code for a known / defined timing pattern. (http://hl7.org/fhir/ValueSet/timing-abbreviation)
Binding Strength Preferred

......id0..1Idxml:id (or equivalent in JSON)

......coding0..*CodingCode defined by a terminology system

.......id0..1Idxml:id (or equivalent in JSON)

.......system0..1UriIdentity of the terminology system

.......version0..1StringVersion of the system - if relevant

.......code0..1CodeSymbol in syntax defined by the system

.......display0..1StringRepresentation defined by the system

.......userSelected0..1BooleanIf this coding was chosen directly by the user

......text0..1StringPlain text representation of the concept

....asNeeded[x]0..1Boolean | CodeableConceptTake "as needed" (for x)
Binding 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. (http://example.com/valueset)
Binding Strength Example

....site[x]0..1CodeableConcept | BodySiteBody site to administer to
Binding A coded concept describing the site location the medicine enters into or onto the body. (http://hl7.org/fhir/ValueSet/approach-site-codes)
Binding Strength Example

....route0..1CodeableConceptHow drug should enter body
Binding A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject. (http://hl7.org/fhir/ValueSet/route-codes)
Binding Strength Example

.....id0..1Idxml:id (or equivalent in JSON)

.....coding0..*Code defined by a terminology system
Slice: Ordering: Unordered, Discriminator: system, Rules: Open

.....coding (SNOMED CT)0..1CodingCode defined by a terminology system
Binding A code from the SNOMED Clinical Terminology UK coding system that describes the e-Prescribing route of administration. (https://fhir.hl7.org.uk/ValueSet/CareConnect-MedicationDosageRoute-1)
Binding Strength Preferred

......id0..1Idxml:id (or equivalent in JSON)

......snomedCTDescriptionID0..1ExtensionThe SNOMED CT Description ID for the display
Extension https://fhir.hl7.org.uk/StructureDefinition/Extension-coding-sctdescid

......system1..1UriIdentity of the terminology system
Fixed Value http://snomed.info/sct

......code1..1CodeSymbol in syntax defined by the system

......display1..1StringRepresentation defined by the system

......userSelected0..1BooleanIf this coding was chosen directly by the user

.....text0..1StringPlain text representation of the concept

....method0..1CodeableConceptTechnique for administering medication
Binding A coded concept describing the technique by which the medicine is administered. (http://example.com/valueset)
Binding Strength Example

.....id0..1Idxml:id (or equivalent in JSON)

.....coding0..*Code defined by a terminology system
Slice: Ordering: Unordered, Discriminator: system, Rules: Open

.....coding (SNOMED CT)0..1CodingCode defined by a terminology system
Binding A code from the SNOMED Clinical Terminology UK coding system that describes the e-Prescribing method. (https://fhir.hl7.org.uk/ValueSet/CareConnect-MedicationDosageMethod-1)
Binding Strength Preferred

......id0..1Idxml:id (or equivalent in JSON)

......snomedCTDescriptionID0..1ExtensionThe SNOMED CT Description ID for the display
Extension https://fhir.hl7.org.uk/StructureDefinition/Extension-coding-sctdescid

......system1..1UriIdentity of the terminology system
Fixed Value http://snomed.info/sct

......code1..1CodeSymbol in syntax defined by the system

......display1..1StringRepresentation defined by the system

......userSelected0..1BooleanIf this coding was chosen directly by the user

.....text0..1StringPlain text representation of the concept

....dose[x]0..1Range | SimpleQuantityAmount of medication per dose

....rate[x]0..1Ratio | RangeAmount of medication per unit of time

....maxDosePerPeriod0..1RatioUpper limit on medication per unit of time

.....id0..1Idxml:id (or equivalent in JSON)

.....numerator0..1QuantityNumerator value

......id0..1Idxml:id (or equivalent in JSON)

......value0..1DecimalNumerical value (with implicit precision)

......comparator0..1Code< | <= | >= | > - how to understand the value
Binding How the Quantity should be understood and represented. (http://hl7.org/fhir/ValueSet/quantity-comparator)
Binding Strength Required

......unit0..1StringUnit representation

......system0..1UriSystem that defines coded unit form

......code0..1CodeCoded form of the unit

.....denominator0..1QuantityDenominator value

......id0..1Idxml:id (or equivalent in JSON)

......value0..1DecimalNumerical value (with implicit precision)

......comparator0..1Code< | <= | >= | > - how to understand the value
Binding How the Quantity should be understood and represented. (http://hl7.org/fhir/ValueSet/quantity-comparator)
Binding Strength Required

......unit0..1StringUnit representation

......system0..1UriSystem that defines coded unit form

......code0..1CodeCoded form of the unit

...dispenseRequest1..1BackboneElementMedication supply authorization

....id0..1Idxml:id (or equivalent in JSON)

....validityPeriod0..1PeriodTime period supply is authorized for

.....id0..1Idxml:id (or equivalent in JSON)

.....start1..1DateTimeStarting time with inclusive boundary

.....end0..1DateTimeEnd time with inclusive boundary, if not ongoing

....numberOfRepeatsAllowed0..1PositiveIntNumber of refills authorized

....quantity (SimpleQuantity)0..1SimpleQuantityAmount of medication to supply per dispense

.....id0..1Idxml:id (or equivalent in JSON)

.....quantityText0..1ExtensionQuantity representation
Extension https://fhir.hl7.org.uk/StructureDefinition/Extension-CareConnect-MedicationQuantityText-1

.....value1..1DecimalNumerical value (with implicit precision)

.....unit1..1StringUnit representation

.....system1..1UriSystem that defines coded unit form

.....code1..1CodeCoded form of the unit

....expectedSupplyDuration (Duration)0..1DurationNumber of days supply per dispense

.....id0..1Idxml:id (or equivalent in JSON)

.....value1..1DecimalNumerical value (with implicit precision)

.....unit1..1StringUnit representation

.....system1..1UriSystem that defines coded unit form

.....code1..1CodeCoded form of the unit

...substitution0..1BackboneElementAny restrictions on medication substitution

....id0..1Idxml:id (or equivalent in JSON)

....type1..1CodeableConceptgeneric | formulary +
Binding A coded concept describing whether a different medicinal product may be dispensed other than the product as specified exactly in the prescription. (http://hl7.org/fhir/ValueSet/v3-ActSubstanceAdminSubstitutionCode)
Binding Strength Example

.....id0..1Idxml:id (or equivalent in JSON)

.....coding0..*CodingCode defined by a terminology system

......id0..1Idxml:id (or equivalent in JSON)

......system0..1UriIdentity of the terminology system

......version0..1StringVersion of the system - if relevant

......code0..1CodeSymbol in syntax defined by the system

......display0..1StringRepresentation defined by the system

......userSelected0..1BooleanIf this coding was chosen directly by the user

.....text0..1StringPlain text representation of the concept

....reason0..1CodeableConceptWhy should (not) substitution be made
Binding A coded concept describing the reason that a different medication should (or should not) be substituted from what was prescribed. (http://hl7.org/fhir/ValueSet/v3-SubstanceAdminSubstitutionReason)
Binding Strength Example

.....id0..1Idxml:id (or equivalent in JSON)

.....coding0..*CodingCode defined by a terminology system

......id0..1Idxml:id (or equivalent in JSON)

......system0..1UriIdentity of the terminology system

......version0..1StringVersion of the system - if relevant

......code0..1CodeSymbol in syntax defined by the system

......display0..1StringRepresentation defined by the system

......userSelected0..1BooleanIf this coding was chosen directly by the user

.....text0..1StringPlain text representation of the concept

...priorPrescription0..1Reference (CareConnect-DCH-MedicationOrder-1)An order/prescription that this supersedes

....id0..1Idxml:id (or equivalent in JSON)

....reference0..1StringRelative, internal or absolute URL reference

....display0..1StringText alternative for the resource

Name Type Description & Constraints
. . Extension-CareConnect-DCH-ReasonCondition-1 Extension The reason why a resource was added/performed/given. This may be due to a Condition, may be coded entity of some type, or may simply be present as text.
. . Extension-CareConnect-MedicationSupplyType-1 Extension Indicates the legal/contractual nature of a prescription.
. . Extension-CareConnect-DCH-MedicationOrderStatement-1 Extension Used to specify a link to the medication authorisation that this order is part of.
. . Extension-CareConnect-DCH-MedicationFlag-1 Extension This Extension is used to specify the flags related to the patient's medications.
. . Extension-coding-sctdescid Extension This Extension resource is constrained to support SNOMED CT Description ID for the display.
. . Extension-coding-sctdescid Extension This Extension resource is constrained to support SNOMED CT Description ID for the display.
. . Extension-coding-sctdescid Extension This Extension resource is constrained to support SNOMED CT Description ID for the display.
. . Extension-coding-sctdescid Extension This Extension resource is constrained to support SNOMED CT Description ID for the display.
. . Extension-CareConnect-MedicationQuantityText-1 Extension This Extension resource is constrained to support the textual representation of a medication structured quantity.
Path Name Binding Strength ValueSet
.MedicationOrder.language language Required http://tools.ietf.org/html/bcp47
.MedicationOrder.identifier.use use Required http://hl7.org/fhir/ValueSet/identifier-use
.MedicationOrder.identifier.type type Extensible http://hl7.org/fhir/ValueSet/identifier-type
.MedicationOrder.status status Required http://hl7.org/fhir/ValueSet/medication-order-status
.MedicationOrder.reasonEnded reasonEnded Example http://example.com/valueset
.MedicationOrder.medication[x] medication[x] Required https://fhir.hl7.org.uk/ValueSet/CareConnect-ManufacturedMaterialSnCT-1
.MedicationOrder.dosageInstruction.additionalInstructions additionalInstructions Example http://example.com/valueset
.MedicationOrder.dosageInstruction.timing.repeat.durationUnits durationUnits Required http://hl7.org/fhir/ValueSet/units-of-time
.MedicationOrder.dosageInstruction.timing.repeat.periodUnits periodUnits Required http://hl7.org/fhir/ValueSet/units-of-time
.MedicationOrder.dosageInstruction.timing.repeat.when when Required http://hl7.org/fhir/ValueSet/event-timing
.MedicationOrder.dosageInstruction.timing.code code Preferred http://hl7.org/fhir/ValueSet/timing-abbreviation
.MedicationOrder.dosageInstruction.asNeeded[x] asNeeded[x] Example http://example.com/valueset
.MedicationOrder.dosageInstruction.site[x] site[x] Example http://hl7.org/fhir/ValueSet/approach-site-codes
.MedicationOrder.dosageInstruction.route route Example http://hl7.org/fhir/ValueSet/route-codes
.MedicationOrder.dosageInstruction.route.coding SNOMED CT Preferred https://fhir.hl7.org.uk/ValueSet/CareConnect-MedicationDosageRoute-1
.MedicationOrder.dosageInstruction.method method Example http://example.com/valueset
.MedicationOrder.dosageInstruction.method.coding SNOMED CT Preferred https://fhir.hl7.org.uk/ValueSet/CareConnect-MedicationDosageMethod-1
.MedicationOrder.dosageInstruction.maxDosePerPeriod.numerator.comparator comparator Required http://hl7.org/fhir/ValueSet/quantity-comparator
.MedicationOrder.substitution.type type Example http://hl7.org/fhir/ValueSet/v3-ActSubstanceAdminSubstitutionCode
.MedicationOrder.substitution.reason reason Example http://hl7.org/fhir/ValueSet/v3-SubstanceAdminSubstitutionReason