PrescribeIT® Specification and Guide Version 5.0

 

The official URL for this profile is:

http://prescribeit.ca/fhir/StructureDefinition/profile-medicationorder-identifiers

Download Excel representation

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

>

This structure is derived from MedicationOrder

NameCard.TypeConstraints and Usage
.  MedicationOrder 0..*MedicationOrderDefinition:
An order for both supply of the medication and the instructions for administration of the medication to a patient. The resource is called "MedicationOrder" rather than "MedicationPrescription" to generalize the use across inpatient and outpatient settings as well as for care plans, etc.

..  id 1..1idDefinition:
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.


Comments:
Usage Note: This will usually be a GUID and is assigned by the sending application.

..  identifier 1..2Shared Health IdentifierSlice: Unordered, Open by pattern:type
Definition:
A technical identifier - identifies some entity uniquely and unambiguously.


Comments:
These are the identifiers assigned by the EMR and, in some cases, by the DIS.

..  identifier
     (EMR-id)
1..1PrescribeIT® Prescriber Prescription IdentifierDefinition:
A technical identifier - identifies some entity uniquely and unambiguously.


Comments:
In the context of a Jurisdictional RX Identifier Notification (902), this Prescription business identifier used to convey the MedicationOrder.identifier that is associated with the DIS RX ID being returned.

...  type 1..1Shared Health CodeableConcept CodeBinding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/identifier-type","code":"PLAC"}]}
Definition:
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.


Comments:


....  coding 1..*CodingSlice: Unordered, Open by value:system, value:code
Definition:
A reference to a code defined by a terminology system.


Comments:
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labelled as UserSelected = true.

.....  system 1..1uriDefinition:
The identification of the code system that defines the meaning of the symbol in the code.


Comments:
This is the URI that represents the coding system as defined within the binding.

.....  code 1..1codeDefinition:
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).


Comments:
This is the code as defined within the binding.

.....  display 0..1stringDefinition:
A representation of the meaning of the code in the system, following the rules of the system.

....  coding
         (placer)
0..*CodingDefinition:
A reference to a code defined by a terminology system.


Comments:
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labelled as UserSelected = true.

.....  system 1..1uriFixed Value: http://hl7.org/fhir/identifier-type
Definition:
The identification of the code system that defines the meaning of the symbol in the code.


Comments:
Fixed value: http://hl7.org/fhir/identifier-type

.....  code 1..1codeFixed Value: PLAC
Definition:
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).


Comments:
Fixed value: PLAC

.....  display 0..1stringDefinition:
A representation of the meaning of the code in the system, following the rules of the system.

...  system 1..1uriEMR-id-branch-2: This must be an OID ending in .2
Example' General': http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri
Definition:
Establishes the namespace in which set of possible id values is unique.


Comments:
Conformance Rule: This must be an OID of the URI form [Vendor root].[Application instance node].2 (e.g. urn:oid:1.2.3.4). The branch, “.2” is appended to create a unique namespace for the Prescription Identifer

...  value 1..1stringExample' General': 123456
Definition:
The portion of the identifier typically relevant to the user and which is unique within the context of the system.


Comments:
Usage Rule: The business identifier that uniquely identifies a prescription.

..  identifier
     (DIS-id)
1..1IdentifierDefinition:
External identifier - one that would be used by another non-FHIR system - for example a re-imbursement system might issue its own id for each prescription that is created. This is particularly important where FHIR only provides part of an entire workflow process where records have to be tracked through an entire system.


Comments:
Usage Note: This is the Jurisdictional RX ID associated with the Medication Order that is stored within the EMR.

...  type 1..1Shared Health CodeableConcept CodeBinding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/v2/0203","code":"RRI"}]}
Definition:
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.


Comments:


...  system 0..1uriExample' General': http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri
Definition:
Establishes the namespace in which set of possible id values is unique.

...  value 1..1stringExample' General': 123456
Definition:
The portion of the identifier typically relevant to the user and which is unique within the context of the system.


Comments:
If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension.

..  medication[x]
     (medicationReference)
1..1Reference()Definition:
Identifies the medication being administered. This is a link to a resource that represents the medication which may be the details of the medication or simply an attribute carrying a code that identifies the medication from a known list of medications.


Comments:
If only a code is specified, then it needs to be a code for a specific product. If more information is required, then the use of the medication resource is recommended. Note: do not use Medication.name to describe the prescribed medication. When the only available information is a text description of the medication, Medication.code.text should be used.

...  display 0..1stringFixed Value: medication
Definition:
Plain text narrative that identifies the resource in addition to the resource reference.


Comments:
Fixed value: medication

This structure is derived from MedicationOrder

Summary

Mandatory: 7 elements
Must-Support: 10 elements
Fixed Value: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element MedicationOrder.identifier is sliced based on the value of pattern:type

This structure is derived from MedicationOrder

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationOrder S0..*MedicationOrderPrescription of medication to for patient
... id S1..1idLogical id of this artifact
... identifier S1..2(Slice Definition)An identifier intended for computation
Slice: Unordered, Open by pattern:type
.... identifier:EMR-id S1..1PrescribeIT® Prescriber Prescription IdentifierEMR Prescription Identifier
..... type S1..1Shared Health CodeableConcept CodeConcept - reference to a terminology or just text
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/identifier-type
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: PLAC
.... identifier:DIS-id S1..1IdentifierDIS Order identifier
..... type S1..1Shared Health CodeableConcept CodeConcept - reference to a terminology or just text
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/v2/0203
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: RRI
..... system S0..1uriThe namespace for the identifier
..... value S1..1stringThe value that is unique
... medicationReference S1..1Reference()Medication to be taken
.... display S0..1stringText alternative for the resource
Fixed Value: medication

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationOrder SΣ0..*MedicationOrderPrescription of medication to for patient
... id SΣ1..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: http://tools.ietf.org/html/bcp47 (required): A human language.


... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ1..2(Slice Definition)An identifier intended for computation
Slice: Unordered, Open by pattern:type
.... identifier:EMR-id S1..1PrescribeIT® Prescriber Prescription IdentifierEMR Prescription Identifier
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type S1..1Shared Health CodeableConcept CodeConcept - reference to a terminology or just text
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.


Required Pattern: At least the following
...... id0..1stringxml:id (or equivalent in JSON)
...... extension0..*ExtensionAdditional Content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringxml:id (or equivalent in JSON)
....... extension0..*ExtensionAdditional Content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/identifier-type
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: PLAC
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
...... id 0..1idxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
...... coding SΣ1..*(Slice Definition)Code defined by a terminology system
Slice: Unordered, Open by value:system, value:code
....... coding:All Slices Content/Rules for all slices
........ id 0..1idxml:id (or equivalent in JSON)
........ extension 0..*ExtensionAdditional Content defined by implementations
........ system SΣ1..1uriIdentity of the terminology system
........ version Σ0..1stringVersion of the system - if relevant
........ code SΣ1..1codeSymbol in syntax defined by the system
........ display SΣ0..1stringRepresentation defined by the system
........ userSelected Σ0..1booleanIf this coding was chosen directly by the user
....... coding:placer SΣ0..*CodingCode defined by a terminology system
........ id 0..1idxml:id (or equivalent in JSON)
........ extension 0..*ExtensionAdditional Content defined by implementations
........ system SΣ1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/identifier-type
........ version Σ0..1stringVersion of the system - if relevant
........ code SΣ1..1codeSymbol in syntax defined by the system
Fixed Value: PLAC
........ display SΣ0..1stringRepresentation defined by the system
........ userSelected Σ0..1booleanIf this coding was chosen directly by the user
...... text Σ0..1stringPlain text representation of the concept
..... system SΣI1..1uriThe namespace for the identifier
EMR-id-branch-2: This must be an OID ending in .2
Example General: http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri
..... value SΣ1..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:DIS-id SΣ1..1IdentifierDIS Order identifier
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type S1..1Shared Health CodeableConcept CodeConcept - reference to a terminology or just text
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.


Required Pattern: At least the following
...... id0..1stringxml:id (or equivalent in JSON)
...... extension0..*ExtensionAdditional Content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringxml:id (or equivalent in JSON)
....... extension0..*ExtensionAdditional Content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/v2/0203
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: RRI
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... system SΣ0..1uriThe namespace for the identifier
Example General: http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri
..... value SΣ1..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... status ?!Σ0..1codeactive | on-hold | completed | entered-in-error | stopped | draft
Binding: MedicationOrderStatus (required): A code specifying the state of the prescribing event. Describes the lifecycle of the prescription.

... medication[x] Σ1..1(Slice Definition)Medication to be taken
Slice: Unordered, Closed by type:$this
.... medication[x]:medicationReference SΣ1..1Reference()Medication to be taken
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... reference ΣI0..1stringRelative, internal or absolute URL reference
..... display SΣ0..1stringText alternative for the resource
Fixed Value: medication
... patient Σ0..1Reference(Patient)Who prescription is for
... encounter Σ0..1Reference(Encounter)Created during encounter/admission/stay
... dateWritten Σ0..1dateTimeWhen prescription was authorized
... prescriber Σ0..1Reference(Practitioner)Who ordered the medication(s)
... reasonCode Σ0..*CodeableConceptReason or indication for writing the prescription
Binding: Condition/Problem/Diagnosis Codes (example): Codes indicating why the medication was ordered.


... reasonReference Σ0..*Reference(Condition)Condition that supports why the prescription is being written
... dateEnded Σ0..1dateTimeWhen prescription was stopped
... reasonEnded Σ0..1CodeableConceptWhy prescription was stopped
Binding: (unbound) (example): Codes indicating why the medication was terminated; e.g. Adverse reaction, medication change, issue resolved, etc.

... note Σ0..*AnnotationInformation about the prescription
... dosageInstruction Σ0..*BackboneElementHow medication should be taken
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... text Σ0..1stringFree text dosage instructions e.g. SIG
.... additionalInstructions Σ0..1CodeableConceptSupplemental instructions - e.g. "with meals"
Binding: (unbound) (example): Codes identifying additional instructions such as "take with water" or "avoid operating heavy machinery".

.... timing Σ0..1TimingWhen medication should be administered
.... asNeeded[x] Σ0..1Take "as needed" (for x)
Binding: (unbound) (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.

..... asNeededBooleanboolean
..... asNeededCodeableConceptCodeableConcept
.... site[x] Σ0..1Body site to administer to
Binding: SNOMED CT Anatomical Structure for Administration Site Codes (example): A coded concept describing the site location the medicine enters into or onto the body.

..... siteCodeableConceptCodeableConcept
..... siteReferenceReference(BodySite)
.... route Σ0..1CodeableConceptHow drug should enter body
Binding: SNOMED CT Route Codes (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..1CodeableConceptTechnique for administering medication
Binding: (unbound) (example): A coded concept describing the technique by which the medicine is administered.

.... dose[x] Σ0..1Amount of medication per dose
..... doseRangeRange
..... doseQuantityQuantity(SimpleQuantity)
.... rate[x] Σ0..1Amount of medication per unit of time
..... rateRatioRatio
..... rateRangeRange
..... rateQuantityQuantity(SimpleQuantity)
.... maxDosePerPeriod Σ0..1RatioUpper limit on medication per unit of time
... dispenseRequest Σ0..1BackboneElementMedication supply authorization
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... medication[x] Σ0..1Product to be supplied
..... medicationCodeableConceptCodeableConcept
..... medicationReferenceReference(Medication)
.... validityPeriod Σ0..1PeriodTime period supply is authorized for
.... numberOfRepeatsAllowed Σ0..1positiveIntNumber of refills authorized
.... quantity Σ0..1SimpleQuantityAmount of medication to supply per dispense
.... expectedSupplyDuration Σ0..1DurationNumber of days supply per dispense
... substitution Σ0..1BackboneElementAny restrictions on medication substitution
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... type Σ1..1CodeableConceptgeneric | formulary +
Binding: ActSubstanceAdminSubstitutionCode (example): A coded concept describing whether a different medicinal product may be dispensed other than the product as specified exactly in the prescription.

.... reason Σ0..1CodeableConceptWhy 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..1Reference(MedicationOrder)An order/prescription that this supersedes

doco Documentation for this format

Grid View

This structure is derived from MedicationOrder

NameCard.TypeConstraints and Usage
.  MedicationOrder 0..*MedicationOrderDefinition:
An order for both supply of the medication and the instructions for administration of the medication to a patient. The resource is called "MedicationOrder" rather than "MedicationPrescription" to generalize the use across inpatient and outpatient settings as well as for care plans, etc.

..  id 1..1idDefinition:
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.


Comments:
Usage Note: This will usually be a GUID and is assigned by the sending application.

..  identifier 1..2Shared Health IdentifierSlice: Unordered, Open by pattern:type
Definition:
A technical identifier - identifies some entity uniquely and unambiguously.


Comments:
These are the identifiers assigned by the EMR and, in some cases, by the DIS.

..  identifier
     (EMR-id)
1..1PrescribeIT® Prescriber Prescription IdentifierDefinition:
A technical identifier - identifies some entity uniquely and unambiguously.


Comments:
In the context of a Jurisdictional RX Identifier Notification (902), this Prescription business identifier used to convey the MedicationOrder.identifier that is associated with the DIS RX ID being returned.

...  type 1..1Shared Health CodeableConcept CodeBinding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/identifier-type","code":"PLAC"}]}
Definition:
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.


Comments:


....  coding 1..*CodingSlice: Unordered, Open by value:system, value:code
Definition:
A reference to a code defined by a terminology system.


Comments:
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labelled as UserSelected = true.

.....  system 1..1uriDefinition:
The identification of the code system that defines the meaning of the symbol in the code.


Comments:
This is the URI that represents the coding system as defined within the binding.

.....  code 1..1codeDefinition:
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).


Comments:
This is the code as defined within the binding.

.....  display 0..1stringDefinition:
A representation of the meaning of the code in the system, following the rules of the system.

....  coding
         (placer)
0..*CodingDefinition:
A reference to a code defined by a terminology system.


Comments:
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labelled as UserSelected = true.

.....  system 1..1uriFixed Value: http://hl7.org/fhir/identifier-type
Definition:
The identification of the code system that defines the meaning of the symbol in the code.


Comments:
Fixed value: http://hl7.org/fhir/identifier-type

.....  code 1..1codeFixed Value: PLAC
Definition:
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).


Comments:
Fixed value: PLAC

.....  display 0..1stringDefinition:
A representation of the meaning of the code in the system, following the rules of the system.

...  system 1..1uriEMR-id-branch-2: This must be an OID ending in .2
Example' General': http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri
Definition:
Establishes the namespace in which set of possible id values is unique.


Comments:
Conformance Rule: This must be an OID of the URI form [Vendor root].[Application instance node].2 (e.g. urn:oid:1.2.3.4). The branch, “.2” is appended to create a unique namespace for the Prescription Identifer

...  value 1..1stringExample' General': 123456
Definition:
The portion of the identifier typically relevant to the user and which is unique within the context of the system.


Comments:
Usage Rule: The business identifier that uniquely identifies a prescription.

..  identifier
     (DIS-id)
1..1IdentifierDefinition:
External identifier - one that would be used by another non-FHIR system - for example a re-imbursement system might issue its own id for each prescription that is created. This is particularly important where FHIR only provides part of an entire workflow process where records have to be tracked through an entire system.


Comments:
Usage Note: This is the Jurisdictional RX ID associated with the Medication Order that is stored within the EMR.

...  type 1..1Shared Health CodeableConcept CodeBinding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/v2/0203","code":"RRI"}]}
Definition:
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.


Comments:


...  system 0..1uriExample' General': http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri
Definition:
Establishes the namespace in which set of possible id values is unique.

...  value 1..1stringExample' General': 123456
Definition:
The portion of the identifier typically relevant to the user and which is unique within the context of the system.


Comments:
If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension.

..  medication[x]
     (medicationReference)
1..1Reference()Definition:
Identifies the medication being administered. This is a link to a resource that represents the medication which may be the details of the medication or simply an attribute carrying a code that identifies the medication from a known list of medications.


Comments:
If only a code is specified, then it needs to be a code for a specific product. If more information is required, then the use of the medication resource is recommended. Note: do not use Medication.name to describe the prescribed medication. When the only available information is a text description of the medication, Medication.code.text should be used.

...  display 0..1stringFixed Value: medication
Definition:
Plain text narrative that identifies the resource in addition to the resource reference.


Comments:
Fixed value: medication

This structure is derived from MedicationOrder

Summary

Mandatory: 7 elements
Must-Support: 10 elements
Fixed Value: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element MedicationOrder.identifier is sliced based on the value of pattern:type

Differential View

This structure is derived from MedicationOrder

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationOrder S0..*MedicationOrderPrescription of medication to for patient
... id S1..1idLogical id of this artifact
... identifier S1..2(Slice Definition)An identifier intended for computation
Slice: Unordered, Open by pattern:type
.... identifier:EMR-id S1..1PrescribeIT® Prescriber Prescription IdentifierEMR Prescription Identifier
..... type S1..1Shared Health CodeableConcept CodeConcept - reference to a terminology or just text
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/identifier-type
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: PLAC
.... identifier:DIS-id S1..1IdentifierDIS Order identifier
..... type S1..1Shared Health CodeableConcept CodeConcept - reference to a terminology or just text
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/v2/0203
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: RRI
..... system S0..1uriThe namespace for the identifier
..... value S1..1stringThe value that is unique
... medicationReference S1..1Reference()Medication to be taken
.... display S0..1stringText alternative for the resource
Fixed Value: medication

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationOrder SΣ0..*MedicationOrderPrescription of medication to for patient
... id SΣ1..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: http://tools.ietf.org/html/bcp47 (required): A human language.


... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ1..2(Slice Definition)An identifier intended for computation
Slice: Unordered, Open by pattern:type
.... identifier:EMR-id S1..1PrescribeIT® Prescriber Prescription IdentifierEMR Prescription Identifier
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type S1..1Shared Health CodeableConcept CodeConcept - reference to a terminology or just text
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.


Required Pattern: At least the following
...... id0..1stringxml:id (or equivalent in JSON)
...... extension0..*ExtensionAdditional Content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringxml:id (or equivalent in JSON)
....... extension0..*ExtensionAdditional Content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/identifier-type
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: PLAC
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
...... id 0..1idxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
...... coding SΣ1..*(Slice Definition)Code defined by a terminology system
Slice: Unordered, Open by value:system, value:code
....... coding:All Slices Content/Rules for all slices
........ id 0..1idxml:id (or equivalent in JSON)
........ extension 0..*ExtensionAdditional Content defined by implementations
........ system SΣ1..1uriIdentity of the terminology system
........ version Σ0..1stringVersion of the system - if relevant
........ code SΣ1..1codeSymbol in syntax defined by the system
........ display SΣ0..1stringRepresentation defined by the system
........ userSelected Σ0..1booleanIf this coding was chosen directly by the user
....... coding:placer SΣ0..*CodingCode defined by a terminology system
........ id 0..1idxml:id (or equivalent in JSON)
........ extension 0..*ExtensionAdditional Content defined by implementations
........ system SΣ1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/identifier-type
........ version Σ0..1stringVersion of the system - if relevant
........ code SΣ1..1codeSymbol in syntax defined by the system
Fixed Value: PLAC
........ display SΣ0..1stringRepresentation defined by the system
........ userSelected Σ0..1booleanIf this coding was chosen directly by the user
...... text Σ0..1stringPlain text representation of the concept
..... system SΣI1..1uriThe namespace for the identifier
EMR-id-branch-2: This must be an OID ending in .2
Example General: http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri
..... value SΣ1..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:DIS-id SΣ1..1IdentifierDIS Order identifier
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type S1..1Shared Health CodeableConcept CodeConcept - reference to a terminology or just text
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.


Required Pattern: At least the following
...... id0..1stringxml:id (or equivalent in JSON)
...... extension0..*ExtensionAdditional Content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringxml:id (or equivalent in JSON)
....... extension0..*ExtensionAdditional Content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/v2/0203
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: RRI
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... system SΣ0..1uriThe namespace for the identifier
Example General: http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri
..... value SΣ1..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... status ?!Σ0..1codeactive | on-hold | completed | entered-in-error | stopped | draft
Binding: MedicationOrderStatus (required): A code specifying the state of the prescribing event. Describes the lifecycle of the prescription.

... medication[x] Σ1..1(Slice Definition)Medication to be taken
Slice: Unordered, Closed by type:$this
.... medication[x]:medicationReference SΣ1..1Reference()Medication to be taken
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... reference ΣI0..1stringRelative, internal or absolute URL reference
..... display SΣ0..1stringText alternative for the resource
Fixed Value: medication
... patient Σ0..1Reference(Patient)Who prescription is for
... encounter Σ0..1Reference(Encounter)Created during encounter/admission/stay
... dateWritten Σ0..1dateTimeWhen prescription was authorized
... prescriber Σ0..1Reference(Practitioner)Who ordered the medication(s)
... reasonCode Σ0..*CodeableConceptReason or indication for writing the prescription
Binding: Condition/Problem/Diagnosis Codes (example): Codes indicating why the medication was ordered.


... reasonReference Σ0..*Reference(Condition)Condition that supports why the prescription is being written
... dateEnded Σ0..1dateTimeWhen prescription was stopped
... reasonEnded Σ0..1CodeableConceptWhy prescription was stopped
Binding: (unbound) (example): Codes indicating why the medication was terminated; e.g. Adverse reaction, medication change, issue resolved, etc.

... note Σ0..*AnnotationInformation about the prescription
... dosageInstruction Σ0..*BackboneElementHow medication should be taken
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... text Σ0..1stringFree text dosage instructions e.g. SIG
.... additionalInstructions Σ0..1CodeableConceptSupplemental instructions - e.g. "with meals"
Binding: (unbound) (example): Codes identifying additional instructions such as "take with water" or "avoid operating heavy machinery".

.... timing Σ0..1TimingWhen medication should be administered
.... asNeeded[x] Σ0..1Take "as needed" (for x)
Binding: (unbound) (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.

..... asNeededBooleanboolean
..... asNeededCodeableConceptCodeableConcept
.... site[x] Σ0..1Body site to administer to
Binding: SNOMED CT Anatomical Structure for Administration Site Codes (example): A coded concept describing the site location the medicine enters into or onto the body.

..... siteCodeableConceptCodeableConcept
..... siteReferenceReference(BodySite)
.... route Σ0..1CodeableConceptHow drug should enter body
Binding: SNOMED CT Route Codes (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..1CodeableConceptTechnique for administering medication
Binding: (unbound) (example): A coded concept describing the technique by which the medicine is administered.

.... dose[x] Σ0..1Amount of medication per dose
..... doseRangeRange
..... doseQuantityQuantity(SimpleQuantity)
.... rate[x] Σ0..1Amount of medication per unit of time
..... rateRatioRatio
..... rateRangeRange
..... rateQuantityQuantity(SimpleQuantity)
.... maxDosePerPeriod Σ0..1RatioUpper limit on medication per unit of time
... dispenseRequest Σ0..1BackboneElementMedication supply authorization
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... medication[x] Σ0..1Product to be supplied
..... medicationCodeableConceptCodeableConcept
..... medicationReferenceReference(Medication)
.... validityPeriod Σ0..1PeriodTime period supply is authorized for
.... numberOfRepeatsAllowed Σ0..1positiveIntNumber of refills authorized
.... quantity Σ0..1SimpleQuantityAmount of medication to supply per dispense
.... expectedSupplyDuration Σ0..1DurationNumber of days supply per dispense
... substitution Σ0..1BackboneElementAny restrictions on medication substitution
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... type Σ1..1CodeableConceptgeneric | formulary +
Binding: ActSubstanceAdminSubstitutionCode (example): A coded concept describing whether a different medicinal product may be dispensed other than the product as specified exactly in the prescription.

.... reason Σ0..1CodeableConceptWhy 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..1Reference(MedicationOrder)An order/prescription that this supersedes

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

PathConformanceValueSet / Code
MedicationOrder.languagerequiredhttp://tools.ietf.org/html/bcp47
MedicationOrder.identifier:EMR-id.userequiredIdentifierUse
MedicationOrder.identifier:EMR-id.typeextensiblePattern: PLAC
MedicationOrder.identifier:DIS-id.userequiredIdentifierUse
MedicationOrder.identifier:DIS-id.typeextensiblePattern: RRI
MedicationOrder.statusrequiredMedicationOrderStatus
MedicationOrder.reasonCodeexampleCondition/Problem/Diagnosis Codes
MedicationOrder.reasonEndedexample
MedicationOrder.dosageInstruction.additionalInstructionsexample
MedicationOrder.dosageInstruction.asNeeded[x]example
MedicationOrder.dosageInstruction.site[x]exampleSNOMED CT Anatomical Structure for Administration Site Codes
MedicationOrder.dosageInstruction.routeexampleSNOMED CT Route Codes
MedicationOrder.dosageInstruction.methodexample
MedicationOrder.substitution.typeexampleActSubstanceAdminSubstitutionCode
MedicationOrder.substitution.reasonexampleSubstanceAdminSubstitutionReason

Constraints

IdPathDetailsRequirements
EMR-id-branch-2MedicationOrder.identifier:EMR-id.systemThis must be an OID ending in .2
: $this.matches('^urn\\:oid\\:(\\d+\\.)+2$')