DispensedMedications
| Canonical URL | https://fhir.synapxe.sg/StructureDefinition/profile-medicationdispense |
|---|---|
| Version | 1.2.0 |
| Status | Active |
| Description | A Bundle of MedicationDispense resources will be used to store one or more medication products to be or has been dispensed for a named person/patient. This includes a description of the medication product (supply) provided and the instructions for administering the medication. The medication dispense is the result of a pharmacy system responding to a medication order. |
| MedicationDispense | C | MedicationDispense | |
| id | Σ | 0..1 | id |
| meta | Σ | 0..1 | Meta |
| implicitRules | Σ ?! | 0..1 | uri |
| language | 0..1 | codeBinding | |
| text | C | 0..1 | Narrative |
| contained | C | 0..* | Resource |
| medication | C | 0..1 | Medication |
| medicationrequest | C | 0..1 | MedicationRequest |
| extension | C | 0..* | Extension |
| changesMade | C | 0..* | Extension(Complex) |
| orderSetConnectingTerm | C | 0..1 | Extension(CodeableConcept) |
| dispensingInstitution | C | 0..1 | Extension(Reference(Organization)) |
| modifierExtension | Σ ?! C | 0..0 | Extension |
| identifier | C | 1..* | Identifier |
| (All Slices) | |||
| id | 0..0 | string | |
| extension | C | 0..0 | Extension |
| use | Σ ?! | 0..0 | codeBinding |
| type | Σ | 0..0 | CodeableConceptBinding |
| system | Σ | 1..1 | uri |
| value | Σ C | 1..1 | string |
| period | Σ C | 0..0 | Period |
| assigner | Σ C | 0..0 | Reference(Organization) |
| recordIdentifier | C | 1..1 | Identifier |
| id | 0..0 | string | |
| extension | C | 0..0 | Extension |
| use | Σ ?! | 0..0 | codeBinding |
| type | Σ | 0..0 | CodeableConceptBinding |
| system | Σ | 1..1 | uriFixed Value |
| value | Σ C | 1..1 | string |
| period | Σ C | 0..0 | Period |
| assigner | Σ C | 0..0 | Reference(Organization) |
| dispenseID | C | 1..1 | Identifier |
| id | 0..0 | string | |
| extension | C | 0..0 | Extension |
| use | Σ ?! | 0..0 | codeBinding |
| type | Σ | 0..0 | CodeableConceptBinding |
| system | Σ | 1..1 | uriFixed Value |
| value | Σ C | 1..1 | string |
| period | Σ C | 0..0 | Period |
| assigner | Σ C | 0..0 | Reference(Organization) |
| sourceGroupingID | C | 1..1 | Identifier |
| id | 0..0 | string | |
| extension | C | 0..0 | Extension |
| use | Σ ?! | 0..0 | codeBinding |
| type | Σ | 0..0 | CodeableConceptBinding |
| system | Σ | 1..1 | uriFixed Value |
| value | Σ C | 1..1 | string |
| period | Σ C | 0..0 | Period |
| assigner | Σ C | 0..0 | Reference(Organization) |
| basedOn | C | 0..0 | Reference(CarePlan) |
| partOf | C | 0..0 | Reference(MedicationAdministration | Procedure) |
| status | Σ ?! | 1..1 | codeBinding |
| notPerformedReason | 0..1 | CodeableReference(DetectedIssue) | |
| id | 0..0 | string | |
| extension | C | 0..0 | Extension |
| concept | Σ | 1..1 | CodeableConceptBinding |
| id | 0..0 | string | |
| extension | C | 0..0 | Extension |
| coding | Σ C | 1..* | Coding |
| id | 0..0 | string | |
| extension | C | 0..0 | Extension |
| system | Σ | 1..1 | uriFixed Value |
| version | Σ | 0..0 | string |
| code | Σ C | 1..1 | code |
| display | Σ C | 1..1 | string |
| userSelected | Σ | 0..0 | boolean |
| text | Σ | 0..0 | string |
| reference | Σ C | 0..0 | Reference |
| statusChanged | 0..0 | dateTime | |
| category | 0..1 | CodeableConceptBinding | |
| id | 0..0 | string | |
| extension | C | 0..0 | Extension |
| coding | Σ C | 1..* | Coding |
| id | 0..0 | string | |
| extension | C | 0..0 | Extension |
| system | Σ | 1..1 | uriFixed Value |
| version | Σ | 0..1 | string |
| code | Σ C | 1..1 | code |
| display | Σ C | 1..1 | string |
| userSelected | Σ | 0..0 | boolean |
| text | Σ | 0..0 | string |
| medication | Σ | 1..1 | CodeableReference(Medication) |
| id | 0..0 | string | |
| extension | C | 0..0 | Extension |
| concept | Σ | 0..0 | CodeableConcept |
| reference | Σ C | 1..1 | Reference |
| id | 0..0 | string | |
| extension | C | 0..0 | Extension |
| reference | Σ C | 0..1 | string |
| type | Σ | 0..1 | uriBinding |
| identifier | Σ C | 0..1 | Identifier |
| display | Σ C | 0..1 | string |
| subject | Σ C | 1..1 | Reference(Patient) |
| id | 0..0 | string | |
| extension | C | 0..0 | Extension |
| reference | Σ C | 0..0 | string |
| type | Σ | 1..1 | uriBindingFixed Value |
| identifier | Σ C | 1..1 | Identifier |
| id | 0..0 | string | |
| extension | C | 0..0 | Extension |
| use | Σ ?! | 0..0 | codeBinding |
| type | Σ | 0..0 | CodeableConceptBinding |
| system | Σ | 1..1 | uriFixed Value |
| value | Σ C | 1..1 | string |
| period | Σ C | 0..0 | Period |
| assigner | Σ C | 0..0 | Reference(Organization) |
| display | Σ C | 0..0 | string |
| encounter | C | 0..1 | Reference(Encounter) |
| id | 0..0 | string | |
| extension | C | 0..0 | Extension |
| reference | Σ C | 0..0 | string |
| type | Σ | 1..1 | uriBindingFixed Value |
| identifier | Σ C | 1..1 | Identifier |
| id | 0..0 | string | |
| extension | C | 0..0 | Extension |
| use | Σ ?! | 0..0 | codeBinding |
| type | Σ | 0..0 | CodeableConceptBinding |
| system | Σ | 1..1 | uriFixed Value |
| value | Σ C | 1..1 | string |
| period | Σ C | 0..0 | Period |
| assigner | Σ C | 0..0 | Reference(Organization) |
| display | Σ C | 0..0 | string |
| supportingInformation | C | 0..0 | Reference(Resource) |
| performer | 1..1 | BackboneElement | |
| id | 0..0 | string | |
| extension | C | 0..0 | Extension |
| modifierExtension | Σ ?! C | 0..0 | Extension |
| function | 0..0 | CodeableConcept | |
| actor | C | 1..1 | Reference(Practitioner) |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| reference | Σ C | 0..1 | string |
| type | Σ | 0..1 | uriBinding |
| identifier | Σ C | 0..1 | Identifier |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| use | Σ ?! | 0..1 | codeBinding |
| type | Σ | 0..1 | CodeableConceptBinding |
| system | Σ | 0..1 | uriFixed Value |
| value | Σ C | 0..1 | string |
| period | Σ C | 0..1 | Period |
| assigner | Σ C | 0..1 | Reference(Organization) |
| display | Σ C | 0..0 | string |
| location | C | 0..1 | Reference(Location) |
| id | 0..0 | string | |
| extension | C | 0..0 | Extension |
| reference | Σ C | 0..0 | string |
| type | Σ | 1..1 | uriBindingFixed Value |
| identifier | Σ C | 1..1 | Identifier |
| id | 0..0 | string | |
| extension | C | 0..0 | Extension |
| use | Σ ?! | 0..0 | codeBinding |
| type | Σ | 0..0 | CodeableConceptBinding |
| system | Σ | 1..1 | uriFixed Value |
| value | Σ C | 1..1 | string |
| period | Σ C | 0..0 | Period |
| assigner | Σ C | 0..0 | Reference(Organization) |
| display | Σ C | 0..0 | string |
| authorizingPrescription | C | 1..1 | Reference(MedicationRequest) |
| id | 0..0 | string | |
| extension | C | 0..0 | Extension |
| reference | Σ C | 0..0 | string |
| type | Σ | 1..1 | uriBindingFixed Value |
| identifier | Σ C | 1..1 | Identifier |
| id | 0..0 | string | |
| extension | C | 0..0 | Extension |
| use | Σ ?! | 0..0 | codeBinding |
| type | Σ | 0..0 | CodeableConceptBinding |
| system | Σ | 1..1 | uriFixed Value |
| value | Σ C | 1..1 | string |
| period | Σ C | 0..0 | Period |
| assigner | Σ C | 0..0 | Reference(Organization) |
| display | Σ C | 0..0 | string |
| type | 0..0 | CodeableConcept | |
| quantity | C | 0..1 | SimpleQuantity |
| id | 0..0 | string | |
| extension | C | 0..0 | Extension |
| value | Σ | 1..1 | decimal |
| comparator | Σ ?! | 0..0 | codeBinding |
| unit | Σ | 1..1 | string |
| system | Σ C | 1..1 | uri |
| code | Σ C | 1..1 | code |
| daysSupply | C | 0..0 | SimpleQuantity |
| recorded | 1..1 | dateTime | |
| whenPrepared | Σ C | 1..1 | dateTime |
| whenHandedOver | C | 0..0 | dateTime |
| destination | C | 0..1 | Reference(Location) |
| id | 0..0 | string | |
| extension | C | 0..0 | Extension |
| reference | Σ C | 0..0 | string |
| type | Σ | 1..1 | uriBindingPattern |
| identifier | Σ C | 1..1 | Identifier |
| id | 0..0 | string | |
| extension | C | 0..0 | Extension |
| use | Σ ?! | 0..0 | codeBinding |
| type | Σ | 0..0 | CodeableConceptBinding |
| system | Σ | 1..1 | uriPattern |
| value | Σ C | 1..1 | string |
| period | Σ C | 0..0 | Period |
| assigner | Σ C | 0..0 | Reference(Organization) |
| display | Σ C | 1..1 | string |
| receiver | C | 0..0 | Reference(Location | Patient | Practitioner | PractitionerRole | RelatedPerson) |
| note | 0..0 | Annotation | |
| renderedDosageInstruction | 0..0 | markdown | |
| dosageInstruction | C | 1..1 | Dosage |
| id | 0..0 | string | |
| extension | C | 0..0 | Extension |
| modifierExtension | Σ ?! C | 0..0 | Extension |
| sequence | Σ | 1..1 | integer |
| text | Σ | 0..1 | string |
| additionalInstruction | Σ | 0..1 | CodeableConcept |
| id | 0..0 | string | |
| extension | C | 0..0 | Extension |
| coding | Σ C | 0..0 | Coding |
| text | Σ | 1..1 | string |
| patientInstruction | Σ | 0..0 | string |
| timing | Σ | 0..1 | Timing |
| id | 0..0 | string | |
| extension | C | 0..0 | Extension |
| modifierExtension | Σ ?! C | 0..0 | Extension |
| event | Σ | 0..0 | dateTime |
| repeat | Σ C | 0..1 | Element |
| id | 0..0 | string | |
| extension | C | 0..0 | Extension |
| bounds[x] | Σ | 0..1 | Period |
| id | 0..0 | string | |
| extension | C | 0..0 | Extension |
| start | Σ C | 1..1 | dateTime |
| end | Σ C | 1..1 | dateTime |
| count | Σ C | 0..1 | positiveInt |
| countMax | Σ C | 0..1 | positiveInt |
| duration | Σ C | 0..1 | decimal |
| durationMax | Σ C | 0..1 | decimal |
| durationUnit | Σ C | 0..1 | codeBinding |
| frequency | Σ | 0..1 | positiveInt |
| frequencyMax | Σ | 0..1 | positiveInt |
| period | Σ C | 0..1 | decimal |
| periodMax | Σ C | 0..1 | decimal |
| periodUnit | Σ C | 0..1 | codeBinding |
| dayOfWeek | Σ | 0..1 | codeBinding |
| timeOfDay | Σ C | 0..1 | time |
| when | Σ C | 0..1 | codeBinding |
| offset | Σ C | 0..1 | unsignedInt |
| code | Σ | 0..1 | CodeableConceptBinding |
| id | 0..0 | string | |
| extension | C | 0..0 | Extension |
| coding | Σ C | 1..1 | Coding |
| id | 0..0 | string | |
| extension | C | 0..0 | Extension |
| system | Σ | 1..1 | uri |
| version | Σ | 0..1 | string |
| code | Σ C | 1..1 | code |
| display | Σ C | 1..1 | string |
| userSelected | Σ | 0..0 | boolean |
| text | Σ | 0..0 | string |
| asNeeded | Σ C | 0..0 | boolean |
| asNeededFor | Σ C | 0..1 | CodeableConcept |
| id | 0..0 | string | |
| extension | C | 0..0 | Extension |
| coding | Σ C | 0..0 | Coding |
| text | Σ | 1..1 | string |
| site | Σ | 0..0 | CodeableConcept |
| route | Σ | 1..1 | CodeableConcept |
| id | 0..0 | string | |
| extension | C | 0..0 | Extension |
| coding | Σ C | 1..* | Coding |
| id | 0..0 | string | |
| extension | C | 0..0 | Extension |
| system | Σ | 1..1 | uri |
| version | Σ | 0..1 | string |
| code | Σ C | 1..1 | code |
| display | Σ C | 1..1 | string |
| userSelected | Σ | 0..0 | boolean |
| text | Σ | 0..0 | string |
| method | Σ | 0..0 | CodeableConcept |
| doseAndRate | Σ | 0..* | Element |
| id | 0..0 | string | |
| extension | C | 0..0 | Extension |
| type | Σ | 0..0 | CodeableConcept |
| dose[x] | Σ | 1..1 | |
| doseQuantity | SimpleQuantity | ||
| doseRange | Range | ||
| rate[x] | Σ | 0..0 | |
| maxDosePerPeriod | Σ C | 0..0 | Ratio |
| maxDosePerAdministration | Σ C | 0..0 | SimpleQuantity |
| maxDosePerLifetime | Σ C | 0..0 | SimpleQuantity |
| substitution | 0..0 | BackboneElement | |
| eventHistory | C | 0..0 | Reference(Provenance) |
| MedicationDispense | |
| Short | Dispensing a medication to a named patient |
| Definition | Indicates that a medication product is to be or has been dispensed for a named person/patient. This includes a description of the medication product (supply) provided and the instructions for administering the medication. The medication dispense is the result of a pharmacy system responding to a medication order. |
| Cardinality | 0..* |
| Constraints |
|
| Mappings |
|
| MedicationDispense.id | |
| Short | Logical id of this artifact |
| Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
| Cardinality | 0..1 |
| Type | id |
| Summary | True |
| Comments | Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.meta | |
| Short | Metadata about the resource |
| Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
| Cardinality | 0..1 |
| Type | Meta |
| Summary | True |
| Constraints |
|
| Mappings |
|
| MedicationDispense.implicitRules | |
| Short | A set of rules under which this content was created |
| Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
| Cardinality | 0..1 |
| Type | uri |
| Modifier | True |
| Summary | True |
| Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.language | |
| Short | Language of the resource content |
| Definition | The base language in which the resource is written. |
| Cardinality | 0..1 |
| Type | code |
| Binding | IETF language tag for a human language |
| Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). |
| Constraints |
|
| Mappings |
|
| MedicationDispense.text | |
| Short | Text summary of the resource, for human interpretation |
| Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
| Cardinality | 0..1 |
| Type | Narrative |
| Alias | narrative, html, xhtml, display |
| Comments | Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. |
| Conditions | The cardinality or value of this element may be affected by these constraints: dom-6 |
| Constraints |
|
| Mappings |
|
| MedicationDispense.contained | |
| Short | Contained, inline Resources |
| Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. |
| Cardinality | 0..* |
| Type | Resource |
| Alias | inline resources, anonymous resources, contained resources |
| Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels. |
| Slicing | Unordered, Open, by $this(Type) |
| Conditions | The cardinality or value of this element may be affected by these constraints: dom-2, dom-4, dom-3, dom-5 |
| Mappings |
|
| MedicationDispense.contained:medication | |
| Short | Definition of a Medication |
| Definition | This resource is primarily used for the identification and definition of a medication, including ingredients, for the purposes of prescribing, dispensing, and administering a medication as well as for making statements about medication use. |
| Cardinality | 0..1 |
| Type | Medication |
| Alias | inline resources, anonymous resources, contained resources |
| Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels. |
| Conditions | The cardinality or value of this element may be affected by these constraints: dom-2, dom-4, dom-3, dom-5 |
| Constraints |
|
| Mappings |
|
| MedicationDispense.contained:medicationrequest | |
| Short | Ordering of medication for patient or group |
| Definition | An order or request for both supply of the medication and the instructions for administration of the medication to a patient. The resource is called "MedicationRequest" rather than "MedicationPrescription" or "MedicationOrder" to generalize the use across inpatient and outpatient settings, including care plans, etc., and to harmonize with workflow patterns. |
| Cardinality | 0..1 |
| Type | MedicationRequest |
| Alias | inline resources, anonymous resources, contained resources, Prescription, Order |
| Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels. |
| Conditions | The cardinality or value of this element may be affected by these constraints: dom-2, dom-4, dom-3, dom-5 |
| Constraints |
|
| Mappings |
|
| MedicationDispense.extension | |
| Short | Additional content defined by implementations |
| Definition | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Cardinality | 0..* |
| Type | Extension |
| Alias | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| MedicationDispense.extension:changesMade | |
| Short | Changes Made Information |
| Definition | Extension for capturing changes made information in MedicationRequest |
| Cardinality | 0..* |
| Type | Extension(Complex) |
| Alias | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.extension:orderSetConnectingTerm | |
| Short | Order Set Connecting Term Information |
| Definition | Extension for capturing order set connecting term information in MedicationRequest |
| Cardinality | 0..1 |
| Type | Extension(CodeableConcept) |
| Alias | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.extension:dispensingInstitution | |
| Short | Dispensing Institution Information |
| Definition | Extension for capturing dispensing institution information in ServiceRequest |
| Cardinality | 0..1 |
| Type | Extension(Reference(Organization)) |
| Alias | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.modifierExtension | |
| Short | Extensions that cannot be ignored |
| Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Cardinality | 0..0 |
| Type | Extension |
| Modifier | True |
| Summary | True |
| Alias | extensions, user content |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| MedicationDispense.identifier | |
| Short | External identifier |
| Definition | Identifiers associated with this Medication Dispense that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server. |
| Cardinality | 1..* |
| Type | Identifier |
| Comments | This is a business identifier, not a resource identifier. |
| Slicing | Unordered, Open, by system(Value) |
| Constraints |
|
| Mappings |
|
| MedicationDispense.identifier.id | |
| Short | Unique id for inter-element referencing |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..0 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| MedicationDispense.identifier.extension | |
| Short | Additional content defined by implementations |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Cardinality | 0..0 |
| Type | Extension |
| Alias | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| MedicationDispense.identifier.use | |
| Short | usual | official | temp | secondary | old (If known) |
| Definition | The purpose of this identifier. |
| Cardinality | 0..0 |
| Type | code |
| Binding | Identifies the purpose for this identifier, if known . |
| Modifier | True |
| Summary | True |
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.identifier.type | |
| Short | Description of identifier |
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
| Cardinality | 0..0 |
| Type | CodeableConcept |
| Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| Summary | True |
| Requirements | Allows users to make use of identifiers when the identifier system is not known. |
| Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.identifier.system | |
| Short | The namespace for the identifier value |
| Definition | Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique. |
| Cardinality | 1..1 |
| Type | uri |
| Summary | True |
| Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. |
| Comments | Identifier.system is always case sensitive. |
| Constraints |
|
| Examples | Generalhttp://www.acme.com/identifiers/patient |
| Mappings |
|
| MedicationDispense.identifier.value | |
| Short | The value that is unique |
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
| Cardinality | 1..1 |
| Type | string |
| Summary | True |
| 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 http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. |
| Conditions | The cardinality or value of this element may be affected by these constraints: ident-1 |
| Constraints |
|
| Examples | General123456 |
| Mappings |
|
| MedicationDispense.identifier.period | |
| Short | Time period when id is/was valid for use |
| Definition | Time period during which identifier is/was valid for use. |
| Cardinality | 0..0 |
| Type | Period |
| Summary | True |
| Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.identifier.assigner | |
| Short | Organization that issued id (may be just text) |
| Definition | Organization that issued/manages the identifier. |
| Cardinality | 0..0 |
| Type | Reference(Organization) |
| Summary | True |
| Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.identifier:recordIdentifier | |
| Short | External identifier |
| Definition | Identifiers associated with this Medication Dispense that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server. |
| Cardinality | 1..1 |
| Type | Identifier |
| Comments | This is a business identifier, not a resource identifier. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.identifier:recordIdentifier.id | |
| Short | Unique id for inter-element referencing |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..0 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| MedicationDispense.identifier:recordIdentifier.extension | |
| Short | Additional content defined by implementations |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Cardinality | 0..0 |
| Type | Extension |
| Alias | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| MedicationDispense.identifier:recordIdentifier.use | |
| Short | usual | official | temp | secondary | old (If known) |
| Definition | The purpose of this identifier. |
| Cardinality | 0..0 |
| Type | code |
| Binding | Identifies the purpose for this identifier, if known . |
| Modifier | True |
| Summary | True |
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.identifier:recordIdentifier.type | |
| Short | Description of identifier |
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
| Cardinality | 0..0 |
| Type | CodeableConcept |
| Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| Summary | True |
| Requirements | Allows users to make use of identifiers when the identifier system is not known. |
| Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.identifier:recordIdentifier.system | |
| Short | The namespace for the identifier value |
| Definition | Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique. |
| Cardinality | 1..1 |
| Type | uri |
| Summary | True |
| Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. |
| Comments | Identifier.system is always case sensitive. |
| Constraints |
|
| Fixed Value | https://fhir.synapxe.sg/NamingSystem/record-id |
| Examples | Generalhttp://www.acme.com/identifiers/patient |
| Mappings |
|
| MedicationDispense.identifier:recordIdentifier.value | |
| Short | The value that is unique |
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
| Cardinality | 1..1 |
| Type | string |
| Summary | True |
| 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 http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. |
| Conditions | The cardinality or value of this element may be affected by these constraints: ident-1 |
| Constraints |
|
| Examples | General123456 |
| Mappings |
|
| MedicationDispense.identifier:recordIdentifier.period | |
| Short | Time period when id is/was valid for use |
| Definition | Time period during which identifier is/was valid for use. |
| Cardinality | 0..0 |
| Type | Period |
| Summary | True |
| Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.identifier:recordIdentifier.assigner | |
| Short | Organization that issued id (may be just text) |
| Definition | Organization that issued/manages the identifier. |
| Cardinality | 0..0 |
| Type | Reference(Organization) |
| Summary | True |
| Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.identifier:dispenseID | |
| Short | External identifier |
| Definition | Identifiers associated with this Medication Dispense that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server. |
| Cardinality | 1..1 |
| Type | Identifier |
| Comments | This is a business identifier, not a resource identifier. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.identifier:dispenseID.id | |
| Short | Unique id for inter-element referencing |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..0 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| MedicationDispense.identifier:dispenseID.extension | |
| Short | Additional content defined by implementations |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Cardinality | 0..0 |
| Type | Extension |
| Alias | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| MedicationDispense.identifier:dispenseID.use | |
| Short | usual | official | temp | secondary | old (If known) |
| Definition | The purpose of this identifier. |
| Cardinality | 0..0 |
| Type | code |
| Binding | Identifies the purpose for this identifier, if known . |
| Modifier | True |
| Summary | True |
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.identifier:dispenseID.type | |
| Short | Description of identifier |
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
| Cardinality | 0..0 |
| Type | CodeableConcept |
| Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| Summary | True |
| Requirements | Allows users to make use of identifiers when the identifier system is not known. |
| Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.identifier:dispenseID.system | |
| Short | The namespace for the identifier value |
| Definition | Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique. |
| Cardinality | 1..1 |
| Type | uri |
| Summary | True |
| Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. |
| Comments | Identifier.system is always case sensitive. |
| Constraints |
|
| Fixed Value | https://fhir.synapxe.sg/NamingSystem/dispense-id |
| Examples | Generalhttp://www.acme.com/identifiers/patient |
| Mappings |
|
| MedicationDispense.identifier:dispenseID.value | |
| Short | The value that is unique |
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
| Cardinality | 1..1 |
| Type | string |
| Summary | True |
| 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 http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. |
| Conditions | The cardinality or value of this element may be affected by these constraints: ident-1 |
| Constraints |
|
| Examples | General123456 |
| Mappings |
|
| MedicationDispense.identifier:dispenseID.period | |
| Short | Time period when id is/was valid for use |
| Definition | Time period during which identifier is/was valid for use. |
| Cardinality | 0..0 |
| Type | Period |
| Summary | True |
| Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.identifier:dispenseID.assigner | |
| Short | Organization that issued id (may be just text) |
| Definition | Organization that issued/manages the identifier. |
| Cardinality | 0..0 |
| Type | Reference(Organization) |
| Summary | True |
| Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.identifier:sourceGroupingID | |
| Short | External identifier |
| Definition | Identifiers associated with this Medication Dispense that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server. |
| Cardinality | 1..1 |
| Type | Identifier |
| Comments | This is a business identifier, not a resource identifier. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.identifier:sourceGroupingID.id | |
| Short | Unique id for inter-element referencing |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..0 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| MedicationDispense.identifier:sourceGroupingID.extension | |
| Short | Additional content defined by implementations |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Cardinality | 0..0 |
| Type | Extension |
| Alias | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| MedicationDispense.identifier:sourceGroupingID.use | |
| Short | usual | official | temp | secondary | old (If known) |
| Definition | The purpose of this identifier. |
| Cardinality | 0..0 |
| Type | code |
| Binding | Identifies the purpose for this identifier, if known . |
| Modifier | True |
| Summary | True |
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.identifier:sourceGroupingID.type | |
| Short | Description of identifier |
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
| Cardinality | 0..0 |
| Type | CodeableConcept |
| Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| Summary | True |
| Requirements | Allows users to make use of identifiers when the identifier system is not known. |
| Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.identifier:sourceGroupingID.system | |
| Short | The namespace for the identifier value |
| Definition | Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique. |
| Cardinality | 1..1 |
| Type | uri |
| Summary | True |
| Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. |
| Comments | Identifier.system is always case sensitive. |
| Constraints |
|
| Fixed Value | https://fhir.synapxe.sg/NamingSystem/source-grouping-id |
| Examples | Generalhttp://www.acme.com/identifiers/patient |
| Mappings |
|
| MedicationDispense.identifier:sourceGroupingID.value | |
| Short | The value that is unique |
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
| Cardinality | 1..1 |
| Type | string |
| Summary | True |
| 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 http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. |
| Conditions | The cardinality or value of this element may be affected by these constraints: ident-1 |
| Constraints |
|
| Examples | General123456 |
| Mappings |
|
| MedicationDispense.identifier:sourceGroupingID.period | |
| Short | Time period when id is/was valid for use |
| Definition | Time period during which identifier is/was valid for use. |
| Cardinality | 0..0 |
| Type | Period |
| Summary | True |
| Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.identifier:sourceGroupingID.assigner | |
| Short | Organization that issued id (may be just text) |
| Definition | Organization that issued/manages the identifier. |
| Cardinality | 0..0 |
| Type | Reference(Organization) |
| Summary | True |
| Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.basedOn | |
| Short | Plan that is fulfilled by this dispense |
| Definition | A plan that is fulfilled in whole or in part by this MedicationDispense. |
| Cardinality | 0..0 |
| Type | Reference(CarePlan) |
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.partOf | |
| Short | Event that dispense is part of |
| Definition | The procedure or medication administration that triggered the dispense. |
| Cardinality | 0..0 |
| Type | Reference(MedicationAdministration | Procedure) |
| Comments | While both a procedure and a medication administration may have triggered the dispense, but it is not expected that multiple procedures and/or multiple medication administrations would be triggers. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.status | |
| Short | preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown |
| Definition | A code specifying the state of the set of dispense events. |
| Cardinality | 1..1 |
| Type | code |
| Binding | Describes the lifecycle of the dispense. |
| Modifier | True |
| Summary | True |
| Comments | This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.notPerformedReason | |
| Short | Why a dispense was not performed |
| Definition | Indicates the reason why a dispense was not performed. |
| Cardinality | 0..1 |
| Type | CodeableReference(DetectedIssue) |
| Binding | |
| Constraints |
|
| Mappings |
|
| MedicationDispense.notPerformedReason.id | |
| Short | Unique id for inter-element referencing |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..0 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| MedicationDispense.notPerformedReason.extension | |
| Short | Additional content defined by implementations |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Cardinality | 0..0 |
| Type | Extension |
| Alias | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| MedicationDispense.notPerformedReason.concept | |
| Short | Concept - reference to a terminology or just text |
| Definition | A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. |
| Cardinality | 1..1 |
| Type | CodeableConcept |
| Binding | |
| Summary | True |
| Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.notPerformedReason.concept.id | |
| Short | Unique id for inter-element referencing |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..0 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| MedicationDispense.notPerformedReason.concept.extension | |
| Short | Additional content defined by implementations |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Cardinality | 0..0 |
| Type | Extension |
| Alias | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| MedicationDispense.notPerformedReason.concept.coding | |
| Short | Code defined by a terminology system |
| Definition | A reference to a code defined by a terminology system. |
| Cardinality | 1..* |
| Type | Coding |
| Summary | True |
| Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
| 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 labeled as UserSelected = true. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.notPerformedReason.concept.coding.id | |
| Short | Unique id for inter-element referencing |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..0 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| MedicationDispense.notPerformedReason.concept.coding.extension | |
| Short | Additional content defined by implementations |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Cardinality | 0..0 |
| Type | Extension |
| Alias | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| MedicationDispense.notPerformedReason.concept.coding.system | |
| Short | Identity of the terminology system |
| Definition | The identification of the code system that defines the meaning of the symbol in the code. |
| Cardinality | 1..1 |
| Type | uri |
| Summary | True |
| Requirements | Need to be unambiguous about the source of the definition of the symbol. |
| Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously. |
| Constraints |
|
| Fixed Value | https://fhir.synapxe.sg/CodeSystem/status-reason |
| Mappings |
|
| MedicationDispense.notPerformedReason.concept.coding.version | |
| Short | Version of the system - if relevant |
| Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
| Cardinality | 0..0 |
| Type | string |
| Summary | True |
| Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.notPerformedReason.concept.coding.code | |
| Short | Symbol in syntax defined by the system |
| 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). |
| Cardinality | 1..1 |
| Type | code |
| Summary | True |
| Requirements | Need to refer to a particular code in the system. |
| Comments | Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size |
| Conditions | The cardinality or value of this element may be affected by these constraints: cod-1 |
| Constraints |
|
| Mappings |
|
| MedicationDispense.notPerformedReason.concept.coding.display | |
| Short | Representation defined by the system |
| Definition | A representation of the meaning of the code in the system, following the rules of the system. |
| Cardinality | 1..1 |
| Type | string |
| Summary | True |
| Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
| Comments | Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size |
| Conditions | The cardinality or value of this element may be affected by these constraints: cod-1 |
| Constraints |
|
| Mappings |
|
| MedicationDispense.notPerformedReason.concept.coding.userSelected | |
| Short | If this coding was chosen directly by the user |
| Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
| Cardinality | 0..0 |
| Type | boolean |
| Summary | True |
| Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
| Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.notPerformedReason.concept.text | |
| Short | Plain text representation of the concept |
| Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
| Cardinality | 0..0 |
| Type | string |
| Summary | True |
| Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
| Comments | Very often the text is the same as a displayName of one of the codings. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.notPerformedReason.reference | |
| Short | Reference to a resource (by instance) |
| Definition | A reference to a resource the provides exact details about the information being referenced. |
| Cardinality | 0..0 |
| Type | Reference |
| Summary | True |
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.statusChanged | |
| Short | When the status changed |
| Definition | The date (and maybe time) when the status of the dispense record changed. |
| Cardinality | 0..0 |
| Type | dateTime |
| Comments | UTC offset is allowed for dates and partial dates |
| Constraints |
|
| Mappings |
|
| MedicationDispense.category | |
| Short | Concept - reference to a terminology or just text |
| Definition | A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. |
| Cardinality | 0..1 |
| Type | CodeableConcept |
| Binding | A code describing where the dispensed medication is expected to be consumed or administered. |
| Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.category.id | |
| Short | Unique id for inter-element referencing |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..0 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| MedicationDispense.category.extension | |
| Short | Additional content defined by implementations |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Cardinality | 0..0 |
| Type | Extension |
| Alias | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| MedicationDispense.category.coding | |
| Short | Code defined by a terminology system |
| Definition | A reference to a code defined by a terminology system. |
| Cardinality | 1..* |
| Type | Coding |
| Summary | True |
| Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
| 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 labeled as UserSelected = true. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.category.coding.id | |
| Short | Unique id for inter-element referencing |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..0 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| MedicationDispense.category.coding.extension | |
| Short | Additional content defined by implementations |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Cardinality | 0..0 |
| Type | Extension |
| Alias | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| MedicationDispense.category.coding.system | |
| Short | Identity of the terminology system |
| Definition | The identification of the code system that defines the meaning of the symbol in the code. |
| Cardinality | 1..1 |
| Type | uri |
| Summary | True |
| Requirements | Need to be unambiguous about the source of the definition of the symbol. |
| Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously. |
| Constraints |
|
| Fixed Value | https://fhir.synapxe.sg/CodeSystem/dispense-type |
| Mappings |
|
| MedicationDispense.category.coding.version | |
| Short | Version of the system - if relevant |
| Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
| Cardinality | 0..1 |
| Type | string |
| Summary | True |
| Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.category.coding.code | |
| Short | Symbol in syntax defined by the system |
| 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). |
| Cardinality | 1..1 |
| Type | code |
| Summary | True |
| Requirements | Need to refer to a particular code in the system. |
| Comments | Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size |
| Conditions | The cardinality or value of this element may be affected by these constraints: cod-1 |
| Constraints |
|
| Mappings |
|
| MedicationDispense.category.coding.display | |
| Short | Representation defined by the system |
| Definition | A representation of the meaning of the code in the system, following the rules of the system. |
| Cardinality | 1..1 |
| Type | string |
| Summary | True |
| Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
| Comments | Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size |
| Conditions | The cardinality or value of this element may be affected by these constraints: cod-1 |
| Constraints |
|
| Mappings |
|
| MedicationDispense.category.coding.userSelected | |
| Short | If this coding was chosen directly by the user |
| Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
| Cardinality | 0..0 |
| Type | boolean |
| Summary | True |
| Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
| Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.category.text | |
| Short | Plain text representation of the concept |
| Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
| Cardinality | 0..0 |
| Type | string |
| Summary | True |
| Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
| Comments | Very often the text is the same as a displayName of one of the codings. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.medication | |
| Short | What medication was supplied |
| Definition | Identifies the medication supplied. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications. |
| Cardinality | 1..1 |
| Type | CodeableReference(Medication) |
| Binding | A coded concept identifying which substance or product can be dispensed. |
| Summary | True |
| 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. For example, if you require form or lot number, then you must reference the Medication resource. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.medication.id | |
| Short | Unique id for inter-element referencing |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..0 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| MedicationDispense.medication.extension | |
| Short | Additional content defined by implementations |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Cardinality | 0..0 |
| Type | Extension |
| Alias | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| MedicationDispense.medication.concept | |
| Short | Concept - reference to a terminology or just text |
| Definition | A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. |
| Cardinality | 0..0 |
| Type | CodeableConcept |
| Summary | True |
| Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.medication.concept.id | |
| Short | Unique id for inter-element referencing |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..0 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| MedicationDispense.medication.concept.extension | |
| Short | Additional content defined by implementations |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Cardinality | 0..0 |
| Type | Extension |
| Alias | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| MedicationDispense.medication.concept.coding | |
| Short | Code defined by a terminology system |
| Definition | A reference to a code defined by a terminology system. |
| Cardinality | 1..* |
| Type | Coding |
| Summary | True |
| Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
| 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 labeled as UserSelected = true. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.medication.concept.coding.id | |
| Short | Unique id for inter-element referencing |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..0 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| MedicationDispense.medication.concept.coding.extension | |
| Short | Additional content defined by implementations |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Cardinality | 0..0 |
| Type | Extension |
| Alias | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| MedicationDispense.medication.concept.coding.system | |
| Short | Identity of the terminology system |
| Definition | The identification of the code system that defines the meaning of the symbol in the code. |
| Cardinality | 1..1 |
| Type | uri |
| Summary | True |
| Requirements | Need to be unambiguous about the source of the definition of the symbol. |
| Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.medication.concept.coding.version | |
| Short | Version of the system - if relevant |
| Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
| Cardinality | 0..1 |
| Type | string |
| Summary | True |
| Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.medication.concept.coding.code | |
| Short | Symbol in syntax defined by the system |
| 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). |
| Cardinality | 1..1 |
| Type | code |
| Summary | True |
| Requirements | Need to refer to a particular code in the system. |
| Comments | Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size |
| Conditions | The cardinality or value of this element may be affected by these constraints: cod-1 |
| Constraints |
|
| Mappings |
|
| MedicationDispense.medication.concept.coding.display | |
| Short | Representation defined by the system |
| Definition | A representation of the meaning of the code in the system, following the rules of the system. |
| Cardinality | 1..1 |
| Type | string |
| Summary | True |
| Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
| Comments | Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size |
| Conditions | The cardinality or value of this element may be affected by these constraints: cod-1 |
| Constraints |
|
| Mappings |
|
| MedicationDispense.medication.concept.coding.userSelected | |
| Short | If this coding was chosen directly by the user |
| Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
| Cardinality | 0..0 |
| Type | boolean |
| Summary | True |
| Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
| Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.medication.concept.text | |
| Short | Plain text representation of the concept |
| Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
| Cardinality | 0..0 |
| Type | string |
| Summary | True |
| Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
| Comments | Very often the text is the same as a displayName of one of the codings. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.medication.reference | |
| Short | Reference to a resource (by instance) |
| Definition | A reference to a resource the provides exact details about the information being referenced. |
| Cardinality | 1..1 |
| Type | Reference |
| Summary | True |
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.medication.reference.id | |
| Short | Unique id for inter-element referencing |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..0 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| MedicationDispense.medication.reference.extension | |
| Short | Additional content defined by implementations |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Cardinality | 0..0 |
| Type | Extension |
| Alias | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| MedicationDispense.medication.reference.reference | |
| Short | Literal reference, Relative, internal or absolute URL |
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
| Cardinality | 0..1 |
| Type | string |
| Summary | True |
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
| Conditions | The cardinality or value of this element may be affected by these constraints: ref-2, ref-1 |
| Constraints |
|
| Mappings |
|
| MedicationDispense.medication.reference.type | |
| Short | Type the reference refers to (e.g. "Patient") - must be a resource in resources |
| Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). |
| Cardinality | 0..1 |
| Type | uri |
| Binding | Aa resource (or, for logical models, the URI of the logical model). |
| Summary | True |
| Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.medication.reference.identifier | |
| Short | Logical reference, when literal reference is not known |
| Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. |
| Cardinality | 0..1 |
| Type | Identifier |
| Summary | True |
| Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). This element only allows for a single identifier. In the case where additional identifers are required, use the http://hl7.org/fhir/StructureDefinition/additionalIdentifier extension. |
| Conditions | The cardinality or value of this element may be affected by these constraints: ref-2 |
| Constraints |
|
| Mappings |
|
| MedicationDispense.medication.reference.display | |
| Short | Text alternative for the resource |
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
| Cardinality | 0..1 |
| Type | string |
| Summary | True |
| Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. |
| Conditions | The cardinality or value of this element may be affected by these constraints: ref-2 |
| Constraints |
|
| Mappings |
|
| MedicationDispense.subject | |
| Short | A reference from one resource to another |
| Definition | A reference from one resource to another. |
| Cardinality | 1..1 |
| Type | Reference(Patient) |
| Summary | True |
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.subject.id | |
| Short | Unique id for inter-element referencing |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..0 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| MedicationDispense.subject.extension | |
| Short | Additional content defined by implementations |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Cardinality | 0..0 |
| Type | Extension |
| Alias | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| MedicationDispense.subject.reference | |
| Short | Literal reference, Relative, internal or absolute URL |
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
| Cardinality | 0..0 |
| Type | string |
| Summary | True |
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
| Conditions | The cardinality or value of this element may be affected by these constraints: ref-2, ref-1 |
| Constraints |
|
| Mappings |
|
| MedicationDispense.subject.type | |
| Short | Type the reference refers to (e.g. "Patient") - must be a resource in resources |
| Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). |
| Cardinality | 1..1 |
| Type | uri |
| Binding | Aa resource (or, for logical models, the URI of the logical model). |
| Summary | True |
| Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference. |
| Constraints |
|
| Fixed Value | Patient |
| Mappings |
|
| MedicationDispense.subject.identifier | |
| Short | An identifier intended for computation |
| Definition | An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. |
| Cardinality | 1..1 |
| Type | Identifier |
| Summary | True |
| Comments | The rules of the identifier.type determine if a check digit is part of the ID value or sent separately, such as through the checkDigit extension. |
| Conditions | The cardinality or value of this element may be affected by these constraints: ref-2 |
| Constraints |
|
| Mappings |
|
| MedicationDispense.subject.identifier.id | |
| Short | Unique id for inter-element referencing |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..0 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| MedicationDispense.subject.identifier.extension | |
| Short | Additional content defined by implementations |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Cardinality | 0..0 |
| Type | Extension |
| Alias | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| MedicationDispense.subject.identifier.use | |
| Short | usual | official | temp | secondary | old (If known) |
| Definition | The purpose of this identifier. |
| Cardinality | 0..0 |
| Type | code |
| Binding | Identifies the purpose for this identifier, if known . |
| Modifier | True |
| Summary | True |
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.subject.identifier.type | |
| Short | Description of identifier |
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
| Cardinality | 0..0 |
| Type | CodeableConcept |
| Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| Summary | True |
| Requirements | Allows users to make use of identifiers when the identifier system is not known. |
| Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.subject.identifier.system | |
| Short | The namespace for the identifier value |
| Definition | Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique. |
| Cardinality | 1..1 |
| Type | uri |
| Summary | True |
| Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. |
| Comments | Identifier.system is always case sensitive. |
| Constraints |
|
| Fixed Value | https://fhir.synapxe.sg/NamingSystem/nric |
| Examples | Generalhttp://www.acme.com/identifiers/patient |
| Mappings |
|
| MedicationDispense.subject.identifier.value | |
| Short | The value that is unique |
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
| Cardinality | 1..1 |
| Type | string |
| Summary | True |
| 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 http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. |
| Conditions | The cardinality or value of this element may be affected by these constraints: ident-1 |
| Constraints |
|
| Examples | General123456 |
| Mappings |
|
| MedicationDispense.subject.identifier.period | |
| Short | Time period when id is/was valid for use |
| Definition | Time period during which identifier is/was valid for use. |
| Cardinality | 0..0 |
| Type | Period |
| Summary | True |
| Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.subject.identifier.assigner | |
| Short | Organization that issued id (may be just text) |
| Definition | Organization that issued/manages the identifier. |
| Cardinality | 0..0 |
| Type | Reference(Organization) |
| Summary | True |
| Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.subject.display | |
| Short | Text alternative for the resource |
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
| Cardinality | 0..0 |
| Type | string |
| Summary | True |
| Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. |
| Conditions | The cardinality or value of this element may be affected by these constraints: ref-2 |
| Constraints |
|
| Mappings |
|
| MedicationDispense.encounter | |
| Short | A reference from one resource to another |
| Definition | A reference from one resource to another. |
| Cardinality | 0..1 |
| Type | Reference(Encounter) |
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.encounter.id | |
| Short | Unique id for inter-element referencing |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..0 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| MedicationDispense.encounter.extension | |
| Short | Additional content defined by implementations |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Cardinality | 0..0 |
| Type | Extension |
| Alias | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| MedicationDispense.encounter.reference | |
| Short | Literal reference, Relative, internal or absolute URL |
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
| Cardinality | 0..0 |
| Type | string |
| Summary | True |
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
| Conditions | The cardinality or value of this element may be affected by these constraints: ref-2, ref-1 |
| Constraints |
|
| Mappings |
|
| MedicationDispense.encounter.type | |
| Short | Type the reference refers to (e.g. "Patient") - must be a resource in resources |
| Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). |
| Cardinality | 1..1 |
| Type | uri |
| Binding | Aa resource (or, for logical models, the URI of the logical model). |
| Summary | True |
| Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference. |
| Constraints |
|
| Fixed Value | Encounter |
| Mappings |
|
| MedicationDispense.encounter.identifier | |
| Short | An identifier intended for computation |
| Definition | An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. |
| Cardinality | 1..1 |
| Type | Identifier |
| Summary | True |
| Comments | The rules of the identifier.type determine if a check digit is part of the ID value or sent separately, such as through the checkDigit extension. |
| Conditions | The cardinality or value of this element may be affected by these constraints: ref-2 |
| Constraints |
|
| Mappings |
|
| MedicationDispense.encounter.identifier.id | |
| Short | Unique id for inter-element referencing |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..0 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| MedicationDispense.encounter.identifier.extension | |
| Short | Additional content defined by implementations |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Cardinality | 0..0 |
| Type | Extension |
| Alias | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| MedicationDispense.encounter.identifier.use | |
| Short | usual | official | temp | secondary | old (If known) |
| Definition | The purpose of this identifier. |
| Cardinality | 0..0 |
| Type | code |
| Binding | Identifies the purpose for this identifier, if known . |
| Modifier | True |
| Summary | True |
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.encounter.identifier.type | |
| Short | Description of identifier |
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
| Cardinality | 0..0 |
| Type | CodeableConcept |
| Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| Summary | True |
| Requirements | Allows users to make use of identifiers when the identifier system is not known. |
| Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.encounter.identifier.system | |
| Short | The namespace for the identifier value |
| Definition | Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique. |
| Cardinality | 1..1 |
| Type | uri |
| Summary | True |
| Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. |
| Comments | Identifier.system is always case sensitive. |
| Constraints |
|
| Fixed Value | https://fhir.synapxe.sg/NamingSystem/event-id |
| Examples | Generalhttp://www.acme.com/identifiers/patient |
| Mappings |
|
| MedicationDispense.encounter.identifier.value | |
| Short | The value that is unique |
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
| Cardinality | 1..1 |
| Type | string |
| Summary | True |
| 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 http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. |
| Conditions | The cardinality or value of this element may be affected by these constraints: ident-1 |
| Constraints |
|
| Examples | General123456 |
| Mappings |
|
| MedicationDispense.encounter.identifier.period | |
| Short | Time period when id is/was valid for use |
| Definition | Time period during which identifier is/was valid for use. |
| Cardinality | 0..0 |
| Type | Period |
| Summary | True |
| Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.encounter.identifier.assigner | |
| Short | Organization that issued id (may be just text) |
| Definition | Organization that issued/manages the identifier. |
| Cardinality | 0..0 |
| Type | Reference(Organization) |
| Summary | True |
| Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.encounter.display | |
| Short | Text alternative for the resource |
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
| Cardinality | 0..0 |
| Type | string |
| Summary | True |
| Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. |
| Conditions | The cardinality or value of this element may be affected by these constraints: ref-2 |
| Constraints |
|
| Mappings |
|
| MedicationDispense.supportingInformation | |
| Short | Information that supports the dispensing of the medication |
| Definition | Additional information that supports the medication being dispensed. For example, there may be requirements that a specific lab test has been completed prior to dispensing or the patient's weight at the time of dispensing is documented. |
| Cardinality | 0..0 |
| Type | Reference(Resource) |
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.performer | |
| Short | Who performed event |
| Definition | Indicates who or what performed the event. |
| Cardinality | 1..1 |
| Type | BackboneElement |
| Constraints |
|
| Mappings |
|
| MedicationDispense.performer.id | |
| Short | Unique id for inter-element referencing |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..0 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| MedicationDispense.performer.extension | |
| Short | Additional content defined by implementations |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Cardinality | 0..0 |
| Type | Extension |
| Alias | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| MedicationDispense.performer.modifierExtension | |
| Short | Extensions that cannot be ignored even if unrecognized |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Cardinality | 0..0 |
| Type | Extension |
| Modifier | True |
| Summary | True |
| Alias | extensions, user content, modifiers |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.performer.function | |
| Short | Who performed the dispense and what they did |
| Definition | Distinguishes the type of performer in the dispense. For example, date enterer, packager, final checker. |
| Cardinality | 0..0 |
| Type | CodeableConcept |
| Binding | A code describing the role an individual played in dispensing a medication. |
| Requirements | Allows disambiguation of the types of involvement of different performers. |
| Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.performer.actor | |
| Short | A reference from one resource to another |
| Definition | A reference from one resource to another. |
| Cardinality | 1..1 |
| Type | Reference(Practitioner) |
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.performer.actor.id | |
| Short | Unique id for inter-element referencing |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..1 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| MedicationDispense.performer.actor.extension | |
| Short | Additional content defined by implementations |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Cardinality | 0..* |
| Type | Extension |
| Alias | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| MedicationDispense.performer.actor.reference | |
| Short | Literal reference, Relative, internal or absolute URL |
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
| Cardinality | 0..1 |
| Type | string |
| Summary | True |
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
| Conditions | The cardinality or value of this element may be affected by these constraints: ref-2, ref-1 |
| Constraints |
|
| Mappings |
|
| MedicationDispense.performer.actor.type | |
| Short | Type the reference refers to (e.g. "Patient") - must be a resource in resources |
| Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). |
| Cardinality | 0..1 |
| Type | uri |
| Binding | Aa resource (or, for logical models, the URI of the logical model). |
| Summary | True |
| Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.performer.actor.identifier | |
| Short | Logical reference, when literal reference is not known |
| Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. |
| Cardinality | 0..1 |
| Type | Identifier |
| Summary | True |
| Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). This element only allows for a single identifier. In the case where additional identifers are required, use the http://hl7.org/fhir/StructureDefinition/additionalIdentifier extension. |
| Conditions | The cardinality or value of this element may be affected by these constraints: ref-2 |
| Constraints |
|
| Mappings |
|
| MedicationDispense.performer.actor.identifier.id | |
| Short | Unique id for inter-element referencing |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..1 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| MedicationDispense.performer.actor.identifier.extension | |
| Short | Additional content defined by implementations |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Cardinality | 0..* |
| Type | Extension |
| Alias | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| MedicationDispense.performer.actor.identifier.use | |
| Short | usual | official | temp | secondary | old (If known) |
| Definition | The purpose of this identifier. |
| Cardinality | 0..1 |
| Type | code |
| Binding | Identifies the purpose for this identifier, if known . |
| Modifier | True |
| Summary | True |
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.performer.actor.identifier.type | |
| Short | Description of identifier |
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
| Cardinality | 0..1 |
| Type | CodeableConcept |
| Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| Summary | True |
| Requirements | Allows users to make use of identifiers when the identifier system is not known. |
| Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.performer.actor.identifier.system | |
| Short | The namespace for the identifier value |
| Definition | Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique. |
| Cardinality | 0..1 |
| Type | uri |
| Summary | True |
| Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. |
| Comments | Identifier.system is always case sensitive. |
| Constraints |
|
| Fixed Value | https://fhir.synapxe.sg/NamingSystem/prn |
| Examples | Generalhttp://www.acme.com/identifiers/patient |
| Mappings |
|
| MedicationDispense.performer.actor.identifier.value | |
| Short | The value that is unique |
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
| Cardinality | 0..1 |
| Type | string |
| Summary | True |
| 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 http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. |
| Conditions | The cardinality or value of this element may be affected by these constraints: ident-1 |
| Constraints |
|
| Examples | General123456 |
| Mappings |
|
| MedicationDispense.performer.actor.identifier.period | |
| Short | Time period when id is/was valid for use |
| Definition | Time period during which identifier is/was valid for use. |
| Cardinality | 0..1 |
| Type | Period |
| Summary | True |
| Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.performer.actor.identifier.assigner | |
| Short | Organization that issued id (may be just text) |
| Definition | Organization that issued/manages the identifier. |
| Cardinality | 0..1 |
| Type | Reference(Organization) |
| Summary | True |
| Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.performer.actor.display | |
| Short | Text alternative for the resource |
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
| Cardinality | 0..0 |
| Type | string |
| Summary | True |
| Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. |
| Conditions | The cardinality or value of this element may be affected by these constraints: ref-2 |
| Constraints |
|
| Mappings |
|
| MedicationDispense.location | |
| Short | Where the dispense occurred |
| Definition | The principal physical location where the dispense was performed. |
| Cardinality | 0..1 |
| Type | Reference(Location) |
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.location.id | |
| Short | Unique id for inter-element referencing |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..0 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| MedicationDispense.location.extension | |
| Short | Additional content defined by implementations |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Cardinality | 0..0 |
| Type | Extension |
| Alias | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| MedicationDispense.location.reference | |
| Short | Literal reference, Relative, internal or absolute URL |
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
| Cardinality | 0..0 |
| Type | string |
| Summary | True |
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
| Conditions | The cardinality or value of this element may be affected by these constraints: ref-2, ref-1 |
| Constraints |
|
| Mappings |
|
| MedicationDispense.location.type | |
| Short | Type the reference refers to (e.g. "Patient") - must be a resource in resources |
| Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). |
| Cardinality | 1..1 |
| Type | uri |
| Binding | Aa resource (or, for logical models, the URI of the logical model). |
| Summary | True |
| Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference. |
| Constraints |
|
| Fixed Value | Location |
| Mappings |
|
| MedicationDispense.location.identifier | |
| Short | Logical reference, when literal reference is not known |
| Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. |
| Cardinality | 1..1 |
| Type | Identifier |
| Summary | True |
| Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). This element only allows for a single identifier. In the case where additional identifers are required, use the http://hl7.org/fhir/StructureDefinition/additionalIdentifier extension. |
| Conditions | The cardinality or value of this element may be affected by these constraints: ref-2 |
| Constraints |
|
| Mappings |
|
| MedicationDispense.location.identifier.id | |
| Short | Unique id for inter-element referencing |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..0 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| MedicationDispense.location.identifier.extension | |
| Short | Additional content defined by implementations |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Cardinality | 0..0 |
| Type | Extension |
| Alias | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| MedicationDispense.location.identifier.use | |
| Short | usual | official | temp | secondary | old (If known) |
| Definition | The purpose of this identifier. |
| Cardinality | 0..0 |
| Type | code |
| Binding | Identifies the purpose for this identifier, if known . |
| Modifier | True |
| Summary | True |
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.location.identifier.type | |
| Short | Description of identifier |
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
| Cardinality | 0..0 |
| Type | CodeableConcept |
| Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| Summary | True |
| Requirements | Allows users to make use of identifiers when the identifier system is not known. |
| Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.location.identifier.system | |
| Short | The namespace for the identifier value |
| Definition | Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique. |
| Cardinality | 1..1 |
| Type | uri |
| Summary | True |
| Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. |
| Comments | Identifier.system is always case sensitive. |
| Constraints |
|
| Fixed Value | https://fhir.synapxe.sg/NamingSystem/dispensing-location-id |
| Examples | Generalhttp://www.acme.com/identifiers/patient |
| Mappings |
|
| MedicationDispense.location.identifier.value | |
| Short | The value that is unique |
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
| Cardinality | 1..1 |
| Type | string |
| Summary | True |
| 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 http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. |
| Conditions | The cardinality or value of this element may be affected by these constraints: ident-1 |
| Constraints |
|
| Examples | General123456 |
| Mappings |
|
| MedicationDispense.location.identifier.period | |
| Short | Time period when id is/was valid for use |
| Definition | Time period during which identifier is/was valid for use. |
| Cardinality | 0..0 |
| Type | Period |
| Summary | True |
| Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.location.identifier.assigner | |
| Short | Organization that issued id (may be just text) |
| Definition | Organization that issued/manages the identifier. |
| Cardinality | 0..0 |
| Type | Reference(Organization) |
| Summary | True |
| Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.location.display | |
| Short | Text alternative for the resource |
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
| Cardinality | 0..0 |
| Type | string |
| Summary | True |
| Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. |
| Conditions | The cardinality or value of this element may be affected by these constraints: ref-2 |
| Constraints |
|
| Mappings |
|
| MedicationDispense.authorizingPrescription | |
| Short | Medication order that authorizes the dispense |
| Definition | Indicates the medication order that is being dispensed against. |
| Cardinality | 1..1 |
| Type | Reference(MedicationRequest) |
| Comments | Maps to basedOn in Event logical model. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.authorizingPrescription.id | |
| Short | Unique id for inter-element referencing |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..0 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| MedicationDispense.authorizingPrescription.extension | |
| Short | Additional content defined by implementations |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Cardinality | 0..0 |
| Type | Extension |
| Alias | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| MedicationDispense.authorizingPrescription.reference | |
| Short | Literal reference, Relative, internal or absolute URL |
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
| Cardinality | 0..0 |
| Type | string |
| Summary | True |
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
| Conditions | The cardinality or value of this element may be affected by these constraints: ref-2, ref-1 |
| Constraints |
|
| Mappings |
|
| MedicationDispense.authorizingPrescription.type | |
| Short | Type the reference refers to (e.g. "Patient") - must be a resource in resources |
| Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). |
| Cardinality | 1..1 |
| Type | uri |
| Binding | Aa resource (or, for logical models, the URI of the logical model). |
| Summary | True |
| Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference. |
| Constraints |
|
| Fixed Value | MedicationRequest |
| Mappings |
|
| MedicationDispense.authorizingPrescription.identifier | |
| Short | Logical reference, when literal reference is not known |
| Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. |
| Cardinality | 1..1 |
| Type | Identifier |
| Summary | True |
| Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). This element only allows for a single identifier. In the case where additional identifers are required, use the http://hl7.org/fhir/StructureDefinition/additionalIdentifier extension. |
| Conditions | The cardinality or value of this element may be affected by these constraints: ref-2 |
| Constraints |
|
| Mappings |
|
| MedicationDispense.authorizingPrescription.identifier.id | |
| Short | Unique id for inter-element referencing |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..0 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| MedicationDispense.authorizingPrescription.identifier.extension | |
| Short | Additional content defined by implementations |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Cardinality | 0..0 |
| Type | Extension |
| Alias | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| MedicationDispense.authorizingPrescription.identifier.use | |
| Short | usual | official | temp | secondary | old (If known) |
| Definition | The purpose of this identifier. |
| Cardinality | 0..0 |
| Type | code |
| Binding | Identifies the purpose for this identifier, if known . |
| Modifier | True |
| Summary | True |
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.authorizingPrescription.identifier.type | |
| Short | Description of identifier |
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
| Cardinality | 0..0 |
| Type | CodeableConcept |
| Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| Summary | True |
| Requirements | Allows users to make use of identifiers when the identifier system is not known. |
| Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.authorizingPrescription.identifier.system | |
| Short | The namespace for the identifier value |
| Definition | Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique. |
| Cardinality | 1..1 |
| Type | uri |
| Summary | True |
| Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. |
| Comments | Identifier.system is always case sensitive. |
| Constraints |
|
| Fixed Value | https://fhir.synapxe.sg/NamingSystem/order-no |
| Examples | Generalhttp://www.acme.com/identifiers/patient |
| Mappings |
|
| MedicationDispense.authorizingPrescription.identifier.value | |
| Short | The value that is unique |
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
| Cardinality | 1..1 |
| Type | string |
| Summary | True |
| 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 http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. |
| Conditions | The cardinality or value of this element may be affected by these constraints: ident-1 |
| Constraints |
|
| Examples | General123456 |
| Mappings |
|
| MedicationDispense.authorizingPrescription.identifier.period | |
| Short | Time period when id is/was valid for use |
| Definition | Time period during which identifier is/was valid for use. |
| Cardinality | 0..0 |
| Type | Period |
| Summary | True |
| Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.authorizingPrescription.identifier.assigner | |
| Short | Organization that issued id (may be just text) |
| Definition | Organization that issued/manages the identifier. |
| Cardinality | 0..0 |
| Type | Reference(Organization) |
| Summary | True |
| Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.authorizingPrescription.display | |
| Short | Text alternative for the resource |
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
| Cardinality | 0..0 |
| Type | string |
| Summary | True |
| Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. |
| Conditions | The cardinality or value of this element may be affected by these constraints: ref-2 |
| Constraints |
|
| Mappings |
|
| MedicationDispense.type | |
| Short | Trial fill, partial fill, emergency fill, etc |
| Definition | Indicates the type of dispensing event that is performed. For example, Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc. |
| Cardinality | 0..0 |
| Type | CodeableConcept |
| Binding | ActPharmacySupplyType http://terminology.hl7.org/ValueSet/v3-ActPharmacySupplyType (example) |
| Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.type.id | |
| Short | Unique id for inter-element referencing |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..0 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| MedicationDispense.type.extension | |
| Short | Additional content defined by implementations |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Cardinality | 0..0 |
| Type | Extension |
| Alias | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| MedicationDispense.type.coding | |
| Short | Code defined by a terminology system |
| Definition | A reference to a code defined by a terminology system. |
| Cardinality | 0..1 |
| Type | Coding |
| Summary | True |
| Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
| 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 labeled as UserSelected = true. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.type.coding.id | |
| Short | Unique id for inter-element referencing |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..0 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| MedicationDispense.type.coding.extension | |
| Short | Additional content defined by implementations |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Cardinality | 0..0 |
| Type | Extension |
| Alias | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| MedicationDispense.type.coding.system | |
| Short | Identity of the terminology system |
| Definition | The identification of the code system that defines the meaning of the symbol in the code. |
| Cardinality | 1..1 |
| Type | uri |
| Summary | True |
| Requirements | Need to be unambiguous about the source of the definition of the symbol. |
| Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.type.coding.version | |
| Short | Version of the system - if relevant |
| Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
| Cardinality | 0..0 |
| Type | string |
| Summary | True |
| Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.type.coding.code | |
| Short | Symbol in syntax defined by the system |
| 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). |
| Cardinality | 1..1 |
| Type | code |
| Summary | True |
| Requirements | Need to refer to a particular code in the system. |
| Comments | Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size |
| Conditions | The cardinality or value of this element may be affected by these constraints: cod-1 |
| Constraints |
|
| Mappings |
|
| MedicationDispense.type.coding.display | |
| Short | Representation defined by the system |
| Definition | A representation of the meaning of the code in the system, following the rules of the system. |
| Cardinality | 0..0 |
| Type | string |
| Summary | True |
| Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
| Comments | Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size |
| Conditions | The cardinality or value of this element may be affected by these constraints: cod-1 |
| Constraints |
|
| Mappings |
|
| MedicationDispense.type.coding.userSelected | |
| Short | If this coding was chosen directly by the user |
| Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
| Cardinality | 0..0 |
| Type | boolean |
| Summary | True |
| Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
| Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.type.text | |
| Short | Plain text representation of the concept |
| Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
| Cardinality | 0..0 |
| Type | string |
| Summary | True |
| Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
| Comments | Very often the text is the same as a displayName of one of the codings. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.quantity | |
| Short | Amount dispensed |
| Definition | The amount of medication that has been dispensed. Includes unit of measure. |
| Cardinality | 0..1 |
| Type | SimpleQuantity |
| Comments | The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.quantity.id | |
| Short | Unique id for inter-element referencing |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..0 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| MedicationDispense.quantity.extension | |
| Short | Additional content defined by implementations |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Cardinality | 0..0 |
| Type | Extension |
| Alias | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| MedicationDispense.quantity.value | |
| Short | Numerical value (with implicit precision) |
| Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value. |
| Cardinality | 1..1 |
| Type | decimal |
| Summary | True |
| Requirements | Precision is handled implicitly in almost all cases of measurement. |
| Comments | The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books). |
| Constraints |
|
| Mappings |
|
| MedicationDispense.quantity.comparator | |
| Short | < | <= | >= | > | ad - how to understand the value |
| Definition | Not allowed to be used in this context |
| Cardinality | 0..0 |
| Type | code |
| Binding | How the Quantity should be understood and represented. |
| Modifier | True |
| Summary | True |
| Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. |
| Comments | Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size |
| Meaning when missing | If there is no comparator, then there is no modification of the value |
| Constraints |
|
| Mappings |
|
| MedicationDispense.quantity.unit | |
| Short | Unit representation |
| Definition | A human-readable form of the unit. |
| Cardinality | 1..1 |
| Type | string |
| Summary | True |
| Requirements | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. |
| Comments | Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size |
| Constraints |
|
| Mappings |
|
| MedicationDispense.quantity.system | |
| Short | System that defines coded unit form |
| Definition | The identification of the system that provides the coded form of the unit. |
| Cardinality | 1..1 |
| Type | uri |
| Summary | True |
| Requirements | Need to know the system that defines the coded form of the unit. |
| Comments | see http://en.wikipedia.org/wiki/Uniform_resource_identifier |
| Conditions | The cardinality or value of this element may be affected by these constraints: qty-3 |
| Constraints |
|
| Mappings |
|
| MedicationDispense.quantity.code | |
| Short | Coded form of the unit |
| Definition | A computer processable form of the unit in some unit representation system. |
| Cardinality | 1..1 |
| Type | code |
| Summary | True |
| Requirements | Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest. |
| Comments | The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system. |
| Conditions | The cardinality or value of this element may be affected by these constraints: qty-3 |
| Constraints |
|
| Mappings |
|
| MedicationDispense.daysSupply | |
| Short | Amount of medication expressed as a timing amount |
| Definition | The amount of medication expressed as a timing amount. |
| Cardinality | 0..0 |
| Type | SimpleQuantity |
| Comments | The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.daysSupply.id | |
| Short | Unique id for inter-element referencing |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..0 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| MedicationDispense.daysSupply.extension | |
| Short | Additional content defined by implementations |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Cardinality | 0..0 |
| Type | Extension |
| Alias | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| MedicationDispense.daysSupply.value | |
| Short | Numerical value (with implicit precision) |
| Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value. |
| Cardinality | 1..1 |
| Type | decimal |
| Summary | True |
| Requirements | Precision is handled implicitly in almost all cases of measurement. |
| Comments | The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books). |
| Constraints |
|
| Mappings |
|
| MedicationDispense.daysSupply.comparator | |
| Short | < | <= | >= | > | ad - how to understand the value |
| Definition | Not allowed to be used in this context |
| Cardinality | 0..0 |
| Type | code |
| Binding | How the Quantity should be understood and represented. |
| Modifier | True |
| Summary | True |
| Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. |
| Comments | Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size |
| Meaning when missing | If there is no comparator, then there is no modification of the value |
| Constraints |
|
| Mappings |
|
| MedicationDispense.daysSupply.unit | |
| Short | Unit representation |
| Definition | A human-readable form of the unit. |
| Cardinality | 1..1 |
| Type | string |
| Summary | True |
| Requirements | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. |
| Comments | Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size |
| Constraints |
|
| Mappings |
|
| MedicationDispense.daysSupply.system | |
| Short | System that defines coded unit form |
| Definition | The identification of the system that provides the coded form of the unit. |
| Cardinality | 1..1 |
| Type | uri |
| Summary | True |
| Requirements | Need to know the system that defines the coded form of the unit. |
| Comments | see http://en.wikipedia.org/wiki/Uniform_resource_identifier |
| Conditions | The cardinality or value of this element may be affected by these constraints: qty-3 |
| Constraints |
|
| Mappings |
|
| MedicationDispense.daysSupply.code | |
| Short | Coded form of the unit |
| Definition | A computer processable form of the unit in some unit representation system. |
| Cardinality | 1..1 |
| Type | code |
| Summary | True |
| Requirements | Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest. |
| Comments | The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system. |
| Conditions | The cardinality or value of this element may be affected by these constraints: qty-3 |
| Constraints |
|
| Mappings |
|
| MedicationDispense.recorded | |
| Short | When the recording of the dispense started |
| Definition | The date (and maybe time) when the dispense activity started if whenPrepared or whenHandedOver is not populated. |
| Cardinality | 1..1 |
| Type | dateTime |
| Comments | UTC offset is allowed for dates and partial dates |
| Constraints |
|
| Mappings |
|
| MedicationDispense.whenPrepared | |
| Short | When product was packaged and reviewed |
| Definition | The time when the dispensed product was packaged and reviewed. |
| Cardinality | 1..1 |
| Type | dateTime |
| Summary | True |
| Comments | UTC offset is allowed for dates and partial dates |
| Conditions | The cardinality or value of this element may be affected by these constraints: mdd-1 |
| Constraints |
|
| Mappings |
|
| MedicationDispense.whenHandedOver | |
| Short | When product was given out |
| Definition | The time the dispensed product was provided to the patient or their representative. |
| Cardinality | 0..0 |
| Type | dateTime |
| Comments | UTC offset is allowed for dates and partial dates |
| Conditions | The cardinality or value of this element may be affected by these constraints: mdd-1 |
| Constraints |
|
| Mappings |
|
| MedicationDispense.destination | |
| Short | Where the medication was/will be sent |
| Definition | Identification of the facility/location where the medication was/will be shipped to, as part of the dispense event. |
| Cardinality | 0..1 |
| Type | Reference(Location) |
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.destination.id | |
| Short | Unique id for inter-element referencing |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..0 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| MedicationDispense.destination.extension | |
| Short | Additional content defined by implementations |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Cardinality | 0..0 |
| Type | Extension |
| Alias | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| MedicationDispense.destination.reference | |
| Short | Literal reference, Relative, internal or absolute URL |
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
| Cardinality | 0..0 |
| Type | string |
| Summary | True |
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
| Conditions | The cardinality or value of this element may be affected by these constraints: ref-2, ref-1 |
| Constraints |
|
| Mappings |
|
| MedicationDispense.destination.type | |
| Short | Type the reference refers to (e.g. "Patient") - must be a resource in resources |
| Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). |
| Cardinality | 1..1 |
| Type | uri |
| Binding | Aa resource (or, for logical models, the URI of the logical model). |
| Summary | True |
| Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference. |
| Constraints |
|
| Pattern | Location |
| Mappings |
|
| MedicationDispense.destination.identifier | |
| Short | Logical reference, when literal reference is not known |
| Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. |
| Cardinality | 1..1 |
| Type | Identifier |
| Summary | True |
| Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). This element only allows for a single identifier. In the case where additional identifers are required, use the http://hl7.org/fhir/StructureDefinition/additionalIdentifier extension. |
| Conditions | The cardinality or value of this element may be affected by these constraints: ref-2 |
| Constraints |
|
| Mappings |
|
| MedicationDispense.destination.identifier.id | |
| Short | Unique id for inter-element referencing |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..0 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| MedicationDispense.destination.identifier.extension | |
| Short | Additional content defined by implementations |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Cardinality | 0..0 |
| Type | Extension |
| Alias | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| MedicationDispense.destination.identifier.use | |
| Short | usual | official | temp | secondary | old (If known) |
| Definition | The purpose of this identifier. |
| Cardinality | 0..0 |
| Type | code |
| Binding | Identifies the purpose for this identifier, if known . |
| Modifier | True |
| Summary | True |
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.destination.identifier.type | |
| Short | Description of identifier |
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
| Cardinality | 0..0 |
| Type | CodeableConcept |
| Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| Summary | True |
| Requirements | Allows users to make use of identifiers when the identifier system is not known. |
| Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.destination.identifier.system | |
| Short | The namespace for the identifier value |
| Definition | Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique. |
| Cardinality | 1..1 |
| Type | uri |
| Summary | True |
| Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. |
| Comments | Identifier.system is always case sensitive. |
| Constraints |
|
| Pattern | https://fhir.synapxe.sg/NamingSystem/facility-unit-id |
| Examples | Generalhttp://www.acme.com/identifiers/patient |
| Mappings |
|
| MedicationDispense.destination.identifier.value | |
| Short | The value that is unique |
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
| Cardinality | 1..1 |
| Type | string |
| Summary | True |
| 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 http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. |
| Conditions | The cardinality or value of this element may be affected by these constraints: ident-1 |
| Constraints |
|
| Examples | General123456 |
| Mappings |
|
| MedicationDispense.destination.identifier.period | |
| Short | Time period when id is/was valid for use |
| Definition | Time period during which identifier is/was valid for use. |
| Cardinality | 0..0 |
| Type | Period |
| Summary | True |
| Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.destination.identifier.assigner | |
| Short | Organization that issued id (may be just text) |
| Definition | Organization that issued/manages the identifier. |
| Cardinality | 0..0 |
| Type | Reference(Organization) |
| Summary | True |
| Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.destination.display | |
| Short | Text alternative for the resource |
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
| Cardinality | 1..1 |
| Type | string |
| Summary | True |
| Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. |
| Conditions | The cardinality or value of this element may be affected by these constraints: ref-2 |
| Constraints |
|
| Mappings |
|
| MedicationDispense.receiver | |
| Short | Who collected the medication or where the medication was delivered |
| Definition | Identifies the person who picked up the medication or the location of where the medication was delivered. This will usually be a patient or their caregiver, but some cases exist where it can be a healthcare professional or a location. |
| Cardinality | 0..0 |
| Type | Reference(Location | Patient | Practitioner | PractitionerRole | RelatedPerson) |
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.note | |
| Short | Information about the dispense |
| Definition | Extra information about the dispense that could not be conveyed in the other attributes. |
| Cardinality | 0..0 |
| Type | Annotation |
| Comments | For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time. This element may need to be included in narrative because of the potential for modifying information. Annotations SHOULD NOT be used to communicate "modifying" information that could be computable. (This is a SHOULD because enforcing user behavior is nearly impossible). |
| Constraints |
|
| Mappings |
|
| MedicationDispense.renderedDosageInstruction | |
| Short | Full representation of the dosage instructions |
| Definition | The full representation of the dose of the medication included in all dosage instructions. To be used when multiple dosage instructions are included to represent complex dosing such as increasing or tapering doses. |
| Cardinality | 0..0 |
| Type | markdown |
| Comments | The content of the renderedDosageInstructions must not be different than the dose represented in the dosageInstruction content. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.dosageInstruction | |
| Short | How the medication is to be used by the patient or administered by the caregiver |
| Definition | Indicates how the medication is to be used by the patient. |
| Cardinality | 1..1 |
| Type | Dosage |
| Comments | When the dose or rate is intended to change over the entire administration period (e.g. Tapering dose prescriptions), multiple instances of dosage instructions will need to be supplied to convey the different doses/rates. The pharmacist reviews the medication order prior to dispense and updates the dosageInstruction based on the actual product being dispensed. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.dosageInstruction.id | |
| Short | Unique id for inter-element referencing |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..0 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| MedicationDispense.dosageInstruction.extension | |
| Short | Additional content defined by implementations |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Cardinality | 0..0 |
| Type | Extension |
| Alias | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| MedicationDispense.dosageInstruction.modifierExtension | |
| Short | Extensions that cannot be ignored even if unrecognized |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Cardinality | 0..0 |
| Type | Extension |
| Modifier | True |
| Summary | True |
| Alias | extensions, user content, modifiers |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.dosageInstruction.sequence | |
| Short | The order of the dosage instructions |
| Definition | Indicates the order in which the dosage instructions should be applied or interpreted. |
| Cardinality | 1..1 |
| Type | integer |
| Summary | True |
| Requirements | If the sequence number of multiple Dosages is the same, then it is implied that the instructions are to be treated as concurrent. If the sequence number is different, then the Dosages are intended to be sequential. |
| Comments | 32 bit number; for values larger than this, use decimal |
| Constraints |
|
| Mappings |
|
| MedicationDispense.dosageInstruction.text | |
| Short | Free text dosage instructions e.g. SIG |
| Definition | Free text dosage instructions e.g. SIG. |
| Cardinality | 0..1 |
| Type | string |
| Summary | True |
| Requirements | Free text dosage instructions can be used for cases where the instructions are too complex to code. The content of this attribute does not include the name or description of the medication. When coded instructions are present, the free text instructions may still be present for display to humans taking or administering the medication. It is expected that the text instructions will always be populated. If the dosage.timing attribute is also populated, then the dosage.text should reflect the same information as the timing. Additional information about administration or preparation of the medication should be included as text. |
| Comments | Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size |
| Constraints |
|
| Mappings |
|
| MedicationDispense.dosageInstruction.additionalInstruction | |
| Short | Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness" |
| Definition | Supplemental instructions to the patient on how to take the medication (e.g. "with meals" or"take half to one hour before food") or warnings for the patient about the medication (e.g. "may cause drowsiness" or "avoid exposure of skin to direct sunlight or sunlamps"). |
| Cardinality | 0..1 |
| Type | CodeableConcept |
| Binding | A coded concept identifying additional instructions such as "take with water" or "avoid operating heavy machinery". |
| Summary | True |
| Requirements | Additional instruction is intended to be coded, but where no code exists, the element could include text. For example, "Swallow with plenty of water" which might or might not be coded. |
| Comments | Information about administration or preparation of the medication (e.g. "infuse as rapidly as possibly via intraperitoneal port" or take "immediately following drug x") should be populated in dosage.text. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.dosageInstruction.additionalInstruction.id | |
| Short | Unique id for inter-element referencing |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..0 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| MedicationDispense.dosageInstruction.additionalInstruction.extension | |
| Short | Additional content defined by implementations |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Cardinality | 0..0 |
| Type | Extension |
| Alias | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| MedicationDispense.dosageInstruction.additionalInstruction.coding | |
| Short | Code defined by a terminology system |
| Definition | A reference to a code defined by a terminology system. |
| Cardinality | 0..0 |
| Type | Coding |
| Summary | True |
| Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
| 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 labeled as UserSelected = true. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.dosageInstruction.additionalInstruction.coding.id | |
| Short | Unique id for inter-element referencing |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..0 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| MedicationDispense.dosageInstruction.additionalInstruction.coding.extension | |
| Short | Additional content defined by implementations |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Cardinality | 0..0 |
| Type | Extension |
| Alias | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| MedicationDispense.dosageInstruction.additionalInstruction.coding.system | |
| Short | Identity of the terminology system |
| Definition | The identification of the code system that defines the meaning of the symbol in the code. |
| Cardinality | 1..1 |
| Type | uri |
| Summary | True |
| Requirements | Need to be unambiguous about the source of the definition of the symbol. |
| Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.dosageInstruction.additionalInstruction.coding.version | |
| Short | Version of the system - if relevant |
| Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
| Cardinality | 0..1 |
| Type | string |
| Summary | True |
| Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.dosageInstruction.additionalInstruction.coding.code | |
| Short | Symbol in syntax defined by the system |
| 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). |
| Cardinality | 1..1 |
| Type | code |
| Summary | True |
| Requirements | Need to refer to a particular code in the system. |
| Comments | Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size |
| Conditions | The cardinality or value of this element may be affected by these constraints: cod-1 |
| Constraints |
|
| Mappings |
|
| MedicationDispense.dosageInstruction.additionalInstruction.coding.display | |
| Short | Representation defined by the system |
| Definition | A representation of the meaning of the code in the system, following the rules of the system. |
| Cardinality | 1..1 |
| Type | string |
| Summary | True |
| Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
| Comments | Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size |
| Conditions | The cardinality or value of this element may be affected by these constraints: cod-1 |
| Constraints |
|
| Mappings |
|
| MedicationDispense.dosageInstruction.additionalInstruction.coding.userSelected | |
| Short | If this coding was chosen directly by the user |
| Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
| Cardinality | 0..0 |
| Type | boolean |
| Summary | True |
| Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
| Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.dosageInstruction.additionalInstruction.text | |
| Short | Plain text representation of the concept |
| Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
| Cardinality | 1..1 |
| Type | string |
| Summary | True |
| Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
| Comments | Very often the text is the same as a displayName of one of the codings. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.dosageInstruction.patientInstruction | |
| Short | Patient or consumer oriented instructions |
| Definition | Instructions in terms that are understood by the patient or consumer. |
| Cardinality | 0..0 |
| Type | string |
| Summary | True |
| Comments | Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size |
| Constraints |
|
| Mappings |
|
| MedicationDispense.dosageInstruction.timing | |
| Short | When medication should be administered |
| Definition | When medication should be administered. |
| Cardinality | 0..1 |
| Type | Timing |
| Summary | True |
| Requirements | The timing schedule for giving the medication to the patient. This data type allows many different expressions. For example: "Every 8 hours"; "Three times a day"; "1/2 an hour before breakfast for 10 days from 23-Dec 2011:"; "15 Oct 2013, 17 Oct 2013 and 1 Nov 2013". Sometimes, a rate can imply duration when expressed as total volume / duration (e.g. 500mL/2 hours implies a duration of 2 hours). However, when rate doesn't imply duration (e.g. 250mL/hour), then the timing.repeat.duration is needed to convey the infuse over time period. |
| Comments | This attribute might not always be populated while the Dosage.text is expected to be populated. If both are populated, then the Dosage.text should reflect the content of the Dosage.timing. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.dosageInstruction.timing.id | |
| Short | Unique id for inter-element referencing |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..0 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| MedicationDispense.dosageInstruction.timing.extension | |
| Short | Additional content defined by implementations |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Cardinality | 0..0 |
| Type | Extension |
| Alias | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| MedicationDispense.dosageInstruction.timing.modifierExtension | |
| Short | Extensions that cannot be ignored even if unrecognized |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Cardinality | 0..0 |
| Type | Extension |
| Modifier | True |
| Summary | True |
| Alias | extensions, user content, modifiers |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.dosageInstruction.timing.event | |
| Short | When the event occurs |
| Definition | Identifies specific times when the event occurs. |
| Cardinality | 0..0 |
| Type | dateTime |
| Summary | True |
| Requirements | In a Medication Administration Record, for instance, you need to take a general specification, and turn it into a precise specification. |
| Comments | UTC offset is allowed for dates and partial dates |
| Constraints |
|
| Mappings |
|
| MedicationDispense.dosageInstruction.timing.repeat | |
| Short | When the event is to occur |
| Definition | A set of rules that describe when the event is scheduled. |
| Cardinality | 0..1 |
| Type | Element |
| Summary | True |
| Requirements | Many timing schedules are determined by regular repetitions. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.dosageInstruction.timing.repeat.id | |
| Short | Unique id for inter-element referencing |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..0 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| MedicationDispense.dosageInstruction.timing.repeat.extension | |
| Short | Additional content defined by implementations |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Cardinality | 0..0 |
| Type | Extension |
| Alias | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| MedicationDispense.dosageInstruction.timing.repeat.bounds[x] | |
| Short | Length/Range of lengths, or (Start and/or end) limits |
| Definition | Either a duration for the length of the timing schedule, a range of possible length, or outer bounds for start and/or end limits of the timing schedule. |
| Cardinality | 0..1 |
| Type | Period |
| Summary | True |
| Constraints |
|
| Mappings |
|
| MedicationDispense.dosageInstruction.timing.repeat.bounds[x].id | |
| Short | Unique id for inter-element referencing |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..0 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| MedicationDispense.dosageInstruction.timing.repeat.bounds[x].extension | |
| Short | Additional content defined by implementations |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Cardinality | 0..0 |
| Type | Extension |
| Alias | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| MedicationDispense.dosageInstruction.timing.repeat.bounds[x].start | |
| Short | Starting time with inclusive boundary |
| Definition | The start of the period. The boundary is inclusive. |
| Cardinality | 1..1 |
| Type | dateTime |
| Summary | True |
| Comments | If the low element is missing, the meaning is that the low boundary is not known. |
| Conditions | The cardinality or value of this element may be affected by these constraints: per-1 |
| Constraints |
|
| Mappings |
|
| MedicationDispense.dosageInstruction.timing.repeat.bounds[x].end | |
| Short | End time with inclusive boundary, if not ongoing |
| Definition | The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. |
| Cardinality | 1..1 |
| Type | dateTime |
| Summary | True |
| Comments | The end value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03. |
| Meaning when missing | If the end of the period is missing, it means that the period is ongoing |
| Conditions | The cardinality or value of this element may be affected by these constraints: per-1 |
| Constraints |
|
| Mappings |
|
| MedicationDispense.dosageInstruction.timing.repeat.count | |
| Short | Number of times to repeat |
| Definition | A total count of the desired number of repetitions across the duration of the entire timing specification. If countMax is present, this element indicates the lower bound of the allowed range of count values. |
| Cardinality | 0..1 |
| Type | positiveInt |
| Summary | True |
| Requirements | Repetitions may be limited by end time or total occurrences. |
| Comments | If you have both bounds and count, then this should be understood as within the bounds period, until count times happens. |
| Conditions | The cardinality or value of this element may be affected by these constraints: tim-8 |
| Constraints |
|
| Mappings |
|
| MedicationDispense.dosageInstruction.timing.repeat.countMax | |
| Short | Maximum number of times to repeat |
| Definition | If present, indicates that the count is a range - so to perform the action between [count] and [countMax] times. |
| Cardinality | 0..1 |
| Type | positiveInt |
| Summary | True |
| Comments | 32 bit number; for values larger than this, use decimal |
| Conditions | The cardinality or value of this element may be affected by these constraints: tim-8 |
| Constraints |
|
| Mappings |
|
| MedicationDispense.dosageInstruction.timing.repeat.duration | |
| Short | How long when it happens |
| Definition | How long this thing happens for when it happens. If durationMax is present, this element indicates the lower bound of the allowed range of the duration. |
| Cardinality | 0..1 |
| Type | decimal |
| Summary | True |
| Requirements | Some activities are not instantaneous and need to be maintained for a period of time. |
| Comments | For some events the duration is part of the definition of the event (e.g. IV infusions, where the duration is implicit in the specified quantity and rate). For others, it's part of the timing specification (e.g. exercise). |
| Conditions | The cardinality or value of this element may be affected by these constraints: tim-7, tim-1, tim-4 |
| Constraints |
|
| Mappings |
|
| MedicationDispense.dosageInstruction.timing.repeat.durationMax | |
| Short | How long when it happens (Max) |
| Definition | If present, indicates that the duration is a range - so to perform the action between [duration] and [durationMax] time length. |
| Cardinality | 0..1 |
| Type | decimal |
| Summary | True |
| Requirements | Some activities are not instantaneous and need to be maintained for a period of time. |
| Comments | For some events the duration is part of the definition of the event (e.g. IV infusions, where the duration is implicit in the specified quantity and rate). For others, it's part of the timing specification (e.g. exercise). |
| Conditions | The cardinality or value of this element may be affected by these constraints: tim-7 |
| Constraints |
|
| Mappings |
|
| MedicationDispense.dosageInstruction.timing.repeat.durationUnit | |
| Short | s | min | h | d | wk | mo | a - unit of time (UCUM) |
| Definition | The units of time for the duration, in UCUM units Normal practice is to use the 'mo' code as a calendar month when calculating the next occurrence. |
| Cardinality | 0..1 |
| Type | code |
| Binding | A unit of time (units from UCUM). |
| Summary | True |
| Comments | Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size |
| Conditions | The cardinality or value of this element may be affected by these constraints: tim-1 |
| Constraints |
|
| Mappings |
|
| MedicationDispense.dosageInstruction.timing.repeat.frequency | |
| Short | Indicates the number of repetitions that should occur within a period. I.e. Event occurs frequency times per period |
| Definition | The number of times to repeat the action within the specified period. If frequencyMax is present, this element indicates the lower bound of the allowed range of the frequency. |
| Cardinality | 0..1 |
| Type | positiveInt |
| Summary | True |
| Comments | 32 bit number; for values larger than this, use decimal |
| Meaning when missing | If no frequency is stated, the assumption is that the event occurs once per period, but systems SHOULD always be specific about this |
| Constraints |
|
| Mappings |
|
| MedicationDispense.dosageInstruction.timing.repeat.frequencyMax | |
| Short | Event occurs up to frequencyMax times per period |
| Definition | If present, indicates that the frequency is a range - so to repeat between [frequency] and [frequencyMax] times within the period or period range. |
| Cardinality | 0..1 |
| Type | positiveInt |
| Summary | True |
| Comments | 32 bit number; for values larger than this, use decimal |
| Constraints |
|
| Mappings |
|
| MedicationDispense.dosageInstruction.timing.repeat.period | |
| Short | The duration to which the frequency applies. I.e. Event occurs frequency times per period |
| Definition | Indicates the duration of time over which repetitions are to occur; e.g. to express "3 times per day", 3 would be the frequency and "1 day" would be the period. If periodMax is present, this element indicates the lower bound of the allowed range of the period length. |
| Cardinality | 0..1 |
| Type | decimal |
| Summary | True |
| Comments | Do not use an IEEE type floating point type, instead use something that works like a true decimal, with inbuilt precision (e.g. Java BigInteger) |
| Conditions | The cardinality or value of this element may be affected by these constraints: tim-6, tim-5, tim-2 |
| Constraints |
|
| Mappings |
|
| MedicationDispense.dosageInstruction.timing.repeat.periodMax | |
| Short | Upper limit of period (3-4 hours) |
| Definition | If present, indicates that the period is a range from [period] to [periodMax], allowing expressing concepts such as "do this once every 3-5 days. |
| Cardinality | 0..1 |
| Type | decimal |
| Summary | True |
| Comments | Do not use an IEEE type floating point type, instead use something that works like a true decimal, with inbuilt precision (e.g. Java BigInteger) |
| Conditions | The cardinality or value of this element may be affected by these constraints: tim-6 |
| Constraints |
|
| Mappings |
|
| MedicationDispense.dosageInstruction.timing.repeat.periodUnit | |
| Short | s | min | h | d | wk | mo | a - unit of time (UCUM) |
| Definition | The units of time for the period in UCUM units Normal practice is to use the 'mo' code as a calendar month when calculating the next occurrence. |
| Cardinality | 0..1 |
| Type | code |
| Binding | A unit of time (units from UCUM). |
| Summary | True |
| Comments | Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size |
| Conditions | The cardinality or value of this element may be affected by these constraints: tim-2 |
| Constraints |
|
| Mappings |
|
| MedicationDispense.dosageInstruction.timing.repeat.dayOfWeek | |
| Short | mon | tue | wed | thu | fri | sat | sun |
| Definition | If one or more days of week is provided, then the action happens only on the specified day(s). |
| Cardinality | 0..1 |
| Type | code |
| Binding | |
| Summary | True |
| Comments | If no days are specified, the action is assumed to happen every day as otherwise specified. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.dosageInstruction.timing.repeat.timeOfDay | |
| Short | Time of day for action |
| Definition | Specified time of day for action to take place. |
| Cardinality | 0..1 |
| Type | time |
| Summary | True |
| Comments | When time of day is specified, it is inferred that the action happens every day (as filtered by dayofWeek) on the specified times. If there's a timeOfDay, there cannot be a when, or vice versa. |
| Conditions | The cardinality or value of this element may be affected by these constraints: tim-10 |
| Constraints |
|
| Mappings |
|
| MedicationDispense.dosageInstruction.timing.repeat.when | |
| Short | Code for time period of occurrence |
| Definition | An approximate time period during the day, potentially linked to an event of daily living that indicates when the action should occur. |
| Cardinality | 0..1 |
| Type | code |
| Binding | Real-world event relating to the schedule. |
| Summary | True |
| Requirements | Timings are frequently determined by occurrences such as waking, eating and sleep. |
| Comments | When more than one event is listed, the event is tied to the union of the specified events. |
| Conditions | The cardinality or value of this element may be affected by these constraints: tim-9, tim-10 |
| Constraints |
|
| Mappings |
|
| MedicationDispense.dosageInstruction.timing.repeat.offset | |
| Short | Minutes from event (before or after) |
| Definition | The number of minutes from the event. If the event code does not indicate whether the minutes is before or after the event, then the offset is assumed to be after the event. |
| Cardinality | 0..1 |
| Type | unsignedInt |
| Summary | True |
| Comments | 32 bit number; for values larger than this, use decimal |
| Conditions | The cardinality or value of this element may be affected by these constraints: tim-9 |
| Constraints |
|
| Mappings |
|
| MedicationDispense.dosageInstruction.timing.code | |
| Short | C | BID | TID | QID | AM | PM | QD | QOD | + |
| Definition | A code for the timing schedule (or just text in code.text). Some codes such as BID are ubiquitous, but many institutions define their own additional codes. If a code is provided, the code is understood to be a complete statement of whatever is specified in the structured timing data, and either the code or the data may be used to interpret the Timing, with the exception that .repeat.bounds still applies over the code (and is not contained in the code). |
| Cardinality | 0..1 |
| Type | CodeableConcept |
| Binding | Code for a known / defined timing pattern. |
| Summary | True |
| Comments | BID etc. are defined as 'at institutionally specified times'. For example, an institution may choose that BID is "always at 7am and 6pm". If it is inappropriate for this choice to be made, the code BID should not be used. Instead, a distinct organization-specific code should be used in place of the HL7-defined BID code and/or a structured representation should be used (in this case, specifying the two event times). |
| Constraints |
|
| Mappings |
|
| MedicationDispense.dosageInstruction.timing.code.id | |
| Short | Unique id for inter-element referencing |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..0 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| MedicationDispense.dosageInstruction.timing.code.extension | |
| Short | Additional content defined by implementations |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Cardinality | 0..0 |
| Type | Extension |
| Alias | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| MedicationDispense.dosageInstruction.timing.code.coding | |
| Short | Code defined by a terminology system |
| Definition | A reference to a code defined by a terminology system. |
| Cardinality | 1..1 |
| Type | Coding |
| Summary | True |
| Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
| 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 labeled as UserSelected = true. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.dosageInstruction.timing.code.coding.id | |
| Short | Unique id for inter-element referencing |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..0 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| MedicationDispense.dosageInstruction.timing.code.coding.extension | |
| Short | Additional content defined by implementations |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Cardinality | 0..0 |
| Type | Extension |
| Alias | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| MedicationDispense.dosageInstruction.timing.code.coding.system | |
| Short | Identity of the terminology system |
| Definition | The identification of the code system that defines the meaning of the symbol in the code. |
| Cardinality | 1..1 |
| Type | uri |
| Summary | True |
| Requirements | Need to be unambiguous about the source of the definition of the symbol. |
| Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.dosageInstruction.timing.code.coding.version | |
| Short | Version of the system - if relevant |
| Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
| Cardinality | 0..1 |
| Type | string |
| Summary | True |
| Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.dosageInstruction.timing.code.coding.code | |
| Short | Symbol in syntax defined by the system |
| 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). |
| Cardinality | 1..1 |
| Type | code |
| Summary | True |
| Requirements | Need to refer to a particular code in the system. |
| Comments | Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size |
| Conditions | The cardinality or value of this element may be affected by these constraints: cod-1 |
| Constraints |
|
| Mappings |
|
| MedicationDispense.dosageInstruction.timing.code.coding.display | |
| Short | Representation defined by the system |
| Definition | A representation of the meaning of the code in the system, following the rules of the system. |
| Cardinality | 1..1 |
| Type | string |
| Summary | True |
| Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
| Comments | Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size |
| Conditions | The cardinality or value of this element may be affected by these constraints: cod-1 |
| Constraints |
|
| Mappings |
|
| MedicationDispense.dosageInstruction.timing.code.coding.userSelected | |
| Short | If this coding was chosen directly by the user |
| Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
| Cardinality | 0..0 |
| Type | boolean |
| Summary | True |
| Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
| Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.dosageInstruction.timing.code.text | |
| Short | Plain text representation of the concept |
| Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
| Cardinality | 0..0 |
| Type | string |
| Summary | True |
| Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
| Comments | Very often the text is the same as a displayName of one of the codings. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.dosageInstruction.asNeeded | |
| Short | Take "as needed" |
| Definition | Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option). |
| Cardinality | 0..0 |
| Type | boolean |
| Summary | True |
| Comments | Can express "as needed" without a reason by setting the Boolean = True. In this case the CodeableConcept is not populated. |
| Conditions | The cardinality or value of this element may be affected by these constraints: dos-1 |
| Constraints |
|
| Mappings |
|
| MedicationDispense.dosageInstruction.asNeededFor | |
| Short | Take "as needed" (for x) |
| Definition | Indicates whether the Medication is only taken based on a precondition for taking the Medication (CodeableConcept). |
| Cardinality | 0..1 |
| Type | CodeableConcept |
| 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. |
| Summary | True |
| Comments | Can express "as needed" with a reason by including the CodeableConcept. In this case the Boolean is assumed to be False, then the dose is given according to the schedule and is not "prn" or "as needed". |
| Conditions | The cardinality or value of this element may be affected by these constraints: dos-1 |
| Constraints |
|
| Mappings |
|
| MedicationDispense.dosageInstruction.asNeededFor.id | |
| Short | Unique id for inter-element referencing |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..0 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| MedicationDispense.dosageInstruction.asNeededFor.extension | |
| Short | Additional content defined by implementations |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Cardinality | 0..0 |
| Type | Extension |
| Alias | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| MedicationDispense.dosageInstruction.asNeededFor.coding | |
| Short | Code defined by a terminology system |
| Definition | A reference to a code defined by a terminology system. |
| Cardinality | 0..0 |
| Type | Coding |
| Summary | True |
| Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
| 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 labeled as UserSelected = true. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.dosageInstruction.asNeededFor.text | |
| Short | Plain text representation of the concept |
| Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
| Cardinality | 1..1 |
| Type | string |
| Summary | True |
| Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
| Comments | Very often the text is the same as a displayName of one of the codings. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.dosageInstruction.site | |
| Short | Body site to administer to |
| Definition | Body site to administer to. |
| Cardinality | 0..0 |
| Type | CodeableConcept |
| Binding | A coded concept describing the site location the medicine enters into or onto the body. |
| Summary | True |
| Requirements | A coded specification of the anatomic site where the medication first enters the body. |
| Comments | If the use case requires attributes from the BodySite resource (e.g. to identify and track separately) then use the standard extension http://hl7.org/fhir/StructureDefinition/bodySite. May be a summary code, or a reference to a very precise definition of the location, or both. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.dosageInstruction.route | |
| Short | Concept - reference to a terminology or just text |
| Definition | A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. |
| Cardinality | 1..1 |
| Type | CodeableConcept |
| Binding | A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject. |
| Summary | True |
| Requirements | A code specifying the route or physiological path of administration of a therapeutic agent into or onto a patient's body. |
| Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.dosageInstruction.route.id | |
| Short | Unique id for inter-element referencing |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..0 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| MedicationDispense.dosageInstruction.route.extension | |
| Short | Additional content defined by implementations |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Cardinality | 0..0 |
| Type | Extension |
| Alias | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| MedicationDispense.dosageInstruction.route.coding | |
| Short | Code defined by a terminology system |
| Definition | A reference to a code defined by a terminology system. |
| Cardinality | 1..* |
| Type | Coding |
| Summary | True |
| Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
| 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 labeled as UserSelected = true. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.dosageInstruction.route.coding.id | |
| Short | Unique id for inter-element referencing |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..0 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| MedicationDispense.dosageInstruction.route.coding.extension | |
| Short | Additional content defined by implementations |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Cardinality | 0..0 |
| Type | Extension |
| Alias | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| MedicationDispense.dosageInstruction.route.coding.system | |
| Short | Identity of the terminology system |
| Definition | The identification of the code system that defines the meaning of the symbol in the code. |
| Cardinality | 1..1 |
| Type | uri |
| Summary | True |
| Requirements | Need to be unambiguous about the source of the definition of the symbol. |
| Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.dosageInstruction.route.coding.version | |
| Short | Version of the system - if relevant |
| Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
| Cardinality | 0..1 |
| Type | string |
| Summary | True |
| Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.dosageInstruction.route.coding.code | |
| Short | Symbol in syntax defined by the system |
| 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). |
| Cardinality | 1..1 |
| Type | code |
| Summary | True |
| Requirements | Need to refer to a particular code in the system. |
| Comments | Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size |
| Conditions | The cardinality or value of this element may be affected by these constraints: cod-1 |
| Constraints |
|
| Mappings |
|
| MedicationDispense.dosageInstruction.route.coding.display | |
| Short | Representation defined by the system |
| Definition | A representation of the meaning of the code in the system, following the rules of the system. |
| Cardinality | 1..1 |
| Type | string |
| Summary | True |
| Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
| Comments | Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size |
| Conditions | The cardinality or value of this element may be affected by these constraints: cod-1 |
| Constraints |
|
| Mappings |
|
| MedicationDispense.dosageInstruction.route.coding.userSelected | |
| Short | If this coding was chosen directly by the user |
| Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
| Cardinality | 0..0 |
| Type | boolean |
| Summary | True |
| Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
| Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.dosageInstruction.route.text | |
| Short | Plain text representation of the concept |
| Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
| Cardinality | 0..0 |
| Type | string |
| Summary | True |
| Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
| Comments | Very often the text is the same as a displayName of one of the codings. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.dosageInstruction.method | |
| Short | Technique for administering medication |
| Definition | Technique for administering medication. |
| Cardinality | 0..0 |
| Type | CodeableConcept |
| Binding | A coded concept describing the technique by which the medicine is administered. |
| Summary | True |
| Requirements | A coded value indicating the method by which the medication is introduced into or onto the body. Most commonly used for injections. For examples, Slow Push; Deep IV. |
| Comments | Terminologies used often pre-coordinate this term with the route and or form of administration. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.dosageInstruction.doseAndRate | |
| Short | Amount of medication administered, to be administered or typical amount to be administered |
| Definition | Depending on the resource,this is the amount of medication administered, to be administered or typical amount to be administered. |
| Cardinality | 0..* |
| Type | Element |
| Summary | True |
| Constraints |
|
| Mappings |
|
| MedicationDispense.dosageInstruction.doseAndRate.id | |
| Short | Unique id for inter-element referencing |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..0 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| MedicationDispense.dosageInstruction.doseAndRate.extension | |
| Short | Additional content defined by implementations |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Cardinality | 0..0 |
| Type | Extension |
| Alias | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| MedicationDispense.dosageInstruction.doseAndRate.type | |
| Short | The kind of dose or rate specified |
| Definition | The kind of dose or rate specified, for example, ordered or calculated. |
| Cardinality | 0..0 |
| Type | CodeableConcept |
| Binding | The kind of dose or rate specified. http://terminology.hl7.org/ValueSet/dose-rate-type (example) |
| Summary | True |
| Requirements | If the type is not populated, assume to be "ordered". |
| Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.dosageInstruction.doseAndRate.dose[x] | |
| Short | Amount of medication per dose |
| Definition | Amount of medication per dose. |
| Cardinality | 1..1 |
| Type | SimpleQuantity | Range |
| Summary | True |
| Requirements | The amount of therapeutic or other substance given at one administration event. |
| Comments | Note that this specifies the quantity of the specified medication, not the quantity for each active ingredient(s). Each ingredient amount can be communicated in the Medication resource. For example, if one wants to communicate that a tablet was 375 mg, where the dose was one tablet, you can use the Medication resource to document that the tablet was comprised of 375 mg of drug XYZ. Alternatively if the dose was 375 mg, then you may only need to use the Medication resource to indicate this was a tablet. If the example were an IV such as dopamine and you wanted to communicate that 400mg of dopamine was mixed in 500 ml of some IV solution, then this would all be communicated in the Medication resource. If the administration is not intended to be instantaneous (rate is present or timing has a duration), this can be specified to convey the total amount to be administered over the period of time as indicated by the schedule e.g. 500 ml in dose, with timing used to convey that this should be done over 4 hours. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.dosageInstruction.doseAndRate.rate[x] | |
| Short | Amount of medication per unit of time |
| Definition | Amount of medication per unit of time. |
| Cardinality | 0..0 |
| Type | SimpleQuantity | Range | Ratio |
| Summary | True |
| Requirements | Identifies the speed with which the medication was or will be introduced into the patient. Typically the rate for an infusion e.g. 100 ml per 1 hour or 100 ml/hr. May also be expressed as a rate per unit of time e.g. 500 ml per 2 hours. Other examples: 200 mcg/min or 200 mcg/1 minute; 1 liter/8 hours. Sometimes, a rate can imply duration when expressed as total volume / duration (e.g. 500mL/2 hours implies a duration of 2 hours). However, when rate doesn't imply duration (e.g. 250mL/hour), then the timing.repeat.duration is needed to convey the infuse over time period. |
| Comments | It is possible to supply both a rate and a doseQuantity to provide full details about how the medication is to be administered and supplied. If the rate is intended to change over time, depending on local rules/regulations, each change should be captured as a new version of the MedicationRequest with an updated rate, or captured with a new MedicationRequest with the new rate. It is possible to specify a rate over time (for example, 100 ml/hour) using either the rateRatio and rateQuantity. The rateQuantity approach requires systems to have the capability to parse UCUM grammar where ml/hour is included rather than a specific ratio where the time is specified as the denominator. Where a rate such as 500ml over 2 hours is specified, the use of rateRatio may be more semantically correct than specifying using a rateQuantity of 250 mg/hour. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.dosageInstruction.maxDosePerPeriod | |
| Short | Upper limit on medication per unit of time |
| Definition | Upper limit on medication per unit of time. |
| Cardinality | 0..0 |
| Type | Ratio |
| Summary | True |
| Requirements | The maximum total quantity of a therapeutic substance that may be administered to a subject over the period of time. For example, 1000mg in 24 hours. |
| Comments | This is intended for use as an adjunct to the dosage when there is an upper cap. For example "2 tablets every 4 hours to a maximum of 8/day". |
| Constraints |
|
| Mappings |
|
| MedicationDispense.dosageInstruction.maxDosePerAdministration | |
| Short | Upper limit on medication per administration |
| Definition | Upper limit on medication per administration. |
| Cardinality | 0..0 |
| Type | SimpleQuantity |
| Summary | True |
| Requirements | The maximum total quantity of a therapeutic substance that may be administered to a subject per administration. |
| Comments | This is intended for use as an adjunct to the dosage when there is an upper cap. For example, a body surface area related dose with a maximum amount, such as 1.5 mg/m2 (maximum 2 mg) IV over 5 – 10 minutes would have doseQuantity of 1.5 mg/m2 and maxDosePerAdministration of 2 mg. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.dosageInstruction.maxDosePerLifetime | |
| Short | Upper limit on medication per lifetime of the patient |
| Definition | Upper limit on medication per lifetime of the patient. |
| Cardinality | 0..0 |
| Type | SimpleQuantity |
| Summary | True |
| Requirements | The maximum total quantity of a therapeutic substance that may be administered per lifetime of the subject. |
| Comments | The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.substitution | |
| Short | Whether a substitution was performed on the dispense |
| Definition | Indicates whether or not substitution was made as part of the dispense. In some cases, substitution will be expected but does not happen, in other cases substitution is not expected but does happen. This block explains what substitution did or did not happen and why. If nothing is specified, substitution was not done. |
| Cardinality | 0..0 |
| Type | BackboneElement |
| Constraints |
|
| Mappings |
|
| MedicationDispense.substitution.id | |
| Short | Unique id for inter-element referencing |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..1 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| MedicationDispense.substitution.extension | |
| Short | Additional content defined by implementations |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Cardinality | 0..* |
| Type | Extension |
| Alias | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| MedicationDispense.substitution.modifierExtension | |
| Short | Extensions that cannot be ignored even if unrecognized |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Cardinality | 0..* |
| Type | Extension |
| Modifier | True |
| Summary | True |
| Alias | extensions, user content, modifiers |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.substitution.wasSubstituted | |
| Short | Whether a substitution was or was not performed on the dispense |
| Definition | True if the dispenser dispensed a different drug or product from what was prescribed. |
| Cardinality | 1..1 |
| Type | boolean |
| Constraints |
|
| Mappings |
|
| MedicationDispense.substitution.type | |
| Short | Code signifying whether a different drug was dispensed from what was prescribed |
| Definition | A code signifying whether a different drug was dispensed from what was prescribed. |
| Cardinality | 0..1 |
| Type | CodeableConcept |
| Binding | ActSubstanceAdminSubstitutionCode http://terminology.hl7.org/ValueSet/v3-ActSubstanceAdminSubstitutionCode (example) |
| Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.substitution.reason | |
| Short | Why was substitution made |
| Definition | Indicates the reason for the substitution (or lack of substitution) from what was prescribed. |
| Cardinality | 0..* |
| Type | CodeableConcept |
| Binding | SubstanceAdminSubstitutionReason http://terminology.hl7.org/ValueSet/v3-SubstanceAdminSubstitutionReason (example) |
| Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.substitution.responsibleParty | |
| Short | Who is responsible for the substitution |
| Definition | The person or organization that has primary responsibility for the substitution. |
| Cardinality | 0..1 |
| Type | Reference(Organization | Practitioner | PractitionerRole) |
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
| Constraints |
|
| Mappings |
|
| MedicationDispense.eventHistory | |
| Short | A list of relevant lifecycle events |
| Definition | A summary of the events of interest that have occurred, such as when the dispense was verified. |
| Cardinality | 0..0 |
| Type | Reference(Provenance) |
| Comments | This might not include provenances for all versions of the request – only those deemed “relevant” or important. This SHALL NOT include the Provenance associated with this current version of the resource. (If that provenance is deemed to be a “relevant” change, it will need to be added as part of a later update. Until then, it can be queried directly as the Provenance that points to this version using _revinclude All Provenances should have some historical version of this Request as their subject.). |
| Constraints |
|
| Mappings |
|
Example
Example-BundleMedicationDispense
Business Information Model
Key Design Considerations
There are various identifiers used in the MedicationDispense resource.
- sequenceNo: A number/text that identifies the sequence of this medication item within this medication list. It is modelled using
identifierwith thesystemashttps://fhir.synapxe.sg/NamingSystem/sequence-no. - groupNo: the identifier of the group that this medication item belongs to within this medication list. It is modelled using
identifierwith thesystemashttps://fhir.synapxe.sg/NamingSystem/group-no. - groupSequenceNo: A number/text that identifies the sequence of this medication item within the group derived based on the groupNo. It is modelled using
dosingInstruction.sequence. - orderSetConnectingTerm: The term used to connect this medication item and another medication item within the same order set (i.e. derived using sequenceNo, groupNo, groupSequenceNo) for variable/step doses. It is modelled using
extension:orderSetConnectingTerm.
An example is shown below for a patient's medication list containing two medication items (Prednisolone and Paracetamol) and their administration doses.
Step Dose
- Prednisolone 10 mg for 3 days
- Prednisolone 5 mg for 5 days
- Prednisolone 2 mg for 8 days
Variable Dose
- Paracetamol 1000 mg – Morning
- Paracetamol 500 mg – Afternoon
- Paracetamol 100 mg – Night
Medication Dispense Details
For step doses (Prednisolone), medications share the same group number (SDSGH103599) and use the "THEN" connecting term, indicating sequential administration where each dose follows the previous one. The group sequence numbers (1, 2, 3) define the order of progression within the group number. In contrast, variable doses (Paracetamol), share the group number (SDSGH103588) and use the "AND" connecting term, indicating concurrent administration at different times of day. The sequence numbers (1.1, 1.2, etc.) provide overall ordering across all medication requests.
| Medication Request | Sequence No. | Group No. | Group Sequence No. | Order Set Connecting Term |
|---|---|---|---|---|
| Prednisolone 10 mg – 3 days | 1.1 | SDSGH103599 | 1 | THEN |
| Prednisolone 5 mg – 5 days | 1.2 | SDSGH103599 | 2 | THEN |
| Prednisolone 2 mg – 8 days | 1.3 | SDSGH103599 | 3 | |
| Paracetamol 1000 mg – Morning | 1.4 | SDSGH103588 | 1 | AND |
| Paracetamol 500 mg – Afternoon | 1.5 | SDSGH103588 | 2 | AND |
| Paracetamol 100 mg – Night | 1.6 | SDSGH103588 | 3 |
Outstanding Design Considerations
- For ordered and dispensed medications, we capture the medication start and end datetimes and the clinician who authorized the medication. We use
MedicationRequestto store ordered medications andMedicationDispensefor dispensed medications. InMedicationRequest, we can useeffectiveDosePeriodto store the start and end datetimes, and the existingauthorizerextension to store the authorizing clinician. However, inMedicationDispense, there are no suitable elements to store these two data points. Currently, we useMedicationDispense.authorizingPrescriptionto referenceMedicationRequest, but this makes retrieving the dispensed medication start and end datetimes and the authorizing clinician more complex. An alternative design consideration is to create two extensions onMedicationDispenseto store this data directly, which would enable easier retrieval.
API Specification
See MedicationDispense.$submit and
Terminology Bindings
| Path | Binding Strength | Value Set (Code System) | Description |
|---|---|---|---|
| MedicationDispense.language | required | http://hl7.org/fhir/ValueSet/all-languages|5.0.0 | IETF language tag for a human language |
| MedicationDispense.status | required | http://hl7.org/fhir/ValueSet/medicationdispense-status|5.0.0 | Describes the lifecycle of the dispense. |
| MedicationDispense.notPerformedReason | example | http://hl7.org/fhir/ValueSet/medicationdispense-status-reason | |
| MedicationDispense.notPerformedReason.concept | required | https://fhir.synapxe.sg/ValueSet/status-reason | |
| MedicationDispense.category | required | https://fhir.synapxe.sg/ValueSet/dispense-type | A code describing where the dispensed medication is expected to be consumed or administered. |
| MedicationDispense.medication | example | http://hl7.org/fhir/ValueSet/medication-codes | A coded concept identifying which substance or product can be dispensed. |
| MedicationDispense.medication.reference.type | extensible | http://hl7.org/fhir/ValueSet/resource-types | Aa resource (or, for logical models, the URI of the logical model). |
| MedicationDispense.subject.type | extensible | http://hl7.org/fhir/ValueSet/resource-types | Aa resource (or, for logical models, the URI of the logical model). |
| MedicationDispense.encounter.type | extensible | http://hl7.org/fhir/ValueSet/resource-types | Aa resource (or, for logical models, the URI of the logical model). |
| MedicationDispense.performer.actor.type | extensible | http://hl7.org/fhir/ValueSet/resource-types | Aa resource (or, for logical models, the URI of the logical model). |
| MedicationDispense.performer.actor.identifier.use | required | http://hl7.org/fhir/ValueSet/identifier-use|5.0.0 | Identifies the purpose for this identifier, if known . |
| MedicationDispense.performer.actor.identifier.type | extensible | http://hl7.org/fhir/ValueSet/identifier-type | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| MedicationDispense.location.type | extensible | http://hl7.org/fhir/ValueSet/resource-types | Aa resource (or, for logical models, the URI of the logical model). |
| MedicationDispense.authorizingPrescription.type | extensible | http://hl7.org/fhir/ValueSet/resource-types | Aa resource (or, for logical models, the URI of the logical model). |
| MedicationDispense.destination.type | extensible | http://hl7.org/fhir/ValueSet/resource-types | Aa resource (or, for logical models, the URI of the logical model). |
| MedicationDispense.dosageInstruction.additionalInstruction | example | http://hl7.org/fhir/ValueSet/additional-instruction-codes | A coded concept identifying additional instructions such as "take with water" or "avoid operating heavy machinery". |
| MedicationDispense.dosageInstruction.timing.repeat.durationUnit | required | http://hl7.org/fhir/ValueSet/units-of-time|5.0.0 | A unit of time (units from UCUM). |
| MedicationDispense.dosageInstruction.timing.repeat.periodUnit | required | http://hl7.org/fhir/ValueSet/units-of-time|5.0.0 | A unit of time (units from UCUM). |
| MedicationDispense.dosageInstruction.timing.repeat.dayOfWeek | required | http://hl7.org/fhir/ValueSet/days-of-week|5.0.0 | |
| MedicationDispense.dosageInstruction.timing.repeat.when | required | http://hl7.org/fhir/ValueSet/event-timing|5.0.0 | Real-world event relating to the schedule. |
| MedicationDispense.dosageInstruction.timing.code | preferred | http://hl7.org/fhir/ValueSet/timing-abbreviation | Code for a known / defined timing pattern. |
| MedicationDispense.dosageInstruction.asNeededFor | example | http://hl7.org/fhir/ValueSet/medication-as-needed-reason | 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. |
| MedicationDispense.dosageInstruction.route | example | http://hl7.org/fhir/ValueSet/route-codes | A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject. |
| MedicationDispense.substitution.type | example | http://terminology.hl7.org/ValueSet/v3-ActSubstanceAdminSubstitutionCode | ActSubstanceAdminSubstitutionCode |
| MedicationDispense.substitution.reason | example | http://terminology.hl7.org/ValueSet/v3-SubstanceAdminSubstitutionReason | SubstanceAdminSubstitutionReason |
Constraints
XML to FHIR Mapping
| XML element | FHIR mapping |
|---|---|
medicationDispense/recordIdentifier |
MedicationDispense.identifier(system=https://fhir.synapxe.sg/NamingSystem/recordIdentifier).value |
medicationDispense/eventID |
MedicationDispense.encounter.identifier(system=https://fhir.synapxe.sg/NamingSystem/eventID).value |
medicationDispense/orderID |
MedicationDispense.authorizingPrescription.identifier(system=https://fhir.synapxe.sg/NamingSystem/orderID).value |
medicationDispense/sourceGroupingID |
MedicationDispense.identifier(system=https://fhir.synapxe.sg/NamingSystem/sourceGroupingID).value |
medicationDispense/orderingInstitution |
MedicationDispense.authorizingPrescription(MedicationRequest).extensions:orderingInstitution |
medicationDispense/orderingLocation |
MedicationDispense.authorizingPrescription(MedicationRequest).extensions:orderingLocation.coding.code |
medicationDispense/orderingLocation/codingSchemeName |
MedicationDispense.authorizingPrescription(MedicationRequest).extensions:orderingLocation.coding.system |
medicationDispense/orderingLocation/codingSchemeVersion |
MedicationDispense.authorizingPrescription(MedicationRequest).extensions:orderingLocation.coding.version |
medicationDispense/orderingLocation/textDescription |
MedicationDispense.authorizingPrescription(MedicationRequest).extensions:orderingLocation.coding.display |
medicationDispense/recordCreatedDateTime |
MedicationDispense.recorded |
medicationDispense/orderedBy/id |
MedicationDispense.authorizingPrescription(MedicationRequest).requester.identifier.value |
medicationDispense/orderedBy/name |
MedicationDispense.authorizingPrescription(MedicationRequest).requester.display |
medicationDispense/dispenseID |
MedicationDispense.identifier(system=https://fhir.synapxe.sg/NamingSystem/dispenseID).value |
medicationDispense/dispensingInstitution |
MedicationDispense.extension:dispensingInstitution |
medicationDispense/dispensingLocation/code |
MedicationDispense.location.identifier(system=https://fhir.synapxe.sg/NamingSystem/dispensing-location).value |
medicationDispense/dispensingLocation/textDescription |
MedicationDispense.location.display |
medicationDispense/dispenseType/code |
MedicationDispense.category.coding.code |
medicationDispense/dispenseType/codingSchemeName |
MedicationDispense.category.coding.system |
medicationDispense/dispenseType/codingSchemeVersion |
MedicationDispense.category.coding.version |
medicationDispense/dispenseType/textDescription |
MedicationDispense.category.coding.display |
medicationDispense/dispenseDateTime |
MedicationDispense.whenPrepared |
medicationDispense/reasonForCancellation/code |
MedicationDispense.notPerformedReason.concept.coding.code |
medicationDispense/reasonForCancellation/codingSchemeName |
MedicationDispense.notPerformedReason.concept.coding.system |
medicationDispense/reasonForCancellation/codingSchemeVersion |
MedicationDispense.notPerformedReason.concept.coding.version |
medicationDispense/reasonForCancellation/textDescription |
MedicationDispense.notPerformedReason.concept.coding.display |
medicationDispense/dispenseStatus/code |
MedicationDispense.status.coding.code |
medicationDispense/dispenseStatus/codingSchemeName |
MedicationDispense.status.coding.system |
medicationDispense/dispenseStatus/codingSchemeVersion |
MedicationDispense.status.coding.version |
medicationDispense/dispenseStatus/textDescription |
MedicationDispense.status.coding.display |
medicationDispense/dispensedBy/id |
MedicationDispense.performer.actor.identifier.value |
medicationDispense/dispensedBy/name |
MedicationDispense.performer.actor.display |
medicationDispense/authorizedBy/id |
MedicationDispense.authorizingPrescription(MedicationRequest).extensions:authorizer.identifier.value |
medicationDispense/authorizedBy/name |
MedicationDispense.authorizingPrescription(MedicationRequest).extensions:authorizer.display |
medicationDispense/medicationItem |
MedicationDispense.medication(Medication) |
medicationDispense/medicationItem/itemId |
Medication.identifier(system=https://fhir.synapxe.sg/NamingSystem/itemID).value |
medicationDispense/medicationItem/sequenceNo |
MedicationDispense.extensions:sequenceNo |
medicationDispense/medicationItem/groupNo |
MedicationDispense.extensions:groupNo |
medicationDispense/medicationItem/groupSequenceNo |
MedicationDispense.dosageInstruction.sequence |
medicationDispense/medicationItem/orderSetConnectingTerm |
MedicationDispense.extension:orderSetConnectingTerm |
medicationDispense/medicationItem/frequencyQualifier |
MedicationDispense.dosageInstruction.additionalInstruction.text |
medicationDispense/medicationItem/dosageInstruction |
MedicationDispense.dosageInstruction.text |
medicationDispense/medicationItem/doseQuantity/lowValue |
MedicationDispense.dosageInstruction.doseAndRate.doseQuantity.lowValue |
medicationDispense/medicationItem/doseQuantity/lowUnit |
MedicationDispense.dosageInstruction.doseAndRate.doseQuantity.lowUnit |
medicationDispense/medicationItem/doseQuantity/highValue |
MedicationDispense.dosageInstruction.doseAndRate.doseQuantity.highValue |
medicationDispense/medicationItem/doseQuantity/highUnit |
MedicationDispense.dosageInstruction.doseAndRate.doseQuantity.highUnit |
medicationDispense/medicationItem/medicationItemDispensedDate |
MedicationDispense.whenPrepared |
medicationDispense/medicationItem/medicationStartDateTime |
MedicationDispense.authorizingPrescription(MedicationRequest) |
medicationDispense/medicationItem/medicationEndDateTime |
MedicationDispense.authorizingPrescription(MedicationRequest) |
medicationDispense/medicationItem/medicationItemStatus/code |
Medication.status.coding.code |
medicationDispense/medicationItem/medicationItemStatus/codingSchemeName |
Medication.status.coding.system |
medicationDispense/medicationItem/medicationItemStatus/codingSchemeVersion |
Medication.status.coding.version |
medicationDispense/medicationItem/medicationItemStatus/textDescription |
Medication.status.coding.display |
medicationDispense/medicationItem/reasonForMedication/code |
MedicationDispense.reason.concept.coding.code |
medicationDispense/medicationItem/reasonForMedication/codingSchemeName |
MedicationDispense.reason.concept.coding.system |
medicationDispense/medicationItem/reasonForMedication/codingSchemeVersion |
MedicationDispense.reason.concept.coding.version |
medicationDispense/medicationItem/reasonForMedication/textDescription |
MedicationDispense.reason.concept.coding.display |
medicationDispense/medicationItem/changesMade/code |
MedicationDispense.extension:changesMade.code |
medicationDispense/medicationItem/changesMade/codingSchemeName |
MedicationDispense.extension:changesMade.system |
medicationDispense/medicationItem/changesMade/codingSchemeVersion |
MedicationDispense.extension:changesMade.version |
medicationDispense/medicationItem/changesMade/textDescription |
MedicationDispense.extension:changesMade.display |
medicationDispense/medicationItem/reasonForChanges/code |
MedicationDispense.notPerformedReason.concept.coding.code |
medicationDispense/medicationItem/reasonForChanges/codingSchemeName |
MedicationDispense.notPerformedReason.concept.coding.system |
medicationDispense/medicationItem/reasonForChanges/codingSchemeVersion |
MedicationDispense.notPerformedReason.concept.coding.version |
medicationDispense/medicationItem/reasonForChanges/textDescription |
MedicationDispense.notPerformedReason.concept.coding.display |
medicationDispense/medicationItem/quantityDispensed |
MedicationDispense.quantity.value |
medicationDispense/medicationItem/quantityDispensedUnits |
MedicationDispense.quantity.unit |
medicationDispense/medicationItem/duration/code |
MedicationDispense.dosageInstruction.timing.repeat.period |
medicationDispense/medicationItem/durationUnits |
MedicationDispense.dosageInstruction.timing.repeat.periodUnit |
medicationDispense/medicationItem/medicationName/code |
Medication.code.coding.code |
medicationDispense/medicationItem/medicationName/codingSchemeName |
Medication.code.coding.system |
medicationDispense/medicationItem/medicationName/codingSchemeVersion |
Medication.code.coding.version |
medicationDispense/medicationItem/medicationName/textDescription |
Medication.code.coding.display |
medicationDispense/medicationItem/frequency/code |
MedicationDispense.dosageInstruction.timing.repeat.when.coding.code |
medicationDispense/medicationItem/frequency/codingSchemeName |
MedicationDispense.dosageInstruction.timing.repeat.when.coding.system |
medicationDispense/medicationItem/frequency/codingSchemeVersion |
MedicationDispense.dosageInstruction.timing.repeat.when.coding.version |
medicationDispense/medicationItem/frequency/textDescription |
MedicationDispense.dosageInstruction.timing.repeat.when.coding.display |
medicationDispense/medicationItem/routeOfAdministration/code |
MedicationDispense.dosageInstruction.route.coding.code |
medicationDispense/medicationItem/routeOfAdministration/codingSchemeName |
MedicationDispense.dosageInstruction.route.coding.system |
medicationDispense/medicationItem/routeOfAdministration/codingSchemeVersion |
MedicationDispense.dosageInstruction.route.coding.version |
medicationDispense/medicationItem/routeOfAdministration/textDescription |
MedicationDispense.dosageInstruction.route.coding.display |
medicationDispense/medicationItem/medicationStrength |
Medication.ingredient.strengthQuantity.value |
medicationDispense/medicationItem/medicationStrengthUnit |
Medication.ingredient.strengthQuantity.unit |
medicationDispense/medicationItem/doseForm/code |
Medication.doseForm.coding.code |
medicationDispense/medicationItem/doseForm/codingSchemeName |
Medication.doseForm.coding.system |
medicationDispense/medicationItem/doseForm/codingSchemeVersion |
Medication.doseForm.coding.version |
medicationDispense/medicationItem/doseForm/textDescription |
Medication.doseForm.coding.display |