NHSDigital-MedicationDispense
Profile url | FHIR Module | Normative Status |
---|---|---|
https://fhir.nhs.uk/StructureDefinition/NHSDigital-MedicationDispense | Medicines | trial-use |
Combined with UK Core MedicationDispense
NHSDigitalMedicationDispense (MedicationDispense) | I | ||
id | Σ | 0..1 | string |
meta | Σ | 0..1 | Meta |
implicitRules | Σ ?! | 0..1 | uri |
language | 0..1 | codeBinding | |
text | 0..1 | Narrative | |
contained | 0..* | Resource | |
extension | I | 1..* | Extension |
prescriptionStatus | S I | 1..1 | Extension(Coding) |
prescriptionNonDispensingReason | S I | 0..1 | Extension(Coding) |
repeatInformation | S I | 0..1 | Extension(Complex) |
supplyHeaderIdentifier | S I | 0..1 | Extension(Identifier) |
modifierExtension | ?! I | 0..* | Extension |
identifier | S | 0..* | Identifier |
id | 0..1 | string | |
extension | I | 0..* | Extension |
use | Σ ?! | 0..1 | codeBinding |
type | Σ | 0..1 | CodeableConceptBinding |
system | Σ | 1..1 | uri |
value | Σ | 1..1 | string |
period | Σ I | 0..1 | Period |
assigner | Σ I | 0..1 | Reference() |
partOf | I | 0..* | Reference() |
id | 0..1 | string | |
extension | I | 0..* | Extension |
reference | Σ I | 0..1 | string |
type | Σ | 0..1 | uriBinding |
identifier | Σ | 0..1 | Identifier |
id | 0..1 | string | |
extension | I | 0..* | Extension |
use | Σ ?! | 0..1 | codeBinding |
type | Σ | 0..1 | CodeableConceptBinding |
system | Σ | 0..1 | uri |
value | Σ | 0..1 | string |
period | Σ I | 0..1 | Period |
assigner | Σ I | 0..1 | Reference() |
display | Σ | 0..1 | string |
status | S Σ ?! | 1..1 | codeBinding |
statusReason[x] | S | 0..1 | |
statusReasonCodeableConcept | CodeableConcept | ||
id | 0..1 | string | |
extension | I | 0..* | Extension |
coding | Σ | 1..* | Coding |
(All Slices) | |||
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | Σ | 1..1 | uri |
version | Σ | 0..1 | string |
code | Σ | 1..1 | code |
display | Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
notDispensedStatusReason | S Σ | 0..* | CodingBinding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | Σ | 0..1 | uriFixed Value |
version | Σ | 0..1 | string |
code | Σ | 0..1 | code |
display | Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
amendmentStatusReason | S Σ | 0..* | CodingBinding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | Σ | 0..1 | uriFixed Value |
version | Σ | 0..1 | string |
code | Σ | 0..1 | code |
display | Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
text | Σ | 0..1 | string |
category | 0..1 | CodeableConceptBinding | |
id | 0..1 | string | |
extension | I | 0..* | Extension |
coding | Σ | 0..* | Coding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | Σ | 1..1 | uri |
version | Σ | 0..1 | string |
code | Σ | 1..1 | code |
display | Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
text | Σ | 0..1 | string |
medication[x] | S Σ | 1..1 | Binding |
medicationCodeableConcept | NHSDigitalMedicationDispenseCodeableConcept | ||
medicationReference | Reference(NHSDigitalMedicationDispenseMedication) | ||
subject | S Σ I | 1..1 | Reference(NHSDigitalPatientPDS) |
id | 0..1 | string | |
extension | I | 0..* | Extension |
reference | Σ I | 0..1 | string |
type | Σ | 0..1 | uriBinding |
identifier | Σ | 0..1 | Identifier |
id | 0..1 | string | |
extension | I | 0..* | Extension |
use | Σ ?! | 0..1 | codeBinding |
type | Σ | 0..1 | CodeableConceptBinding |
system | Σ | 1..1 | uriFixed Value |
value | Σ | 1..1 | string |
period | Σ I | 0..1 | Period |
assigner | Σ I | 0..1 | Reference() |
display | Σ | 0..1 | string |
context | I | 0..1 | Reference( | NHSDigitalEncounter) |
id | 0..1 | string | |
extension | I | 0..* | Extension |
reference | Σ I | 0..1 | string |
type | Σ | 0..1 | uriBinding |
identifier | Σ | 0..1 | Identifier |
id | 0..1 | string | |
extension | I | 0..* | Extension |
use | Σ ?! | 0..1 | codeBinding |
type | Σ | 0..1 | CodeableConceptBinding |
system | Σ | 0..1 | uri |
value | Σ | 0..1 | string |
period | Σ I | 0..1 | Period |
assigner | Σ I | 0..1 | Reference() |
display | Σ | 0..1 | string |
supportingInformation | I | 0..* | Reference(Resource) |
id | 0..1 | string | |
extension | I | 0..* | Extension |
reference | Σ I | 0..1 | string |
type | Σ | 0..1 | uriBinding |
identifier | Σ | 0..1 | Identifier |
id | 0..1 | string | |
extension | I | 0..* | Extension |
use | Σ ?! | 0..1 | codeBinding |
type | Σ | 0..1 | CodeableConceptBinding |
system | Σ | 0..1 | uri |
value | Σ | 0..1 | string |
period | Σ I | 0..1 | Period |
assigner | Σ I | 0..1 | Reference() |
display | Σ | 0..1 | string |
performer | S | 1..* | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
function | 0..1 | CodeableConcept | |
actor | I | 1..1 | NHSDigitalReference(NHSDigitalPractitionerRoleSDS) |
id | 0..1 | string | |
extension | I | 0..* | Extension |
reference | Σ I | 1..1 | string |
type | Σ | 0..1 | uriBinding |
identifier | Σ | 0..1 | NHSDigitalIdentifier |
id | 0..1 | string | |
extension | I | 0..* | Extension |
use | Σ ?! | 0..1 | codeBinding |
type | Σ | 0..1 | CodeableConceptBinding |
system | Σ | 1..1 | uri |
value | Σ | 1..1 | string |
period | Σ I | 0..1 | Period |
assigner | Σ I | 0..1 | Reference() |
display | Σ | 0..1 | string |
location | I | 0..1 | Reference(NHSDigitalLocation) |
id | 0..1 | string | |
extension | I | 0..* | Extension |
reference | Σ I | 0..1 | string |
type | Σ | 0..1 | uriBinding |
identifier | Σ | 0..1 | Identifier |
id | 0..1 | string | |
extension | I | 0..* | Extension |
use | Σ ?! | 0..1 | codeBinding |
type | Σ | 0..1 | CodeableConceptBinding |
system | Σ | 1..1 | uri |
value | Σ | 1..1 | string |
period | Σ I | 0..1 | Period |
assigner | Σ I | 0..1 | Reference() |
display | Σ | 1..1 | string |
authorizingPrescription | S I | 1..* | Reference(NHSDigitalMedicationRequestMinimal) |
id | 0..1 | string | |
extension | I | 0..* | Extension |
reference | Σ I | 1..1 | string |
type | Σ | 0..1 | uriBinding |
identifier | Σ | 0..1 | Identifier |
id | 0..1 | string | |
extension | I | 0..* | Extension |
use | Σ ?! | 0..1 | codeBinding |
type | Σ | 0..1 | CodeableConceptBinding |
system | Σ | 0..1 | uri |
value | Σ | 0..1 | string |
period | Σ I | 0..1 | Period |
assigner | Σ I | 0..1 | Reference() |
display | Σ | 0..1 | string |
type | S | 0..1 | CodeableConceptBinding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
coding | Σ | 0..* | Coding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | Σ | 1..1 | uri |
version | Σ | 0..1 | string |
code | Σ | 1..1 | code |
display | Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
text | Σ | 0..1 | string |
quantity | S I | 1..1 | SimpleQuantity |
id | 0..1 | string | |
extension | I | 0..* | Extension |
runningTotal | I | 0..1 | Extension(Quantity) |
value | Σ | 1..1 | decimal |
comparator | Σ ?! | 0..0 | codeBinding |
unit | Σ | 1..1 | string |
system | Σ I | 1..1 | uri |
code | Σ | 1..1 | code |
daysSupply | S I | 0..1 | SimpleQuantity |
whenPrepared | S Σ | 0..1 | dateTime |
whenHandedOver | S | 0..1 | dateTime |
destination | I | 0..1 | Reference() |
id | 0..1 | string | |
extension | I | 0..* | Extension |
reference | Σ I | 0..1 | string |
type | Σ | 0..1 | uriBinding |
identifier | Σ | 0..1 | Identifier |
id | 0..1 | string | |
extension | I | 0..* | Extension |
use | Σ ?! | 0..1 | codeBinding |
type | Σ | 0..1 | CodeableConceptBinding |
system | Σ | 0..1 | uri |
value | Σ | 0..1 | string |
period | Σ I | 0..1 | Period |
assigner | Σ I | 0..1 | Reference() |
display | Σ | 0..1 | string |
receiver | I | 0..1 | Reference( | ) |
id | 0..1 | string | |
extension | I | 0..* | Extension |
reference | Σ I | 0..1 | string |
type | Σ | 0..1 | uriBinding |
identifier | Σ | 0..1 | Identifier |
id | 0..1 | string | |
extension | I | 0..* | Extension |
use | Σ ?! | 0..1 | codeBinding |
type | Σ | 0..1 | CodeableConceptBinding |
system | Σ | 0..1 | uri |
value | Σ | 0..1 | string |
period | Σ I | 0..1 | Period |
assigner | Σ I | 0..1 | Reference() |
display | Σ | 0..1 | string |
note | 0..* | Annotation | |
id | 0..1 | string | |
extension | I | 0..* | Extension |
author[x] | Σ | 0..1 | |
authorString | string | ||
authorReference | Reference( | | | ) | ||
time | Σ | 0..1 | dateTime |
text | Σ | 1..1 | markdown |
dosageInstruction | S | 0..* | NHSDigitalDosage |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
sequence | Σ | 0..1 | integer |
text | Σ | 0..1 | string |
additionalInstruction | Σ | 0..* | CodeableConcept |
patientInstruction | Σ | 0..1 | string |
timing | Σ | 0..1 | Timing |
asNeeded[x] | Σ | 0..1 | Binding |
asNeededBoolean | boolean | ||
asNeededCodeableConcept | CodeableConcept | ||
site | Σ | 0..1 | CodeableConceptBinding |
route | Σ | 0..1 | CodeableConceptBinding |
method | Σ | 0..1 | CodeableConceptBinding |
doseAndRate | Σ | 0..* | Element |
id | 0..1 | string | |
extension | I | 0..* | Extension |
type | Σ | 0..1 | CodeableConcept |
dose[x] | Σ | 0..1 | |
doseRange | Range | ||
doseQuantity | SimpleQuantity | ||
rate[x] | Σ | 0..1 | |
rateRatio | Ratio | ||
rateRange | Range | ||
rateQuantity | SimpleQuantity | ||
maxDosePerPeriod | Σ I | 0..1 | Ratio |
maxDosePerAdministration | Σ I | 0..1 | SimpleQuantity |
maxDosePerLifetime | Σ I | 0..1 | SimpleQuantity |
substitution | 0..1 | BackboneElement | |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
wasSubstituted | 1..1 | boolean | |
type | 0..1 | CodeableConcept | |
reason | 0..* | CodeableConcept | |
responsibleParty | I | 0..* | Reference( | ) |
id | 0..1 | string | |
extension | I | 0..* | Extension |
reference | Σ I | 0..1 | string |
type | Σ | 0..1 | uriBinding |
identifier | Σ | 0..1 | Identifier |
id | 0..1 | string | |
extension | I | 0..* | Extension |
use | Σ ?! | 0..1 | codeBinding |
type | Σ | 0..1 | CodeableConceptBinding |
system | Σ | 0..1 | uri |
value | Σ | 0..1 | string |
period | Σ I | 0..1 | Period |
assigner | Σ I | 0..1 | Reference() |
display | Σ | 0..1 | string |
detectedIssue | I | 0..* | Reference(DetectedIssue) |
id | 0..1 | string | |
extension | I | 0..* | Extension |
reference | Σ I | 0..1 | string |
type | Σ | 0..1 | uriBinding |
identifier | Σ | 0..1 | Identifier |
id | 0..1 | string | |
extension | I | 0..* | Extension |
use | Σ ?! | 0..1 | codeBinding |
type | Σ | 0..1 | CodeableConceptBinding |
system | Σ | 0..1 | uri |
value | Σ | 0..1 | string |
period | Σ I | 0..1 | Period |
assigner | Σ I | 0..1 | Reference() |
display | Σ | 0..1 | string |
eventHistory | I | 0..* | Reference() |
id | 0..1 | string | |
extension | I | 0..* | Extension |
reference | Σ I | 0..1 | string |
type | Σ | 0..1 | uriBinding |
identifier | Σ | 0..1 | Identifier |
id | 0..1 | string | |
extension | I | 0..* | Extension |
use | Σ ?! | 0..1 | codeBinding |
type | Σ | 0..1 | CodeableConceptBinding |
system | Σ | 0..1 | uri |
value | Σ | 0..1 | string |
period | Σ I | 0..1 | Period |
assigner | Σ I | 0..1 | Reference() |
display | Σ | 0..1 | string |
NHSDigitalMedicationDispense (MedicationDispense) | I | ||
id | Σ | 0..1 | string |
meta | Σ | 0..1 | Meta |
implicitRules | Σ ?! | 0..1 | uri |
language | 0..1 | codeBinding | |
text | 0..1 | Narrative | |
contained | 0..* | Resource | |
extension | I | 1..* | Extension |
prescriptionStatus | S I | 1..1 | Extension(Coding) |
prescriptionNonDispensingReason | S I | 0..1 | Extension(Coding) |
repeatInformation | S I | 0..1 | Extension(Complex) |
supplyHeaderIdentifier | S I | 0..1 | Extension(Identifier) |
modifierExtension | ?! I | 0..* | Extension |
identifier | S | 0..* | Identifier |
id | 0..1 | string | |
extension | I | 0..* | Extension |
use | Σ ?! | 0..1 | codeBinding |
type | Σ | 0..1 | CodeableConceptBinding |
system | Σ | 1..1 | uri |
value | Σ | 1..1 | string |
period | Σ I | 0..1 | Period |
assigner | Σ I | 0..1 | Reference() |
partOf | I | 0..* | Reference() |
id | 0..1 | string | |
extension | I | 0..* | Extension |
reference | Σ I | 0..1 | string |
type | Σ | 0..1 | uriBinding |
identifier | Σ | 0..1 | Identifier |
id | 0..1 | string | |
extension | I | 0..* | Extension |
use | Σ ?! | 0..1 | codeBinding |
type | Σ | 0..1 | CodeableConceptBinding |
system | Σ | 0..1 | uri |
value | Σ | 0..1 | string |
period | Σ I | 0..1 | Period |
assigner | Σ I | 0..1 | Reference() |
display | Σ | 0..1 | string |
status | S Σ ?! | 1..1 | codeBinding |
statusReason[x] | S | 0..1 | |
statusReasonCodeableConcept | CodeableConcept | ||
id | 0..1 | string | |
extension | I | 0..* | Extension |
coding | Σ | 1..* | Coding |
(All Slices) | |||
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | Σ | 1..1 | uri |
version | Σ | 0..1 | string |
code | Σ | 1..1 | code |
display | Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
notDispensedStatusReason | S Σ | 0..* | CodingBinding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | Σ | 0..1 | uriFixed Value |
version | Σ | 0..1 | string |
code | Σ | 0..1 | code |
display | Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
amendmentStatusReason | S Σ | 0..* | CodingBinding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | Σ | 0..1 | uriFixed Value |
version | Σ | 0..1 | string |
code | Σ | 0..1 | code |
display | Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
text | Σ | 0..1 | string |
category | 0..1 | CodeableConceptBinding | |
id | 0..1 | string | |
extension | I | 0..* | Extension |
coding | Σ | 0..* | Coding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | Σ | 1..1 | uri |
version | Σ | 0..1 | string |
code | Σ | 1..1 | code |
display | Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
text | Σ | 0..1 | string |
medication[x] | S Σ | 1..1 | Binding |
medicationCodeableConcept | NHSDigitalMedicationDispenseCodeableConcept | ||
medicationReference | Reference(NHSDigitalMedicationDispenseMedication) | ||
subject | S Σ I | 1..1 | Reference(NHSDigitalPatientPDS) |
id | 0..1 | string | |
extension | I | 0..* | Extension |
reference | Σ I | 0..1 | string |
type | Σ | 0..1 | uriBinding |
identifier | Σ | 0..1 | Identifier |
id | 0..1 | string | |
extension | I | 0..* | Extension |
use | Σ ?! | 0..1 | codeBinding |
type | Σ | 0..1 | CodeableConceptBinding |
system | Σ | 1..1 | uriFixed Value |
value | Σ | 1..1 | string |
period | Σ I | 0..1 | Period |
assigner | Σ I | 0..1 | Reference() |
display | Σ | 0..1 | string |
context | I | 0..1 | Reference( | NHSDigitalEncounter) |
id | 0..1 | string | |
extension | I | 0..* | Extension |
reference | Σ I | 0..1 | string |
type | Σ | 0..1 | uriBinding |
identifier | Σ | 0..1 | Identifier |
id | 0..1 | string | |
extension | I | 0..* | Extension |
use | Σ ?! | 0..1 | codeBinding |
type | Σ | 0..1 | CodeableConceptBinding |
system | Σ | 0..1 | uri |
value | Σ | 0..1 | string |
period | Σ I | 0..1 | Period |
assigner | Σ I | 0..1 | Reference() |
display | Σ | 0..1 | string |
supportingInformation | I | 0..* | Reference(Resource) |
id | 0..1 | string | |
extension | I | 0..* | Extension |
reference | Σ I | 0..1 | string |
type | Σ | 0..1 | uriBinding |
identifier | Σ | 0..1 | Identifier |
id | 0..1 | string | |
extension | I | 0..* | Extension |
use | Σ ?! | 0..1 | codeBinding |
type | Σ | 0..1 | CodeableConceptBinding |
system | Σ | 0..1 | uri |
value | Σ | 0..1 | string |
period | Σ I | 0..1 | Period |
assigner | Σ I | 0..1 | Reference() |
display | Σ | 0..1 | string |
performer | S | 1..* | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
function | 0..1 | CodeableConcept | |
actor | I | 1..1 | NHSDigitalReference(NHSDigitalPractitionerRoleSDS) |
id | 0..1 | string | |
extension | I | 0..* | Extension |
reference | Σ I | 1..1 | string |
type | Σ | 0..1 | uriBinding |
identifier | Σ | 0..1 | NHSDigitalIdentifier |
id | 0..1 | string | |
extension | I | 0..* | Extension |
use | Σ ?! | 0..1 | codeBinding |
type | Σ | 0..1 | CodeableConceptBinding |
system | Σ | 1..1 | uri |
value | Σ | 1..1 | string |
period | Σ I | 0..1 | Period |
assigner | Σ I | 0..1 | Reference() |
display | Σ | 0..1 | string |
location | I | 0..1 | Reference(NHSDigitalLocation) |
id | 0..1 | string | |
extension | I | 0..* | Extension |
reference | Σ I | 0..1 | string |
type | Σ | 0..1 | uriBinding |
identifier | Σ | 0..1 | Identifier |
id | 0..1 | string | |
extension | I | 0..* | Extension |
use | Σ ?! | 0..1 | codeBinding |
type | Σ | 0..1 | CodeableConceptBinding |
system | Σ | 1..1 | uri |
value | Σ | 1..1 | string |
period | Σ I | 0..1 | Period |
assigner | Σ I | 0..1 | Reference() |
display | Σ | 1..1 | string |
authorizingPrescription | S I | 1..* | Reference(NHSDigitalMedicationRequestMinimal) |
id | 0..1 | string | |
extension | I | 0..* | Extension |
reference | Σ I | 1..1 | string |
type | Σ | 0..1 | uriBinding |
identifier | Σ | 0..1 | Identifier |
id | 0..1 | string | |
extension | I | 0..* | Extension |
use | Σ ?! | 0..1 | codeBinding |
type | Σ | 0..1 | CodeableConceptBinding |
system | Σ | 0..1 | uri |
value | Σ | 0..1 | string |
period | Σ I | 0..1 | Period |
assigner | Σ I | 0..1 | Reference() |
display | Σ | 0..1 | string |
type | S | 0..1 | CodeableConceptBinding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
coding | Σ | 0..* | Coding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | Σ | 1..1 | uri |
version | Σ | 0..1 | string |
code | Σ | 1..1 | code |
display | Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
text | Σ | 0..1 | string |
quantity | S I | 1..1 | SimpleQuantity |
id | 0..1 | string | |
extension | I | 0..* | Extension |
runningTotal | I | 0..1 | Extension(Quantity) |
value | Σ | 1..1 | decimal |
comparator | Σ ?! | 0..0 | codeBinding |
unit | Σ | 1..1 | string |
system | Σ I | 1..1 | uri |
code | Σ | 1..1 | code |
daysSupply | S I | 0..1 | SimpleQuantity |
whenPrepared | S Σ | 0..1 | dateTime |
whenHandedOver | S | 0..1 | dateTime |
destination | I | 0..1 | Reference() |
id | 0..1 | string | |
extension | I | 0..* | Extension |
reference | Σ I | 0..1 | string |
type | Σ | 0..1 | uriBinding |
identifier | Σ | 0..1 | Identifier |
id | 0..1 | string | |
extension | I | 0..* | Extension |
use | Σ ?! | 0..1 | codeBinding |
type | Σ | 0..1 | CodeableConceptBinding |
system | Σ | 0..1 | uri |
value | Σ | 0..1 | string |
period | Σ I | 0..1 | Period |
assigner | Σ I | 0..1 | Reference() |
display | Σ | 0..1 | string |
receiver | I | 0..1 | Reference( | ) |
id | 0..1 | string | |
extension | I | 0..* | Extension |
reference | Σ I | 0..1 | string |
type | Σ | 0..1 | uriBinding |
identifier | Σ | 0..1 | Identifier |
id | 0..1 | string | |
extension | I | 0..* | Extension |
use | Σ ?! | 0..1 | codeBinding |
type | Σ | 0..1 | CodeableConceptBinding |
system | Σ | 0..1 | uri |
value | Σ | 0..1 | string |
period | Σ I | 0..1 | Period |
assigner | Σ I | 0..1 | Reference() |
display | Σ | 0..1 | string |
note | 0..* | Annotation | |
id | 0..1 | string | |
extension | I | 0..* | Extension |
author[x] | Σ | 0..1 | |
authorString | string | ||
authorReference | Reference( | | | ) | ||
time | Σ | 0..1 | dateTime |
text | Σ | 1..1 | markdown |
dosageInstruction | S | 0..* | NHSDigitalDosage |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
sequence | Σ | 0..1 | integer |
text | Σ | 0..1 | string |
additionalInstruction | Σ | 0..* | CodeableConcept |
patientInstruction | Σ | 0..1 | string |
timing | Σ | 0..1 | Timing |
asNeeded[x] | Σ | 0..1 | Binding |
asNeededBoolean | boolean | ||
asNeededCodeableConcept | CodeableConcept | ||
site | Σ | 0..1 | CodeableConceptBinding |
route | Σ | 0..1 | CodeableConceptBinding |
method | Σ | 0..1 | CodeableConceptBinding |
doseAndRate | Σ | 0..* | Element |
id | 0..1 | string | |
extension | I | 0..* | Extension |
type | Σ | 0..1 | CodeableConcept |
dose[x] | Σ | 0..1 | |
doseRange | Range | ||
doseQuantity | SimpleQuantity | ||
rate[x] | Σ | 0..1 | |
rateRatio | Ratio | ||
rateRange | Range | ||
rateQuantity | SimpleQuantity | ||
maxDosePerPeriod | Σ I | 0..1 | Ratio |
maxDosePerAdministration | Σ I | 0..1 | SimpleQuantity |
maxDosePerLifetime | Σ I | 0..1 | SimpleQuantity |
substitution | 0..1 | BackboneElement | |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
wasSubstituted | 1..1 | boolean | |
type | 0..1 | CodeableConcept | |
reason | 0..* | CodeableConcept | |
responsibleParty | I | 0..* | Reference( | ) |
id | 0..1 | string | |
extension | I | 0..* | Extension |
reference | Σ I | 0..1 | string |
type | Σ | 0..1 | uriBinding |
identifier | Σ | 0..1 | Identifier |
id | 0..1 | string | |
extension | I | 0..* | Extension |
use | Σ ?! | 0..1 | codeBinding |
type | Σ | 0..1 | CodeableConceptBinding |
system | Σ | 0..1 | uri |
value | Σ | 0..1 | string |
period | Σ I | 0..1 | Period |
assigner | Σ I | 0..1 | Reference() |
display | Σ | 0..1 | string |
detectedIssue | I | 0..* | Reference(DetectedIssue) |
id | 0..1 | string | |
extension | I | 0..* | Extension |
reference | Σ I | 0..1 | string |
type | Σ | 0..1 | uriBinding |
identifier | Σ | 0..1 | Identifier |
id | 0..1 | string | |
extension | I | 0..* | Extension |
use | Σ ?! | 0..1 | codeBinding |
type | Σ | 0..1 | CodeableConceptBinding |
system | Σ | 0..1 | uri |
value | Σ | 0..1 | string |
period | Σ I | 0..1 | Period |
assigner | Σ I | 0..1 | Reference() |
display | Σ | 0..1 | string |
eventHistory | I | 0..* | Reference() |
id | 0..1 | string | |
extension | I | 0..* | Extension |
reference | Σ I | 0..1 | string |
type | Σ | 0..1 | uriBinding |
identifier | Σ | 0..1 | Identifier |
id | 0..1 | string | |
extension | I | 0..* | Extension |
use | Σ ?! | 0..1 | codeBinding |
type | Σ | 0..1 | CodeableConceptBinding |
system | Σ | 0..1 | uri |
value | Σ | 0..1 | string |
period | Σ I | 0..1 | Period |
assigner | Σ I | 0..1 | Reference() |
display | Σ | 0..1 | string |
MedicationDispense | ||||||||||||||||
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...* | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.id | ||||||||||||||||
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 | string | |||||||||||||||
Summary | True | |||||||||||||||
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | |||||||||||||||
MedicationDispense.meta | ||||||||||||||||
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 | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.implicitRules | ||||||||||||||||
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 it's narrative along with other profiles, value sets, etc. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.language | ||||||||||||||||
Definition | The base language in which the resource is written. | |||||||||||||||
Cardinality | 0...1 | |||||||||||||||
Type | code | |||||||||||||||
Binding | 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). | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.text | ||||||||||||||||
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 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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.contained | ||||||||||||||||
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. | |||||||||||||||
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. | |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.extension | ||||||||||||||||
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 manageable, 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 | 1...* | |||||||||||||||
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) | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.extension:prescriptionStatus | ||||||||||||||||
Definition | This is the overall status of the `prescription-order`, it is not the status of the individual prescription item. This is a code from {{pagelink:DM-Task-Status-Reason-duplicate-2}}, all prescription status reasons in a `dispense-notification` FHIR Message Bundle must be the same. ```json "extension": [ { "url": "https://fhir.nhs.uk/StructureDefinition/Extension-EPS-TaskBusinessStatus", "valueCoding": { "system": "https://fhir.nhs.uk/CodeSystem/EPS-task-business-status", "code": "0003", "display": "With Dispenser - Active" } } ] ``` | |||||||||||||||
Cardinality | 1...1 | |||||||||||||||
Type | Extension(Coding) | |||||||||||||||
Must Support | True | |||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.extension:prescriptionNonDispensingReason | ||||||||||||||||
Definition | This is the reason a complete prescription was not dispensed, it is not the status of the individual line items, which is contained in MedicationDispense.statusReason. ```json "extension": [ { "url": "https://fhir.nhs.uk/StructureDefinition/Extension-DM-PrescriptionNonDispensingReason", "valueCoding": { "system": "https://fhir.nhs.uk/CodeSystem/medicationdispense-status-reason", "code": "0002", "display": "Clinically unsuitable" } } ] ``` | |||||||||||||||
Cardinality | 0...1 | |||||||||||||||
Type | Extension(Coding) | |||||||||||||||
Must Support | True | |||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.extension:repeatInformation | ||||||||||||||||
Definition | The extension is mandatory for `continuous` and `continuous-repeat-dispensing`. The following elements **MUST** be populated - numberofRepeatsAllowed - numberOfRepeatsIssued ```json "extension": [ { "url": "https://fhir.nhs.uk/StructureDefinition/Extension-EPS-RepeatInformation", "extension": [ { "url" : "numberOfRepeatsAllowed", "valueInteger" : 3 }, { "url" : "numberOfRepeatsIssued", "valueInteger" : 2 } ] } ] ``` | |||||||||||||||
Cardinality | 0...1 | |||||||||||||||
Type | Extension(Complex) | |||||||||||||||
Must Support | True | |||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.extension:supplyHeaderIdentifier | ||||||||||||||||
Definition | Identifier of the SupplyHeader (v3) object. The prescription in the context of a Dispense Notification or Claim. Mandatory for EPS interactions. | |||||||||||||||
Cardinality | 0...1 | |||||||||||||||
Type | Extension(Identifier) | |||||||||||||||
Must Support | True | |||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.modifierExtension | ||||||||||||||||
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 manageable, 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...* | |||||||||||||||
Type | Extension | |||||||||||||||
Modifier | 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) | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.identifier | ||||||||||||||||
Definition | Each MedicationDispense **MUST** be identified by an Universal Unique Identifiers (UUIDs) with a system of `https://fhir.nhs.uk/Id/prescription-dispense-item-number` UUID example (for illustration purposes only); **4509B70D-D8B8-EA03-1105-64557CB54A29** ```json "identifier": [ { "system": "https://fhir.nhs.uk/Id/prescription-dispense-item-number", "value": "4509B70D-D8B8-EA03-1105-64557CB54A29" } ] ``` | |||||||||||||||
Cardinality | 0...* | |||||||||||||||
Type | Identifier | |||||||||||||||
Must Support | True | |||||||||||||||
Comments | This is a business identifier, not a resource identifier. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.identifier.id | ||||||||||||||||
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 | |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.identifier.extension | ||||||||||||||||
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 manageable, 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) | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.identifier.use | ||||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.identifier.type | ||||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.identifier.system | ||||||||||||||||
Definition | Establishes the namespace for the value - that is, a 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. | |||||||||||||||
Invariants |
| |||||||||||||||
Examples | General http://www.acme.com/identifiers/patient | |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.identifier.value | ||||||||||||||||
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 Rendered Value extension. 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. | |||||||||||||||
Invariants |
| |||||||||||||||
Examples | General 123456 | |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.identifier.period | ||||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.identifier.assigner | ||||||||||||||||
Definition | Organization that issued/manages the identifier. | |||||||||||||||
Cardinality | 0...1 | |||||||||||||||
Type | Reference() | |||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.partOf | ||||||||||||||||
Definition | The procedure that trigger the dispense. | |||||||||||||||
Cardinality | 0...* | |||||||||||||||
Type | Reference() | |||||||||||||||
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.partOf.id | ||||||||||||||||
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 | |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.partOf.extension | ||||||||||||||||
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 manageable, 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) | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.partOf.reference | ||||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.partOf.type | ||||||||||||||||
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 RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.partOf.identifier | ||||||||||||||||
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). | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.partOf.identifier.id | ||||||||||||||||
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 | |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.partOf.identifier.extension | ||||||||||||||||
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 manageable, 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) | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.partOf.identifier.use | ||||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.partOf.identifier.type | ||||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.partOf.identifier.system | ||||||||||||||||
Definition | Establishes the namespace for the value - that is, a 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. | |||||||||||||||
Invariants |
| |||||||||||||||
Examples | General http://www.acme.com/identifiers/patient | |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.partOf.identifier.value | ||||||||||||||||
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 Rendered Value extension. 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. | |||||||||||||||
Invariants |
| |||||||||||||||
Examples | General 123456 | |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.partOf.identifier.period | ||||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.partOf.identifier.assigner | ||||||||||||||||
Definition | Organization that issued/manages the identifier. | |||||||||||||||
Cardinality | 0...1 | |||||||||||||||
Type | Reference() | |||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.partOf.display | ||||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.status | ||||||||||||||||
Definition | The status of the individual medication item, this will normally indicate whether the medication has been picked up or not. | Code | Display | Definition | |--|--|--| | completed | Completed | The dispensed product has been picked up. | | in-progress | In Progress | The dispensed product is ready for pickup. | | |||||||||||||||
Cardinality | 1...1 | |||||||||||||||
Type | code | |||||||||||||||
Binding | A coded concept specifying the state of the dispense event. | |||||||||||||||
Must Support | True | |||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.statusReason[x] | ||||||||||||||||
Definition | Indicates the reason why a dispense was not performed. | |||||||||||||||
Cardinality | 0...1 | |||||||||||||||
Type | CodeableConcept | |||||||||||||||
Binding | A code describing why a dispense was not performed. | |||||||||||||||
Must Support | True | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.statusReason[x].id | ||||||||||||||||
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 | |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.statusReason[x].extension | ||||||||||||||||
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 manageable, 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) | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.statusReason[x].coding | ||||||||||||||||
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. | |||||||||||||||
Slicing | Unordered, Open, by system(Value) | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.statusReason[x].coding.id | ||||||||||||||||
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 | |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.statusReason[x].coding.extension | ||||||||||||||||
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 manageable, 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) | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.statusReason[x].coding.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 reference to some definition that establishes the system clearly and unambiguously. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.statusReason[x].coding.version | ||||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.statusReason[x].coding.code | ||||||||||||||||
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 1MB in size | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.statusReason[x].coding.display | ||||||||||||||||
Definition | A representation of the meaning of the code in the system, following the rules of the system. | |||||||||||||||
Cardinality | 0...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 1MB in size | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.statusReason[x].coding.userSelected | ||||||||||||||||
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...1 | |||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.statusReason[x].coding:notDispensedStatusReason | ||||||||||||||||
Definition | A reference to a code defined by a terminology system. | |||||||||||||||
Cardinality | 0...* | |||||||||||||||
Type | Coding | |||||||||||||||
Binding | MedicationDispenseStatusReason (required) | |||||||||||||||
Must Support | True | |||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.statusReason[x].coding:notDispensedStatusReason.id | ||||||||||||||||
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 | |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.statusReason[x].coding:notDispensedStatusReason.extension | ||||||||||||||||
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 manageable, 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) | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.statusReason[x].coding:notDispensedStatusReason.system | ||||||||||||||||
Definition | The identification of the code system that defines the meaning of the symbol in the code. | |||||||||||||||
Cardinality | 0...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 reference to some definition that establishes the system clearly and unambiguously. | |||||||||||||||
Invariants |
| |||||||||||||||
Fixed Value | https://fhir.nhs.uk/CodeSystem/medicationdispense-status-reason | |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.statusReason[x].coding:notDispensedStatusReason.version | ||||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.statusReason[x].coding:notDispensedStatusReason.code | ||||||||||||||||
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 | 0...1 | |||||||||||||||
Type | code | |||||||||||||||
Summary | True | |||||||||||||||
Requirements | Need to refer to a particular code in the system. | |||||||||||||||
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.statusReason[x].coding:notDispensedStatusReason.display | ||||||||||||||||
Definition | A representation of the meaning of the code in the system, following the rules of the system. | |||||||||||||||
Cardinality | 0...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 1MB in size | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.statusReason[x].coding:notDispensedStatusReason.userSelected | ||||||||||||||||
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...1 | |||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.statusReason[x].coding:amendmentStatusReason | ||||||||||||||||
Definition | A reference to a code defined by a terminology system. | |||||||||||||||
Cardinality | 0...* | |||||||||||||||
Type | Coding | |||||||||||||||
Binding | TaskReasonCode (required) | |||||||||||||||
Must Support | True | |||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.statusReason[x].coding:amendmentStatusReason.id | ||||||||||||||||
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 | |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.statusReason[x].coding:amendmentStatusReason.extension | ||||||||||||||||
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 manageable, 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) | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.statusReason[x].coding:amendmentStatusReason.system | ||||||||||||||||
Definition | The identification of the code system that defines the meaning of the symbol in the code. | |||||||||||||||
Cardinality | 0...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 reference to some definition that establishes the system clearly and unambiguously. | |||||||||||||||
Invariants |
| |||||||||||||||
Fixed Value | https://fhir.nhs.uk/CodeSystem/EPS-task-dispense-withdraw-reason | |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.statusReason[x].coding:amendmentStatusReason.version | ||||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.statusReason[x].coding:amendmentStatusReason.code | ||||||||||||||||
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 | 0...1 | |||||||||||||||
Type | code | |||||||||||||||
Summary | True | |||||||||||||||
Requirements | Need to refer to a particular code in the system. | |||||||||||||||
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.statusReason[x].coding:amendmentStatusReason.display | ||||||||||||||||
Definition | A representation of the meaning of the code in the system, following the rules of the system. | |||||||||||||||
Cardinality | 0...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 1MB in size | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.statusReason[x].coding:amendmentStatusReason.userSelected | ||||||||||||||||
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...1 | |||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.statusReason[x].text | ||||||||||||||||
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...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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.category | ||||||||||||||||
Definition | Indicates the type of medication dispense (for example, where the medication is expected to be consumed or administered (i.e. inpatient or outpatient)). | |||||||||||||||
Cardinality | 0...1 | |||||||||||||||
Type | CodeableConcept | |||||||||||||||
Binding | A code describing where the dispensed medication is expected to be consumed or administered. | |||||||||||||||
Comments | The category can be used to include where the medication is expected to be consumed or other types of dispenses. Invariants can be used to bind to different value sets when profiling to bind. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.category.id | ||||||||||||||||
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 | |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.category.extension | ||||||||||||||||
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 manageable, 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) | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.category.coding | ||||||||||||||||
Definition | A reference to a code defined by a terminology system. | |||||||||||||||
Cardinality | 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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.category.coding.id | ||||||||||||||||
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 | |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.category.coding.extension | ||||||||||||||||
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 manageable, 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) | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.category.coding.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 reference to some definition that establishes the system clearly and unambiguously. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.category.coding.version | ||||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.category.coding.code | ||||||||||||||||
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 1MB in size | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.category.coding.display | ||||||||||||||||
Definition | A representation of the meaning of the code in the system, following the rules of the system. | |||||||||||||||
Cardinality | 0...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 1MB in size | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.category.coding.userSelected | ||||||||||||||||
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...1 | |||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.category.text | ||||||||||||||||
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...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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.medication[x] | ||||||||||||||||
Definition | Actual Medical Product Packs (AMPP) SHOULD be used.
It is valid to include a FHIR Medication resource within the FHIR Message, this practice is discouraged to simplify handling of the event messages.
```json "medicationCodeableConcept": { "coding": [ { "system": "http://snomed.info/sct", "code": "10460811000001109", "display": "Amoxil 500mg capsules (Dowelhurst Ltd) 12 capsule" } ] } ``` | |||||||||||||||
Cardinality | 1...1 | |||||||||||||||
Type | NHSDigitalMedicationDispenseCodeableConcept | |||||||||||||||
Binding | A coded concept identifying which substance or product can be dispensed. | |||||||||||||||
Must Support | True | |||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.subject | ||||||||||||||||
Definition | A reference to the patient via a traced NHS Number is required, an untraced NHS Number MUST NOT be used. This can be sent in two ways, first option is via a `identifier reference`. Only the NHS Number: ```json "subject": { "type": "Patient", "identifier": { "system": "https://fhir.nhs.uk/Id/nhs-number", "value": "2300992742" } } ``` Second option uses a FHIR Patient resource to convey the NHS Number. The reference in the MedicationDispesnse is now a `resource reference`. ```json "subject": { "type": "Patient", "reference": "urn:uuid:bde9eba6-079f-4210-8108-6ea8db58de8c", "display": "Miss Bernie Kanfeld" } ``` The NHS Number has moved to the Patient resource alongside other patient identifiers such as MRN. E.g. ```json "fullUrl": "urn:uuid:bde9eba6-079f-4210-8108-6ea8db58de8c", "resource": { "resourceType": "Patient", "identifier": [ { "extension": [ { "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus", "valueCodeableConcept": { "coding": [ { "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatus", "code": "01", "display": "Number present and verified" } ] } } ], "system": "https://fhir.nhs.uk/Id/nhs-number", "value": "9876543210" }, { "system": "https://fhir.leedsth.nhs.uk/Id/pas-number", "value": "ABC8650149" }, { "system": "https://fhir.leedsth.nhs.uk/Id/PPMIdentifier", "value": "1" } ], ... other elements removed from example. } ``` It is anticipated that hospital pharmacies will prefer the later option for compatibility with other systems. Community pharmacies are anticipated to prefer the former option. | |||||||||||||||
Cardinality | 1...1 | |||||||||||||||
Type | Reference(NHSDigitalPatientPDS) | |||||||||||||||
Must Support | True | |||||||||||||||
Summary | True | |||||||||||||||
Comments | SubstanceAdministration->subject->Patient. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.subject.id | ||||||||||||||||
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 | |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.subject.extension | ||||||||||||||||
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 manageable, 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) | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.subject.reference | ||||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.subject.type | ||||||||||||||||
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 RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.subject.identifier | ||||||||||||||||
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). | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.subject.identifier.id | ||||||||||||||||
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 | |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.subject.identifier.extension | ||||||||||||||||
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 manageable, 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) | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.subject.identifier.use | ||||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.subject.identifier.type | ||||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.subject.identifier.system | ||||||||||||||||
Definition | Establishes the namespace for the value - that is, a 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. | |||||||||||||||
Invariants |
| |||||||||||||||
Fixed Value | https://fhir.nhs.uk/Id/nhs-number | |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.subject.identifier.value | ||||||||||||||||
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 Rendered Value extension. 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. | |||||||||||||||
Invariants |
| |||||||||||||||
Examples | General 123456 | |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.subject.identifier.period | ||||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.subject.identifier.assigner | ||||||||||||||||
Definition | Organization that issued/manages the identifier. | |||||||||||||||
Cardinality | 0...1 | |||||||||||||||
Type | Reference() | |||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.subject.display | ||||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.context | ||||||||||||||||
Definition | The encounter or episode of care that establishes the context for this event. | |||||||||||||||
Cardinality | 0...1 | |||||||||||||||
Type | Reference( | NHSDigitalEncounter) | |||||||||||||||
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.context.id | ||||||||||||||||
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 | |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.context.extension | ||||||||||||||||
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 manageable, 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) | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.context.reference | ||||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.context.type | ||||||||||||||||
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 RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.context.identifier | ||||||||||||||||
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). | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.context.identifier.id | ||||||||||||||||
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 | |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.context.identifier.extension | ||||||||||||||||
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 manageable, 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) | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.context.identifier.use | ||||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.context.identifier.type | ||||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.context.identifier.system | ||||||||||||||||
Definition | Establishes the namespace for the value - that is, a 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. | |||||||||||||||
Invariants |
| |||||||||||||||
Examples | General http://www.acme.com/identifiers/patient | |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.context.identifier.value | ||||||||||||||||
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 Rendered Value extension. 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. | |||||||||||||||
Invariants |
| |||||||||||||||
Examples | General 123456 | |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.context.identifier.period | ||||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.context.identifier.assigner | ||||||||||||||||
Definition | Organization that issued/manages the identifier. | |||||||||||||||
Cardinality | 0...1 | |||||||||||||||
Type | Reference() | |||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.context.display | ||||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.supportingInformation | ||||||||||||||||
Definition | Additional information that supports the medication being dispensed. | |||||||||||||||
Cardinality | 0...* | |||||||||||||||
Type | Reference(Resource) | |||||||||||||||
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.supportingInformation.id | ||||||||||||||||
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 | |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.supportingInformation.extension | ||||||||||||||||
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 manageable, 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) | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.supportingInformation.reference | ||||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.supportingInformation.type | ||||||||||||||||
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 RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.supportingInformation.identifier | ||||||||||||||||
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). | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.supportingInformation.identifier.id | ||||||||||||||||
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 | |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.supportingInformation.identifier.extension | ||||||||||||||||
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 manageable, 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) | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.supportingInformation.identifier.use | ||||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.supportingInformation.identifier.type | ||||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.supportingInformation.identifier.system | ||||||||||||||||
Definition | Establishes the namespace for the value - that is, a 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. | |||||||||||||||
Invariants |
| |||||||||||||||
Examples | General http://www.acme.com/identifiers/patient | |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.supportingInformation.identifier.value | ||||||||||||||||
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 Rendered Value extension. 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. | |||||||||||||||
Invariants |
| |||||||||||||||
Examples | General 123456 | |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.supportingInformation.identifier.period | ||||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.supportingInformation.identifier.assigner | ||||||||||||||||
Definition | Organization that issued/manages the identifier. | |||||||||||||||
Cardinality | 0...1 | |||||||||||||||
Type | Reference() | |||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.supportingInformation.display | ||||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.performer | ||||||||||||||||
Definition | The pharmacist and pharmacy MUST be present and MUST use `identifier references`. This means FHIR Practitioner, Organization and PractitionerRole resource are not included in the FHIR Message. Professional codes and ODS codes should be used instead. `sds-user-role-id` is permitted to identify a Practitioner(& Role) but professional codes are preferred to support wider NHS interoperability. ```json "performer": [ { "actor": { "reference" : "#performer" } } ], ``` The contained PractitionerRole: ```json { "resourceType": "MedicationDispense", "id": "06167339-9337-d030-0366-514a6a46da17", "contained": [ { "resourceType": "PractitionerRole", "id": "performer", "identifier": [ { "system": "https://fhir.nhs.uk/Id/sds-role-profile-id", "value": "741555508105" } ], "code": [ { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/NHSDigital-SDS-JobRoleCode", "code": "S0030:G0100:R0620" } ] } ], "practitioner": { "identifier": { "system": "https://fhir.nhs.uk/Id/sds-user-id", "value": "7654321" }, "display": "Mr Peter Potion" }, "organization": { "reference": "urn:uuid:2bf9f37c-d88b-4f86-ad5f-373c1416e04b" }, "telecom": [ { "system": "phone", "use": "work", "value": "0532567890" } ] } ], ``` | |||||||||||||||
Cardinality | 1...* | |||||||||||||||
Type | BackboneElement | |||||||||||||||
Must Support | True | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.performer.id | ||||||||||||||||
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 | |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.performer.extension | ||||||||||||||||
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 manageable, 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) | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.performer.modifierExtension | ||||||||||||||||
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 manageable, 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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.performer.function | ||||||||||||||||
Definition | Distinguishes the type of performer in the dispense. For example, date enterer, packager, final checker. | |||||||||||||||
Cardinality | 0...1 | |||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.performer.actor | ||||||||||||||||
Definition | A reference from one resource to another. | |||||||||||||||
Cardinality | 1...1 | |||||||||||||||
Type | NHSDigitalReference(NHSDigitalPractitionerRoleSDS) | |||||||||||||||
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.performer.actor.id | ||||||||||||||||
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 | |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.performer.actor.extension | ||||||||||||||||
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 manageable, 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) | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.performer.actor.reference | ||||||||||||||||
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 | 1...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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.performer.actor.type | ||||||||||||||||
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 RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.performer.actor.identifier | ||||||||||||||||
Definition | An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. | |||||||||||||||
Cardinality | 0...1 | |||||||||||||||
Type | NHSDigitalIdentifier | |||||||||||||||
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). | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.performer.actor.identifier.id | ||||||||||||||||
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 | |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.performer.actor.identifier.extension | ||||||||||||||||
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 manageable, 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) | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.performer.actor.identifier.use | ||||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.performer.actor.identifier.type | ||||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.performer.actor.identifier.system | ||||||||||||||||
Definition | Establishes the namespace for the value - that is, a 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. | |||||||||||||||
Invariants |
| |||||||||||||||
Examples | General http://www.acme.com/identifiers/patient | |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.performer.actor.identifier.value | ||||||||||||||||
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 Rendered Value extension. 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. | |||||||||||||||
Invariants |
| |||||||||||||||
Examples | General 123456 | |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.performer.actor.identifier.period | ||||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.performer.actor.identifier.assigner | ||||||||||||||||
Definition | Organization that issued/manages the identifier. | |||||||||||||||
Cardinality | 0...1 | |||||||||||||||
Type | Reference() | |||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.performer.actor.display | ||||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.location | ||||||||||||||||
Definition | The principal physical location where the dispense was performed. | |||||||||||||||
Cardinality | 0...1 | |||||||||||||||
Type | Reference(NHSDigitalLocation) | |||||||||||||||
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.location.id | ||||||||||||||||
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 | |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.location.extension | ||||||||||||||||
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 manageable, 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) | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.location.reference | ||||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.location.type | ||||||||||||||||
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 RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.location.identifier | ||||||||||||||||
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). | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.location.identifier.id | ||||||||||||||||
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 | |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.location.identifier.extension | ||||||||||||||||
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 manageable, 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) | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.location.identifier.use | ||||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.location.identifier.type | ||||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.location.identifier.system | ||||||||||||||||
Definition | Establishes the namespace for the value - that is, a 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. | |||||||||||||||
Invariants |
| |||||||||||||||
Examples | General http://www.acme.com/identifiers/patient | |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.location.identifier.value | ||||||||||||||||
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 Rendered Value extension. 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. | |||||||||||||||
Invariants |
| |||||||||||||||
Examples | General 123456 | |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.location.identifier.period | ||||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.location.identifier.assigner | ||||||||||||||||
Definition | Organization that issued/manages the identifier. | |||||||||||||||
Cardinality | 0...1 | |||||||||||||||
Type | Reference() | |||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.location.display | ||||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.authorizingPrescription | ||||||||||||||||
Definition | A reference to the `MedicationRequest`. ```json "authorizingPrescription": [ { "reference": "#m1" } ] ``` When a MedicationDispesne is sent in a FHIR Message bundle, which is the case with EPS NextGen `dispense-notifications`, a contained MedicationRequest is required. This MedicationRequest **MUST** follow the rules in [NHSDigital-MedicationRequest](https://simplifier.net/resolve?target=simplifier&scope=uk.nhsdigital.r4&canonical=https://fhir.nhs.uk/StructureDefinition/NHSDigital-MedicationRequest) and it is strongly recommended to reuse the `MedicationRequest` received when the prescription was downloaded. For example: ```json { "resourceType": "MedicationDispense", "contained": [ { "resourceType": "MedicationRequest", "id": "m1", "identifier": [ { "system": "https://fhir.nhs.uk/Id/prescription-order-item-number", "value": "299c610b-f4f1-4eac-a7d7-4fb6b0556e11" } ], "status": "active", "intent": "order", "medicationCodeableConcept": { "coding": [ { "system": "http://snomed.info/sct", "code": "39720311000001101", "display": "Paracetamol 500mg soluble tablets" } ] }, "subject": { "identifier": { "system": "https://fhir.nhs.uk/Id/nhs-number", "value": "9876543210" } }, "groupIdentifier": { "extension": [ { "url": "https://fhir.nhs.uk/StructureDefinition/Extension-DM-PrescriptionId", "valueIdentifier": { "system": "https://fhir.nhs.uk/Id/prescription", "value": "b2fc79f0-2793-4736-9b2d-0976c21e73a5" } } ], "system": "https://fhir.nhs.uk/Id/prescription-order-number", "value": "82D996-C81010-11DB12" }, "dispenseRequest": { "quantity": { "value": 100, "unit": "tablet", "system": "http://snomed.info/sct", "code": "732936001" } }, "substitution": { "allowedBoolean": false } } ], "authorizingPrescription": [ { "reference": "#m1" } ], ``` This is based on a `MedicationRequest` in this implementation guide. The uuid resource references are not permitted and must be replaced with identifier references. E.g. in this section from the `$release` ```json "subject": { "reference": "urn:uuid:78d3c2eb-009e-4ec8-a358-b042954aa9b2" }, "authoredOn": "2020-12-21T18:15:29+00:00", "requester": { "reference": "urn:uuid:56166769-c1c4-4d07-afa8-132b5dfca666" }, ``` The requester reference can be removed and the subject reference changed to use the Patient's NHSNumber e.g. ```json "subject": { "identifier": { "system": "https://fhir.nhs.uk/Id/nhs-number", "value": "9876543210" } }, ``` | |||||||||||||||
Cardinality | 1...* | |||||||||||||||
Type | Reference(NHSDigitalMedicationRequestMinimal) | |||||||||||||||
Must Support | True | |||||||||||||||
Comments | Maps to basedOn in Event logical model. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.authorizingPrescription.id | ||||||||||||||||
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 | |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.authorizingPrescription.extension | ||||||||||||||||
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 manageable, 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) | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.authorizingPrescription.reference | ||||||||||||||||
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 | 1...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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.authorizingPrescription.type | ||||||||||||||||
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 RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.authorizingPrescription.identifier | ||||||||||||||||
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). | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.authorizingPrescription.identifier.id | ||||||||||||||||
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 | |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.authorizingPrescription.identifier.extension | ||||||||||||||||
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 manageable, 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) | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.authorizingPrescription.identifier.use | ||||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.authorizingPrescription.identifier.type | ||||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.authorizingPrescription.identifier.system | ||||||||||||||||
Definition | Establishes the namespace for the value - that is, a 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. | |||||||||||||||
Invariants |
| |||||||||||||||
Examples | General http://www.acme.com/identifiers/patient | |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.authorizingPrescription.identifier.value | ||||||||||||||||
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 Rendered Value extension. 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. | |||||||||||||||
Invariants |
| |||||||||||||||
Examples | General 123456 | |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.authorizingPrescription.identifier.period | ||||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.authorizingPrescription.identifier.assigner | ||||||||||||||||
Definition | Organization that issued/manages the identifier. | |||||||||||||||
Cardinality | 0...1 | |||||||||||||||
Type | Reference() | |||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.authorizingPrescription.display | ||||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.type | ||||||||||||||||
Definition | Indicates the type of dispensing event that is performed. For example, Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc. ```json "type": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/medicationdispense-type", "code": "0001", "display": "Item fully dispensed" } ] } ``` | |||||||||||||||
Cardinality | 0...1 | |||||||||||||||
Type | CodeableConcept | |||||||||||||||
Binding | A ValueSet to identify the type of medication item status. | |||||||||||||||
Must Support | 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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.type.id | ||||||||||||||||
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 | |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.type.extension | ||||||||||||||||
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 manageable, 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) | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.type.coding | ||||||||||||||||
Definition | A reference to a code defined by a terminology system. | |||||||||||||||
Cardinality | 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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.type.coding.id | ||||||||||||||||
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 | |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.type.coding.extension | ||||||||||||||||
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 manageable, 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) | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.type.coding.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 reference to some definition that establishes the system clearly and unambiguously. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.type.coding.version | ||||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.type.coding.code | ||||||||||||||||
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 1MB in size | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.type.coding.display | ||||||||||||||||
Definition | A representation of the meaning of the code in the system, following the rules of the system. | |||||||||||||||
Cardinality | 0...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 1MB in size | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.type.coding.userSelected | ||||||||||||||||
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...1 | |||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.type.text | ||||||||||||||||
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...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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.quantity | ||||||||||||||||
Definition | The amount of medication that has been dispensed. Includes unit of measure. ```json "quantity": { "value": 28, "unit": "capsule", "system": "http://snomed.info/sct", "code": "3316911000001105" } ``` If no actual quantity has been dispensed then use a value of zero. | |||||||||||||||
Cardinality | 1...1 | |||||||||||||||
Type | SimpleQuantity | |||||||||||||||
Must Support | True | |||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.quantity.id | ||||||||||||||||
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 | |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.quantity.extension | ||||||||||||||||
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 manageable, 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) | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.quantity.extension:runningTotal | ||||||||||||||||
Definition | Optional Extension Element - found in all resources. | |||||||||||||||
Cardinality | 0...1 | |||||||||||||||
Type | Extension(Quantity) | |||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.quantity.value | ||||||||||||||||
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). | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.quantity.comparator | ||||||||||||||||
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 1MB in size | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.quantity.unit | ||||||||||||||||
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 1MB in size | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.quantity.system | ||||||||||||||||
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 | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.quantity.code | ||||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.daysSupply | ||||||||||||||||
Definition | The amount of medication expressed as a timing amount. ```json "daysSupply": { "value": 7, "unit": "Day", "system": "http://unitsofmeasure.org", "code": "d" } ``` | |||||||||||||||
Cardinality | 0...1 | |||||||||||||||
Type | SimpleQuantity | |||||||||||||||
Must Support | True | |||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.whenPrepared | ||||||||||||||||
Definition | The time when the dispensed product was packaged and reviewed. ```json "whenPrepared": "2004-09-16T16:30:00+00:00" ``` | |||||||||||||||
Cardinality | 0...1 | |||||||||||||||
Type | dateTime | |||||||||||||||
Must Support | True | |||||||||||||||
Summary | True | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.whenHandedOver | ||||||||||||||||
Definition | The time the dispensed product was provided to the patient or their representative. In HL7 v3 this is: *The date and local time that the medication is issued by the dispenser*. ```json "whenHandedOver": "2004-09-16T16:30:00+00:00" ``` | |||||||||||||||
Cardinality | 0...1 | |||||||||||||||
Type | dateTime | |||||||||||||||
Must Support | True | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.destination | ||||||||||||||||
Definition | Identification of the facility/location where the medication was shipped to, as part of the dispense event. | |||||||||||||||
Cardinality | 0...1 | |||||||||||||||
Type | Reference() | |||||||||||||||
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.destination.id | ||||||||||||||||
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 | |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.destination.extension | ||||||||||||||||
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 manageable, 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) | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.destination.reference | ||||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.destination.type | ||||||||||||||||
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 RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.destination.identifier | ||||||||||||||||
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). | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.destination.identifier.id | ||||||||||||||||
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 | |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.destination.identifier.extension | ||||||||||||||||
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 manageable, 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) | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.destination.identifier.use | ||||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.destination.identifier.type | ||||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.destination.identifier.system | ||||||||||||||||
Definition | Establishes the namespace for the value - that is, a 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. | |||||||||||||||
Invariants |
| |||||||||||||||
Examples | General http://www.acme.com/identifiers/patient | |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.destination.identifier.value | ||||||||||||||||
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 Rendered Value extension. 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. | |||||||||||||||
Invariants |
| |||||||||||||||
Examples | General 123456 | |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.destination.identifier.period | ||||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.destination.identifier.assigner | ||||||||||||||||
Definition | Organization that issued/manages the identifier. | |||||||||||||||
Cardinality | 0...1 | |||||||||||||||
Type | Reference() | |||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.destination.display | ||||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.receiver | ||||||||||||||||
Definition | Identifies the person who picked up the medication. This will usually be a patient or their caregiver, but some cases exist where it can be a healthcare professional. | |||||||||||||||
Cardinality | 0...1 | |||||||||||||||
Type | Reference( | ) | |||||||||||||||
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.receiver.id | ||||||||||||||||
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 | |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.receiver.extension | ||||||||||||||||
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 manageable, 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) | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.receiver.reference | ||||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.receiver.type | ||||||||||||||||
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 RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.receiver.identifier | ||||||||||||||||
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). | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.receiver.identifier.id | ||||||||||||||||
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 | |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.receiver.identifier.extension | ||||||||||||||||
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 manageable, 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) | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.receiver.identifier.use | ||||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.receiver.identifier.type | ||||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.receiver.identifier.system | ||||||||||||||||
Definition | Establishes the namespace for the value - that is, a 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. | |||||||||||||||
Invariants |
| |||||||||||||||
Examples | General http://www.acme.com/identifiers/patient | |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.receiver.identifier.value | ||||||||||||||||
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 Rendered Value extension. 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. | |||||||||||||||
Invariants |
| |||||||||||||||
Examples | General 123456 | |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.receiver.identifier.period | ||||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.receiver.identifier.assigner | ||||||||||||||||
Definition | Organization that issued/manages the identifier. | |||||||||||||||
Cardinality | 0...1 | |||||||||||||||
Type | Reference() | |||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.receiver.display | ||||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.note | ||||||||||||||||
Definition | Extra information about the dispense that could not be conveyed in the other attributes. | |||||||||||||||
Cardinality | 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). | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.note.id | ||||||||||||||||
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 | |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.note.extension | ||||||||||||||||
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 manageable, 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) | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.note.author[x] | ||||||||||||||||
Definition | The individual responsible for making the annotation. | |||||||||||||||
Cardinality | 0...1 | |||||||||||||||
Type | Reference( | | | ) | |||||||||||||||
Summary | True | |||||||||||||||
Comments | Organization is used when there's no need for specific attribution as to who made the comment. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.note.time | ||||||||||||||||
Definition | Indicates when this particular annotation was made. | |||||||||||||||
Cardinality | 0...1 | |||||||||||||||
Type | dateTime | |||||||||||||||
Summary | True | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.note.text | ||||||||||||||||
Definition | The text of the annotation in markdown format. | |||||||||||||||
Cardinality | 1...1 | |||||||||||||||
Type | markdown | |||||||||||||||
Summary | True | |||||||||||||||
Comments | Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/ | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.dosageInstruction | ||||||||||||||||
Definition | At present only the `text` element **MUST** be provided. It is recommended the guidance in [FHIR Dose Syntax Implementation Guidance](https://developer.nhs.uk/apis/dose-syntax-implementation-1-3-2-alpha/dosage-overview.html) is followed. Note the structure of this section is similar as the [NHSDigital-MedicationRequest](https://simplifier.net/resolve?target=simplifier&scope=uk.nhsdigital.r4&canonical=https://fhir.nhs.uk/StructureDefinition/NHSDigital-MedicationRequest) from the `prescription-order`. ```json "dosageInstruction": [ { "text": "4 times a day for 7 days", "timing": { "repeat": { "boundsDuration": { "value": 7, "unit": "d" }, "frequency": 4, "period": 1, "periodUnit": "d" } }, "doseAndRate": [ { "doseQuantity": { "value": 1, "unit": "capsule", "system": "http://snomed.info/sct", "code": "3316911000001105" } } ] } ] ``` | |||||||||||||||
Cardinality | 0...* | |||||||||||||||
Type | NHSDigitalDosage | |||||||||||||||
Must Support | True | |||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.dosageInstruction.id | ||||||||||||||||
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 | |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.dosageInstruction.extension | ||||||||||||||||
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 manageable, 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) | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.dosageInstruction.modifierExtension | ||||||||||||||||
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 manageable, 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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.dosageInstruction.sequence | ||||||||||||||||
Definition | Indicates the order in which the dosage instructions should be applied or interpreted. | |||||||||||||||
Cardinality | 0...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 | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.dosageInstruction.text | ||||||||||||||||
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 1MB in size | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.dosageInstruction.additionalInstruction | ||||||||||||||||
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...* | |||||||||||||||
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 "immediately following drug x") should be populated in dosage.text. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.dosageInstruction.patientInstruction | ||||||||||||||||
Definition | Instructions in terms that are understood by the patient or consumer. | |||||||||||||||
Cardinality | 0...1 | |||||||||||||||
Type | string | |||||||||||||||
Summary | True | |||||||||||||||
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.dosageInstruction.timing | ||||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.dosageInstruction.asNeeded[x] | ||||||||||||||||
Definition | Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option), or it indicates the precondition for taking the Medication (CodeableConcept). | |||||||||||||||
Cardinality | 0...1 | |||||||||||||||
Type | boolean | |||||||||||||||
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" without a reason by setting the Boolean = True. In this case the CodeableConcept is not populated. Or you can express "as needed" with a reason by including the CodeableConcept. In this case the Boolean is assumed to be True. If you set the Boolean to False, then the dose is given according to the schedule and is not "prn" or "as needed". | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.dosageInstruction.site | ||||||||||||||||
Definition | Body site to administer to. | |||||||||||||||
Cardinality | 0...1 | |||||||||||||||
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 bodySite. May be a summary code, or a reference to a very precise definition of the location, or both. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.dosageInstruction.route | ||||||||||||||||
Definition | How drug should enter body. | |||||||||||||||
Cardinality | 0...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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.dosageInstruction.method | ||||||||||||||||
Definition | Technique for administering medication. | |||||||||||||||
Cardinality | 0...1 | |||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.dosageInstruction.doseAndRate | ||||||||||||||||
Definition | The amount of medication administered. | |||||||||||||||
Cardinality | 0...* | |||||||||||||||
Type | Element | |||||||||||||||
Summary | True | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.dosageInstruction.doseAndRate.id | ||||||||||||||||
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 | |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.dosageInstruction.doseAndRate.extension | ||||||||||||||||
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 manageable, 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) | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.dosageInstruction.doseAndRate.type | ||||||||||||||||
Definition | The kind of dose or rate specified, for example, ordered or calculated. | |||||||||||||||
Cardinality | 0...1 | |||||||||||||||
Type | CodeableConcept | |||||||||||||||
Binding | The kind of dose or rate specified. | |||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.dosageInstruction.doseAndRate.dose[x] | ||||||||||||||||
Definition | Amount of medication per dose. | |||||||||||||||
Cardinality | 0...1 | |||||||||||||||
Type | 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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.dosageInstruction.doseAndRate.rate[x] | ||||||||||||||||
Definition | Amount of medication per unit of time. | |||||||||||||||
Cardinality | 0...1 | |||||||||||||||
Type | 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 grammer 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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.dosageInstruction.maxDosePerPeriod | ||||||||||||||||
Definition | Upper limit on medication per unit of time. | |||||||||||||||
Cardinality | 0...1 | |||||||||||||||
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". | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.dosageInstruction.maxDosePerAdministration | ||||||||||||||||
Definition | Upper limit on medication per administration. | |||||||||||||||
Cardinality | 0...1 | |||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.dosageInstruction.maxDosePerLifetime | ||||||||||||||||
Definition | Upper limit on medication per lifetime of the patient. | |||||||||||||||
Cardinality | 0...1 | |||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.substitution | ||||||||||||||||
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...1 | |||||||||||||||
Type | BackboneElement | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.substitution.id | ||||||||||||||||
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 | |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.substitution.extension | ||||||||||||||||
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 manageable, 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) | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.substitution.modifierExtension | ||||||||||||||||
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 manageable, 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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.substitution.wasSubstituted | ||||||||||||||||
Definition | True if the dispenser dispensed a different drug or product from what was prescribed. | |||||||||||||||
Cardinality | 1...1 | |||||||||||||||
Type | boolean | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.substitution.type | ||||||||||||||||
Definition | A code signifying whether a different drug was dispensed from what was prescribed. | |||||||||||||||
Cardinality | 0...1 | |||||||||||||||
Type | CodeableConcept | |||||||||||||||
Binding | A coded concept describing whether a different medicinal product may be dispensed other than the product as specified exactly in the prescription. | |||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.substitution.reason | ||||||||||||||||
Definition | Indicates the reason for the substitution (or lack of substitution) from what was prescribed. | |||||||||||||||
Cardinality | 0...* | |||||||||||||||
Type | CodeableConcept | |||||||||||||||
Binding | A coded concept describing the reason that a different medication should (or should not) be substituted from what was prescribed. | |||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.substitution.responsibleParty | ||||||||||||||||
Definition | The person or organization that has primary responsibility for the substitution. | |||||||||||||||
Cardinality | 0...* | |||||||||||||||
Type | Reference( | ) | |||||||||||||||
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.substitution.responsibleParty.id | ||||||||||||||||
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 | |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.substitution.responsibleParty.extension | ||||||||||||||||
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 manageable, 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) | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.substitution.responsibleParty.reference | ||||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.substitution.responsibleParty.type | ||||||||||||||||
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 RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.substitution.responsibleParty.identifier | ||||||||||||||||
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). | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.substitution.responsibleParty.identifier.id | ||||||||||||||||
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 | |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.substitution.responsibleParty.identifier.extension | ||||||||||||||||
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 manageable, 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) | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.substitution.responsibleParty.identifier.use | ||||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.substitution.responsibleParty.identifier.type | ||||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.substitution.responsibleParty.identifier.system | ||||||||||||||||
Definition | Establishes the namespace for the value - that is, a 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. | |||||||||||||||
Invariants |
| |||||||||||||||
Examples | General http://www.acme.com/identifiers/patient | |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.substitution.responsibleParty.identifier.value | ||||||||||||||||
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 Rendered Value extension. 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. | |||||||||||||||
Invariants |
| |||||||||||||||
Examples | General 123456 | |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.substitution.responsibleParty.identifier.period | ||||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.substitution.responsibleParty.identifier.assigner | ||||||||||||||||
Definition | Organization that issued/manages the identifier. | |||||||||||||||
Cardinality | 0...1 | |||||||||||||||
Type | Reference() | |||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.substitution.responsibleParty.display | ||||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.detectedIssue | ||||||||||||||||
Definition | Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. drug-drug interaction, duplicate therapy, dosage alert etc. | |||||||||||||||
Cardinality | 0...* | |||||||||||||||
Type | Reference(DetectedIssue) | |||||||||||||||
Alias | Contraindication, Drug Utilization Review (DUR), Alert | |||||||||||||||
Comments | This element can include a detected issue that has been identified either by a decision support system or by a clinician and may include information on the steps that were taken to address the issue. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.detectedIssue.id | ||||||||||||||||
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 | |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.detectedIssue.extension | ||||||||||||||||
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 manageable, 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) | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.detectedIssue.reference | ||||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.detectedIssue.type | ||||||||||||||||
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 RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.detectedIssue.identifier | ||||||||||||||||
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). | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.detectedIssue.identifier.id | ||||||||||||||||
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 | |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.detectedIssue.identifier.extension | ||||||||||||||||
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 manageable, 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) | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.detectedIssue.identifier.use | ||||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.detectedIssue.identifier.type | ||||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.detectedIssue.identifier.system | ||||||||||||||||
Definition | Establishes the namespace for the value - that is, a 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. | |||||||||||||||
Invariants |
| |||||||||||||||
Examples | General http://www.acme.com/identifiers/patient | |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.detectedIssue.identifier.value | ||||||||||||||||
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 Rendered Value extension. 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. | |||||||||||||||
Invariants |
| |||||||||||||||
Examples | General 123456 | |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.detectedIssue.identifier.period | ||||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.detectedIssue.identifier.assigner | ||||||||||||||||
Definition | Organization that issued/manages the identifier. | |||||||||||||||
Cardinality | 0...1 | |||||||||||||||
Type | Reference() | |||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.detectedIssue.display | ||||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.eventHistory | ||||||||||||||||
Definition | A summary of the events of interest that have occurred, such as when the dispense was verified. | |||||||||||||||
Cardinality | 0...* | |||||||||||||||
Type | Reference() | |||||||||||||||
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.). | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.eventHistory.id | ||||||||||||||||
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 | |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.eventHistory.extension | ||||||||||||||||
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 manageable, 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) | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.eventHistory.reference | ||||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.eventHistory.type | ||||||||||||||||
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 RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.eventHistory.identifier | ||||||||||||||||
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). | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.eventHistory.identifier.id | ||||||||||||||||
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 | |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.eventHistory.identifier.extension | ||||||||||||||||
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 manageable, 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) | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.eventHistory.identifier.use | ||||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.eventHistory.identifier.type | ||||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.eventHistory.identifier.system | ||||||||||||||||
Definition | Establishes the namespace for the value - that is, a 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. | |||||||||||||||
Invariants |
| |||||||||||||||
Examples | General http://www.acme.com/identifiers/patient | |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.eventHistory.identifier.value | ||||||||||||||||
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 Rendered Value extension. 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. | |||||||||||||||
Invariants |
| |||||||||||||||
Examples | General 123456 | |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.eventHistory.identifier.period | ||||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.eventHistory.identifier.assigner | ||||||||||||||||
Definition | Organization that issued/manages the identifier. | |||||||||||||||
Cardinality | 0...1 | |||||||||||||||
Type | Reference() | |||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
| |||||||||||||||
MedicationDispense.eventHistory.display | ||||||||||||||||
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. | |||||||||||||||
Invariants |
| |||||||||||||||
Mappings |
|
See examples in Message dispense-notification
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.
Constraints
mdd-1 (ERROR) whenHandedOver cannot be before whenPrepared
extension:prescriptionStatus
Element Id | MedicationDispense.extension:prescriptionStatus |
Cardinality | 1..1 |
Slice Name | prescriptionStatus |
type | Extension(ExtensionEPSTaskBusinessStatus) |
Definition
This is the overall status of the prescription-order
, it is not the status of the individual prescription item. This is a code from DM-Task-Status-Reason, all prescription status reasons in a dispense-notification
FHIR Message Bundle must be the same.
"extension": [ { "url": "https://fhir.nhs.uk/StructureDefinition/Extension-EPS-TaskBusinessStatus", "valueCoding": { "system": "https://fhir.nhs.uk/CodeSystem/EPS-task-business-status", "code": "0003", "display": "With Dispenser - Active" } } ]
extension:repeatInformation
Element Id | MedicationDispense.extension:repeatInformation |
Cardinality | 0..1 |
Slice Name | repeatInformation |
type | Extension(ExtensionEPSRepeatInformation) |
Definition
The extension is mandatory for continuous
and continuous-repeat-dispensing
. The following elements MUST be populated
- numberofRepeatsAllowed
- numberOfRepeatsIssued
"extension": [ { "url": "https://fhir.nhs.uk/StructureDefinition/Extension-EPS-RepeatInformation", "extension": [ { "url" : "numberOfRepeatsAllowed", "valueInteger" : 3 }, { "url" : "numberOfRepeatsIssued", "valueInteger" : 2 } ] } ]
identifier
Element Id | MedicationDispense.identifier |
Cardinality | 0..* |
type | Identifier |
Definition
Each MedicationDispense MUST be identified by an Universal Unique Identifiers (UUIDs) with a system of https://fhir.nhs.uk/Id/prescription-dispense-item-number
UUID example (for illustration purposes only);
4509B70D-D8B8-EA03-1105-64557CB54A29
"identifier": [ { "system": "https://fhir.nhs.uk/Id/prescription-dispense-item-number", "value": "4509B70D-D8B8-EA03-1105-64557CB54A29" } ]
Comment
This is a business identifier, not a resource identifier.
status
Element Id | MedicationDispense.status |
Cardinality | 1..1 |
Terminology Binding | MedicationDispense Status Codes (Required) A coded concept specifying the state of the dispense event. |
type | code |
Definition
The status of the individual medication item, this will normally indicate whether the medication has been picked up or not.
Code | Display | Definition |
---|---|---|
completed | Completed | The dispensed product has been picked up. |
in-progress | In Progress | The dispensed product is ready for pickup. |
Comment
This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.
statusReason[x]
Element Id | MedicationDispense.statusReason[x] |
Cardinality | 0..1 |
Terminology Binding | MedicationDispense Status Reason Codes (Example) A code describing why a dispense was not performed. |
type | CodeableConcept |
Definition
Indicates the reason why a dispense was not performed.
statusReason[x].coding:notDispensedStatusReason
Element Id | MedicationDispense.statusReason[x].coding:notDispensedStatusReason |
Cardinality | 0..* |
Terminology Binding | MedicationDispenseStatusReason (Required) |
Slice Name | notDispensedStatusReason |
type | Coding |
Definition
A reference to a code defined by a terminology system.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Comment
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.
statusReason[x].coding:notDispensedStatusReason.system
Element Id | MedicationDispense.statusReason[x].coding:notDispensedStatusReason.system |
Cardinality | 0..1 |
Fixed Value | https://fhir.nhs.uk/CodeSystem/medicationdispense-status-reason |
type | uri |
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Comment
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 reference to some definition that establishes the system clearly and unambiguously.
statusReason[x].coding:amendmentStatusReason
Element Id | MedicationDispense.statusReason[x].coding:amendmentStatusReason |
Cardinality | 0..* |
Terminology Binding | TaskReasonCode (Required) |
Slice Name | amendmentStatusReason |
type | Coding |
Definition
A reference to a code defined by a terminology system.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Comment
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.
statusReason[x].coding:amendmentStatusReason.system
Element Id | MedicationDispense.statusReason[x].coding:amendmentStatusReason.system |
Cardinality | 0..1 |
Fixed Value | https://fhir.nhs.uk/CodeSystem/EPS-task-dispense-withdraw-reason |
type | uri |
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Comment
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 reference to some definition that establishes the system clearly and unambiguously.
medication[x]
Element Id | MedicationDispense.medication[x] |
Cardinality | 1..1 |
Terminology Binding | NHSDigitalMedicationCode (Extensible) |
type | CodeableConcept(NHSDigitalMedicationDispenseCodeableConcept)Reference(NHSDigitalMedicationDispenseMedication) Aggregation - bundled |
Definition
Actual Medical Product Packs (AMPP) SHOULD be used. It is valid to include a FHIR Medication resource within the FHIR Message, this practice is discouraged to simplify handling of the event messages.
dm+d Category | dm+d Description | UK SNOMED Members Of |
---|
"medicationCodeableConcept": { "coding": [ { "system": "http://snomed.info/sct", "code": "10460811000001109", "display": "Amoxil 500mg capsules (Dowelhurst Ltd) 12 capsule" } ] }
Comment
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.
subject
Element Id | MedicationDispense.subject |
Cardinality | 1..1 |
type | Reference(NHSDigitalPatientPDS) Aggregation - referenced Aggregation - bundled |
Definition
A reference to the patient via a traced NHS Number is required, an untraced NHS Number MUST NOT be used. This can be sent in two ways, first option is via a identifier reference
. Only the NHS Number:
"subject": { "type": "Patient", "identifier": { "system": "https://fhir.nhs.uk/Id/nhs-number", "value": "2300992742" } }
Second option uses a FHIR Patient resource to convey the NHS Number.
The reference in the MedicationDispesnse is now a resource reference
.
"subject": { "type": "Patient", "reference": "urn:uuid:bde9eba6-079f-4210-8108-6ea8db58de8c", "display": "Miss Bernie Kanfeld" }
The NHS Number has moved to the Patient resource alongside other patient identifiers such as MRN. E.g.
"fullUrl": "urn:uuid:bde9eba6-079f-4210-8108-6ea8db58de8c", "resource": { "resourceType": "Patient", "identifier": [ { "extension": [ { "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus", "valueCodeableConcept": { "coding": [ { "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatus", "code": "01", "display": "Number present and verified" } ] } } ], "system": "https://fhir.nhs.uk/Id/nhs-number", "value": "9876543210" }, { "system": "https://fhir.leedsth.nhs.uk/Id/pas-number", "value": "ABC8650149" }, { "system": "https://fhir.leedsth.nhs.uk/Id/PPMIdentifier", "value": "1" } ], ... other elements removed from example. }
It is anticipated that hospital pharmacies will prefer the later option for compatibility with other systems. Community pharmacies are anticipated to prefer the former option.
Comment
SubstanceAdministration->subject->Patient.
Constraints
- eps-2 (WARNING) subject - An identifier reference or resource reference must be provided
- patient-nhs (ERROR) Supplied NHS Number is outside the English and Welsh NHS Number range or length of the number is wrong.
subject.identifier.system
Element Id | MedicationDispense.subject.identifier.system |
Cardinality | 1..1 |
Fixed Value | https://fhir.nhs.uk/Id/nhs-number |
type | uri |
Definition
Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
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.
Comment
Identifier.system is always case sensitive.
performer
Element Id | MedicationDispense.performer |
Cardinality | 1..* |
type | BackboneElement |
Definition
The pharmacist and pharmacy MUST be present and MUST use identifier references
. This means FHIR Practitioner, Organization and PractitionerRole resource are not included in the FHIR Message. Professional codes and ODS codes should be used instead. sds-user-role-id
is permitted to identify a Practitioner(& Role) but professional codes are preferred to support wider NHS interoperability.
"performer": [ { "actor": { "reference" : "#performer" } } ],
The contained PractitionerRole:
{ "resourceType": "MedicationDispense", "id": "06167339-9337-d030-0366-514a6a46da17", "contained": [ { "resourceType": "PractitionerRole", "id": "performer", "identifier": [ { "system": "https://fhir.nhs.uk/Id/sds-role-profile-id", "value": "741555508105" } ], "code": [ { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/NHSDigital-SDS-JobRoleCode", "code": "S0030:G0100:R0620" } ] } ], "practitioner": { "identifier": { "system": "https://fhir.nhs.uk/Id/sds-user-id", "value": "7654321" }, "display": "Mr Peter Potion" }, "organization": { "reference": "urn:uuid:2bf9f37c-d88b-4f86-ad5f-373c1416e04b" }, "telecom": [ { "system": "phone", "use": "work", "value": "0532567890" } ] } ],
authorizingPrescription
Element Id | MedicationDispense.authorizingPrescription |
Cardinality | 1..* |
type | Reference(NHSDigitalMedicationRequestMinimal) Aggregation - contained Aggregation - referenced |
Definition
A reference to the MedicationRequest
.
"authorizingPrescription": [ { "reference": "#m1" } ]
When a MedicationDispesne is sent in a FHIR Message bundle, which is the case with EPS NextGen dispense-notifications
, a contained MedicationRequest is required.
This MedicationRequest MUST follow the rules in NHSDigital-MedicationRequest and it is strongly recommended to reuse the MedicationRequest
received when the prescription was downloaded.
For example:
{ "resourceType": "MedicationDispense", "contained": [ { "resourceType": "MedicationRequest", "id": "m1", "identifier": [ { "system": "https://fhir.nhs.uk/Id/prescription-order-item-number", "value": "299c610b-f4f1-4eac-a7d7-4fb6b0556e11" } ], "status": "active", "intent": "order", "medicationCodeableConcept": { "coding": [ { "system": "http://snomed.info/sct", "code": "39720311000001101", "display": "Paracetamol 500mg soluble tablets" } ] }, "subject": { "identifier": { "system": "https://fhir.nhs.uk/Id/nhs-number", "value": "9876543210" } }, "groupIdentifier": { "extension": [ { "url": "https://fhir.nhs.uk/StructureDefinition/Extension-DM-PrescriptionId", "valueIdentifier": { "system": "https://fhir.nhs.uk/Id/prescription", "value": "b2fc79f0-2793-4736-9b2d-0976c21e73a5" } } ], "system": "https://fhir.nhs.uk/Id/prescription-order-number", "value": "82D996-C81010-11DB12" }, "dispenseRequest": { "quantity": { "value": 100, "unit": "tablet", "system": "http://snomed.info/sct", "code": "732936001" } }, "substitution": { "allowedBoolean": false } } ], "authorizingPrescription": [ { "reference": "#m1" } ],
This is based on a MedicationRequest
in this implementation guide.
The uuid resource references are not permitted and must be replaced with identifier references. E.g. in this section from the $release
"subject": { "reference": "urn:uuid:78d3c2eb-009e-4ec8-a358-b042954aa9b2" }, "authoredOn": "2020-12-21T18:15:29+00:00", "requester": { "reference": "urn:uuid:56166769-c1c4-4d07-afa8-132b5dfca666" },
The requester reference can be removed and the subject reference changed to use the Patient's NHSNumber e.g.
"subject": { "identifier": { "system": "https://fhir.nhs.uk/Id/nhs-number", "value": "9876543210" } },
Comment
Maps to basedOn in Event logical model.
type
Element Id | MedicationDispense.type |
Cardinality | 0..1 |
Terminology Binding | MedicationDispenseType (Required) A ValueSet to identify the type of medication item status. |
type | CodeableConcept |
Definition
Indicates the type of dispensing event that is performed. For example, Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.
"type": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/medicationdispense-type", "code": "0001", "display": "Item fully dispensed" } ] }
quantity
Element Id | MedicationDispense.quantity |
Cardinality | 1..1 |
type | Quantity(SimpleQuantity) |
Definition
The amount of medication that has been dispensed. Includes unit of measure.
"quantity": { "value": 28, "unit": "capsule", "system": "http://snomed.info/sct", "code": "3316911000001105" }
If no actual quantity has been dispensed then use a value of zero.
daysSupply
Element Id | MedicationDispense.daysSupply |
Cardinality | 0..1 |
type | Quantity(SimpleQuantity) |
Definition
The amount of medication expressed as a timing amount.
"daysSupply": { "value": 7, "unit": "Day", "system": "http://unitsofmeasure.org", "code": "d" }
whenPrepared
Element Id | MedicationDispense.whenPrepared |
Cardinality | 0..1 |
type | dateTime |
Definition
The time when the dispensed product was packaged and reviewed.
"whenPrepared": "2004-09-16T16:30:00+00:00"
whenHandedOver
Element Id | MedicationDispense.whenHandedOver |
Cardinality | 0..1 |
type | dateTime |
Definition
The time the dispensed product was provided to the patient or their representative. In HL7 v3 this is: The date and local time that the medication is issued by the dispenser.
"whenHandedOver": "2004-09-16T16:30:00+00:00"
dosageInstruction
Element Id | MedicationDispense.dosageInstruction |
Cardinality | 0..* |
type | Dosage(NHSDigitalDosage) |
Definition
At present only the text
element MUST be provided. It is recommended the guidance in FHIR Dose Syntax Implementation Guidance is followed.
Note the structure of this section is similar as the NHSDigital-MedicationRequest from the prescription-order
.
"dosageInstruction": [ { "text": "4 times a day for 7 days", "timing": { "repeat": { "boundsDuration": { "value": 7, "unit": "d" }, "frequency": 4, "period": 1, "periodUnit": "d" } }, "doseAndRate": [ { "doseQuantity": { "value": 1, "unit": "capsule", "system": "http://snomed.info/sct", "code": "3316911000001105" } } ] } ]
Comment
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.