GAO Ballot Package

This page is part of the FHIR Specification (v1.1.0: STU 3 Ballot 1). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

This is a frozen snapshot of the FHIR specification created for the purpose of balloting the GAO implementation Guide. It includes draft changes that may be part of the future DSTU 2.1 release but further change is expected. Readers should focus solely on the GAO implementation content, and FHIR DSTU 2 for other purposes.

D.16.1 StructureDefinition: DAF-MedicationOrder

The official URL for this profile is: 

http://hl7.org/fhir/StructureDefinition/daf-medicationorder

Defines constraints and extensions on the MedicationOrder resource for use in querying and retrieving prescription information.

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

D.16.1.1 Formal Views of Profile Content

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

This structure is derived from MedicationOrder.

Summary

Mandatory: 2 elements
Must-Support: 22 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element MedicationOrder.medication[x] is sliced based on the value of @type
NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationOrder ∑0..*MedicationOrderPrescription of medication to for patient
... 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: IETF BCP-47 (required)
... 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 S ∑0..*IdentifierExternal identifier
... dateWritten S ∑0..1dateTimeWhen prescription was authorized
... status ?! S∑0..1codeactive | on-hold | completed | entered-in-error | stopped | draft
Binding: MedicationOrderStatus (required)
... dateEnded S ∑0..1dateTimeWhen prescription was stopped
... reasonEnded ∑0..1CodeableConceptWhy prescription was stopped
Binding: (unbound) (example)
... patient S ∑1..1Reference(DAF-Patient)Who prescription is for
... prescriber S ∑0..1Reference(DAF-Pract)Who ordered the medication(s)
... encounter S ∑0..1Reference(DAF-Encounter)Created during encounter/admission/stay
... reason[x] ∑0..1CodeableConcept, Reference(Condition)Reason or indication for writing the prescription
Binding: Condition/Problem/Diagnosis Codes (example)
... note ∑0..1stringInformation about the prescription
... medication[x] ∑CodeableConcept, Reference(Medication)Medication to be taken
Slice: Unordered, Open, by @type
... medication[x] ∑1..1CodeableConcept, Reference(Medication)Medication to be taken
... medicationCodeableConcept S ∑1..1CodeableConceptMedication to be taken
Binding: Medication Clinical Drug (RxNorm) (extensible)
... medicationReference S ∑1..1Reference(DAF-Medication)Medication to be taken
... dosageInstruction S ∑0..*BackboneElementHow medication should be taken
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... text S ∑0..1stringDosage instructions expressed as text
.... additionalInstructions ∑0..1CodeableConceptSupplemental instructions - e.g. "with meals"
Binding: (unbound) (example)
.... timing S ∑0..1TimingWhen medication should be administered
.... asNeeded[x] S ∑0..1boolean, CodeableConceptTake "as needed" (for x)
Binding: (unbound) (example)
.... siteCodeableConcept S ∑0..1CodeableConceptBody site to administer to
Binding: Vaccine Administered Body Site (preferred)
.... route S ∑0..1CodeableConceptHow drug should enter body
Binding: Medication Route FDA Value Set (preferred)
.... method ∑0..1CodeableConceptTechnique for administering medication
Binding: (unbound) (example)
.... dose[x] S ∑0..1Range, SimpleQuantityAmount of medication per dose
.... rate[x] S ∑0..1Ratio, RangeAmount of medication per unit of time
.... maxDosePerPeriod ∑0..1RatioUpper limit on medication per unit of time
... dispenseRequest S ∑0..1BackboneElementMedication supply authorization
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... medication[x] ∑0..1CodeableConcept, Reference(Medication)Product to be supplied
.... validityPeriod S ∑0..1PeriodTime period supply is authorized for
.... numberOfRepeatsAllowed S ∑0..1positiveIntNumber of refills authorized
.... quantity S ∑0..1SimpleQuantityAmount of medication to supply per dispense
.... expectedSupplyDuration S ∑0..1DurationNumber of days supply per dispense
... substitution ∑0..1BackboneElementAny restrictions on medication substitution
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... type ∑1..1CodeableConceptgeneric | formulary +
Binding: ActSubstanceAdminSubstitutionCode (example)
.... reason ∑0..1CodeableConceptWhy should (not) substitution be made
Binding: SubstanceAdminSubstitutionReason (example)
... priorPrescription ∑0..1Reference(MedicationOrder)An order/prescription that this supersedes

doco Documentation for this format

todo

This structure is derived from MedicationOrder.

Summary

Mandatory: 2 elements
Must-Support: 22 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element MedicationOrder.medication[x] is sliced based on the value of @type

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationOrder ∑0..*MedicationOrderPrescription of medication to for patient
... 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: IETF BCP-47 (required)
... 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 S ∑0..*IdentifierExternal identifier
... dateWritten S ∑0..1dateTimeWhen prescription was authorized
... status ?! S∑0..1codeactive | on-hold | completed | entered-in-error | stopped | draft
Binding: MedicationOrderStatus (required)
... dateEnded S ∑0..1dateTimeWhen prescription was stopped
... reasonEnded ∑0..1CodeableConceptWhy prescription was stopped
Binding: (unbound) (example)
... patient S ∑1..1Reference(DAF-Patient)Who prescription is for
... prescriber S ∑0..1Reference(DAF-Pract)Who ordered the medication(s)
... encounter S ∑0..1Reference(DAF-Encounter)Created during encounter/admission/stay
... reason[x] ∑0..1CodeableConcept, Reference(Condition)Reason or indication for writing the prescription
Binding: Condition/Problem/Diagnosis Codes (example)
... note ∑0..1stringInformation about the prescription
... medication[x] ∑CodeableConcept, Reference(Medication)Medication to be taken
Slice: Unordered, Open, by @type
... medication[x] ∑1..1CodeableConcept, Reference(Medication)Medication to be taken
... medicationCodeableConcept S ∑1..1CodeableConceptMedication to be taken
Binding: Medication Clinical Drug (RxNorm) (extensible)
... medicationReference S ∑1..1Reference(DAF-Medication)Medication to be taken
... dosageInstruction S ∑0..*BackboneElementHow medication should be taken
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... text S ∑0..1stringDosage instructions expressed as text
.... additionalInstructions ∑0..1CodeableConceptSupplemental instructions - e.g. "with meals"
Binding: (unbound) (example)
.... timing S ∑0..1TimingWhen medication should be administered
.... asNeeded[x] S ∑0..1boolean, CodeableConceptTake "as needed" (for x)
Binding: (unbound) (example)
.... siteCodeableConcept S ∑0..1CodeableConceptBody site to administer to
Binding: Vaccine Administered Body Site (preferred)
.... route S ∑0..1CodeableConceptHow drug should enter body
Binding: Medication Route FDA Value Set (preferred)
.... method ∑0..1CodeableConceptTechnique for administering medication
Binding: (unbound) (example)
.... dose[x] S ∑0..1Range, SimpleQuantityAmount of medication per dose
.... rate[x] S ∑0..1Ratio, RangeAmount of medication per unit of time
.... maxDosePerPeriod ∑0..1RatioUpper limit on medication per unit of time
... dispenseRequest S ∑0..1BackboneElementMedication supply authorization
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... medication[x] ∑0..1CodeableConcept, Reference(Medication)Product to be supplied
.... validityPeriod S ∑0..1PeriodTime period supply is authorized for
.... numberOfRepeatsAllowed S ∑0..1positiveIntNumber of refills authorized
.... quantity S ∑0..1SimpleQuantityAmount of medication to supply per dispense
.... expectedSupplyDuration S ∑0..1DurationNumber of days supply per dispense
... substitution ∑0..1BackboneElementAny restrictions on medication substitution
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... type ∑1..1CodeableConceptgeneric | formulary +
Binding: ActSubstanceAdminSubstitutionCode (example)
.... reason ∑0..1CodeableConceptWhy should (not) substitution be made
Binding: SubstanceAdminSubstitutionReason (example)
... priorPrescription ∑0..1Reference(MedicationOrder)An order/prescription that this supersedes

doco Documentation for this format

XML Template

JSON Template

todo

 

Other representations of profile: Schematron

D.16.1.2 Terminology Bindings

PathNameConformanceValueSet
MedicationOrder.language?extrequiredhttp://tools.ietf.org/html/bcp47
MedicationOrder.statusMedicationOrderStatusrequiredMedicationOrderStatus
MedicationOrder.reasonEnded?extexample
MedicationOrder.reason[x]Condition/Problem/Diagnosis CodesexampleCondition/Problem/Diagnosis Codes
MedicationOrder.medicationCodeableConceptMedication Clinical Drug (RxNorm)extensibleMedication Clinical Drug (RxNorm)
MedicationOrder.dosageInstruction.additionalInstructions?extexample
MedicationOrder.dosageInstruction.asNeeded[x]?extexample
MedicationOrder.dosageInstruction.siteCodeableConceptVaccine Administered Body SitepreferredVaccine Administered Body Site
MedicationOrder.dosageInstruction.routeMedication Route FDA Value SetpreferredMedication Route FDA Value Set
MedicationOrder.dosageInstruction.method?extexample
MedicationOrder.substitution.typeActSubstanceAdminSubstitutionCodeexampleActSubstanceAdminSubstitutionCode
MedicationOrder.substitution.reasonSubstanceAdminSubstitutionReasonexampleSubstanceAdminSubstitutionReason

D.16.1.3 Constraints

IdPathDetailsRequirements
.