STU 2 Ballot

This page is part of the Data Access Framework (v1.6.0: STU 2 Ballot 1) based on FHIR v1.6.0. . For a full list of available versions, see the Directory of published versions

D.4.1 StructureDefinition: DAF-medicationdispense

The official URL for this profile is: 

http://hl7.org/fhir/us/daf/StructureDefinition/daf-medicationdispense

This profile was published on Fri Mar 20 00:00:00 AEDT 2015 as a draft by Health Level Seven International (Infrastructure and Messaging - Data Access Framework).

D.4.1.1 Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationDispense I0..*Dispensing a medication to a named patient
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
mdd-1: whenHandedOver cannot be before whenPrepared
... id ∑0..1idLogical id of this artifact
... meta ∑0..1MetaMetadata about the resource
... implicitRules ?!∑0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier S0..1IdentifierExternal identifier
... status ?!S0..1codein-progress | on-hold | completed | entered-in-error | stopped
Binding: MedicationDispenseStatus (required)
... medication[x] S1..1CodeableConcept, Reference(Profile daf-core-medication)What medication was supplied
Binding: Medication Clinical Drug (RxNorm) (extensible)
... patient S1..1Reference(Profile daf-patient)Who the dispense is for
... dispenser S0..1Reference(Profile daf-pract)Practitioner responsible for dispensing medication
... dispensingOrganization 0..1Reference(Organization)Organization responsible for the dispense of the medication
... authorizingPrescription S0..*Reference(Profile daf-medicationorder)Medication order that authorizes the dispense
... type 0..1CodeableConceptTrial fill, partial fill, emergency fill, etc.
Binding: ActPharmacySupplyType (example)
... quantity 0..1SimpleQuantityAmount dispensed
... daysSupply 0..1SimpleQuantityAmount of medication expressed as a timing amount
... whenPrepared ∑0..1dateTimeWhen product was packaged and reviewed
... whenHandedOver 0..1dateTimeWhen product was given out
... destination 0..1Reference(Location)Where the medication was sent
... receiver 0..*Reference(Patient | Practitioner)Who collected the medication
... note 0..*AnnotationInformation about the dispense
... dosageInstruction S0..*BackboneElementMedicine administration instructions to the patient/caregiver
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... text 0..1stringFree text dosage instructions e.g. SIG
.... additionalInstructions S0..1CodeableConceptE.g. "Take with food"
Binding: SNOMED CT Additional Dosage Instructions (example)
.... timing S0..1TimingWhen medication should be administered
.... asNeeded[x] S0..1boolean, CodeableConceptTake "as needed" f(or x)
Binding: SNOMED CT Medication As Needed Reason Codes (example)
.... siteCodeableConcept S0..1CodeableConceptBody site to administer to
Binding: Vaccine Administered Body Site (preferred)
.... route S0..1CodeableConceptHow drug should enter body
Binding: Medication Route FDA Value Set (preferred)
.... method 0..1CodeableConceptTechnique for administering medication
Binding: SNOMED CT Administration Method Codes (example)
.... dose[x] S0..1Range, SimpleQuantityAmount of medication per dose
.... rate[x] S0..1Ratio, Range, SimpleQuantityAmount of medication per unit of time
.... maxDosePerPeriod S0..1RatioUpper limit on medication per unit of time
... substitution 0..1BackboneElementDeals with substitution of one medicine for another
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... type 1..1CodeableConceptCode signifying whether a different drug was dispensed from what was prescribed
Binding: ActSubstanceAdminSubstitutionCode (example)
.... reason 0..*CodeableConceptWhy was substitution made
Binding: SubstanceAdminSubstitutionReason (example)
.... responsibleParty 0..*Reference(Practitioner)Who is responsible for the substitution
... eventHistory 0..*BackboneElementA list of events of interest in the lifecycle
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... status 1..1codein-progress | on-hold | completed | entered-in-error | stopped
Binding: MedicationDispenseStatus (required)
.... action 0..1CodeableConceptAction taken (e.g. verify)
Binding: (unbound) (example)
.... dateTime 1..1dateTimeThe date at which the event happened
.... actor 0..1Reference(Practitioner)Who took the action
.... reason 0..1CodeableConceptReason the action was taken
Binding: (unbound) (example)

doco Documentation for this format

yet to be done: Xml template

yet to be done: Json template

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationDispense I0..*Dispensing a medication to a named patient
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
mdd-1: whenHandedOver cannot be before whenPrepared
... id ∑0..1idLogical id of this artifact
... meta ∑0..1MetaMetadata about the resource
... implicitRules ?!∑0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier S0..1IdentifierExternal identifier
... status ?!S0..1codein-progress | on-hold | completed | entered-in-error | stopped
Binding: MedicationDispenseStatus (required)
... medication[x] S1..1CodeableConcept, Reference(Profile daf-core-medication)What medication was supplied
Binding: Medication Clinical Drug (RxNorm) (extensible)
... patient S1..1Reference(Profile daf-patient)Who the dispense is for
... dispenser S0..1Reference(Profile daf-pract)Practitioner responsible for dispensing medication
... dispensingOrganization 0..1Reference(Organization)Organization responsible for the dispense of the medication
... authorizingPrescription S0..*Reference(Profile daf-medicationorder)Medication order that authorizes the dispense
... type 0..1CodeableConceptTrial fill, partial fill, emergency fill, etc.
Binding: ActPharmacySupplyType (example)
... quantity 0..1SimpleQuantityAmount dispensed
... daysSupply 0..1SimpleQuantityAmount of medication expressed as a timing amount
... whenPrepared ∑0..1dateTimeWhen product was packaged and reviewed
... whenHandedOver 0..1dateTimeWhen product was given out
... destination 0..1Reference(Location)Where the medication was sent
... receiver 0..*Reference(Patient | Practitioner)Who collected the medication
... note 0..*AnnotationInformation about the dispense
... dosageInstruction S0..*BackboneElementMedicine administration instructions to the patient/caregiver
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... text 0..1stringFree text dosage instructions e.g. SIG
.... additionalInstructions S0..1CodeableConceptE.g. "Take with food"
Binding: SNOMED CT Additional Dosage Instructions (example)
.... timing S0..1TimingWhen medication should be administered
.... asNeeded[x] S0..1boolean, CodeableConceptTake "as needed" f(or x)
Binding: SNOMED CT Medication As Needed Reason Codes (example)
.... siteCodeableConcept S0..1CodeableConceptBody site to administer to
Binding: Vaccine Administered Body Site (preferred)
.... route S0..1CodeableConceptHow drug should enter body
Binding: Medication Route FDA Value Set (preferred)
.... method 0..1CodeableConceptTechnique for administering medication
Binding: SNOMED CT Administration Method Codes (example)
.... dose[x] S0..1Range, SimpleQuantityAmount of medication per dose
.... rate[x] S0..1Ratio, Range, SimpleQuantityAmount of medication per unit of time
.... maxDosePerPeriod S0..1RatioUpper limit on medication per unit of time
... substitution 0..1BackboneElementDeals with substitution of one medicine for another
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... type 1..1CodeableConceptCode signifying whether a different drug was dispensed from what was prescribed
Binding: ActSubstanceAdminSubstitutionCode (example)
.... reason 0..*CodeableConceptWhy was substitution made
Binding: SubstanceAdminSubstitutionReason (example)
.... responsibleParty 0..*Reference(Practitioner)Who is responsible for the substitution
... eventHistory 0..*BackboneElementA list of events of interest in the lifecycle
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... status 1..1codein-progress | on-hold | completed | entered-in-error | stopped
Binding: MedicationDispenseStatus (required)
.... action 0..1CodeableConceptAction taken (e.g. verify)
Binding: (unbound) (example)
.... dateTime 1..1dateTimeThe date at which the event happened
.... actor 0..1Reference(Practitioner)Who took the action
.... reason 0..1CodeableConceptReason the action was taken
Binding: (unbound) (example)

doco Documentation for this format

XML Template

yet to be done: Xml template

JSON Template

yet to be done: Json template

 

D.4.1.2 Terminology Bindings

Terminology Bindings

PathNameConformanceValueSet
MedicationDispense.languageCommon LanguagesextensibleCommon Languages
MedicationDispense.statusMedicationDispenseStatusrequiredMedicationDispenseStatus
MedicationDispense.medication[x]Medication Clinical Drug (RxNorm)extensibleMedication Clinical Drug (RxNorm)
MedicationDispense.typeActPharmacySupplyTypeexampleActPharmacySupplyType
MedicationDispense.dosageInstruction.additionalInstructionsSNOMED CT Additional Dosage InstructionsexampleSNOMED CT Additional Dosage Instructions
MedicationDispense.dosageInstruction.asNeeded[x]SNOMED CT Medication As Needed Reason CodesexampleSNOMED CT Medication As Needed Reason Codes
MedicationDispense.dosageInstruction.siteCodeableConceptVaccine Administered Body SitepreferredVaccine Administered Body Site
MedicationDispense.dosageInstruction.routeMedication Route FDA Value SetpreferredMedication Route FDA Value Set
MedicationDispense.dosageInstruction.methodSNOMED CT Administration Method CodesexampleSNOMED CT Administration Method Codes
MedicationDispense.substitution.typeActSubstanceAdminSubstitutionCodeexampleActSubstanceAdminSubstitutionCode
MedicationDispense.substitution.reasonSubstanceAdminSubstitutionReasonexampleSubstanceAdminSubstitutionReason
MedicationDispense.eventHistory.statusMedicationDispenseStatusrequiredMedicationDispenseStatus
MedicationDispense.eventHistory.action?extexample
MedicationDispense.eventHistory.reason?extexample

D.4.1.3 Constraints

Constraints

IdPathDetailsRequirements
dom-2MedicationDispenseIf the resource is contained in another resource, it SHALL NOT contain nested Resources
XPath: not(parent::f:contained and f:contained)
dom-1MedicationDispenseIf the resource is contained in another resource, it SHALL NOT contain any narrative
XPath: not(parent::f:contained and f:text)
dom-4MedicationDispenseIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
XPath: not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))
dom-3MedicationDispenseIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
XPath: not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))
mdd-1MedicationDispensewhenHandedOver cannot be before whenPrepared
XPath: not(exists(f:whenHandedOver/@value)) or not(exists(f:whenPrepared/@value)) or ( f:whenHandedOver/@value >= f:whenPrepared/@value)
.