2nd DSTU Draft For Comment

This page is part of the FHIR Specification (v0.4.0: DSTU 2 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

Profile: DAFMedication

The official URL for this profile is: 

http://hl7.org/fhir/Profile/medication-daf-dafmedication

. Defines constraints and extensions on the Medication resource for use in querying and retrieving patient's medication information. : U.S. Data Access Framework (DAF) Medication Profile

This profile was published on Thu, Aug 21, 2014 00:00+1000 as a draft by U.S. Office of the National Coordinator (ONC).

Summary

Required/Prohibited Elements

  • The element Medication is required
  • The element Medication.product.ingredient.item is required
  • The element Medication.package.content.item is required

Formal Views of Profile Content

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

Differential View

This structure is derived from Medication.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 1..1Used for identification and definition of a medication.
... name S0..1string
... code S0..1CodeableConcept
... isBrand S0..1boolean
... manufacturer 0..1Organization
... kind S0..1code
... product S0..1
.... form S0..1CodeableConcept
.... ingredient S0..*
..... item S1..1Substance, Medication
..... amount S0..1Ratio
... package 0..1code
.... container 0..1CodeableConcept
.... content 0..*
..... item 1..1Medication
..... amount 0..1Quantity

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 1..1Used for identification and definition of a medication.
... id 0..1idLogical id of this artefact
... meta 0..1MetaMetadata about the resource
... implicitRules M0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Language (required, not 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
... name S Σ0..1stringCommon / Commercial name
... code S Σ0..1CodeableConceptCodes that identify this medication
Binding: MedicationFormalRepresentation (example, extensible)
... isBrand S Σ0..1booleanTrue if a brand
... manufacturer Σ0..1OrganizationManufacturer of the item
... kind S Σ0..1codeproduct | package
Binding: MedicationKind (required, not extensible)
... product S0..1Administrable medication details
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension 0..*ExtensionExtensions that cannot be ignored
.... form S0..1CodeableConceptpowder | tablets | carton +
Binding: MedicationForm (example, extensible)
.... ingredient S0..*Active or inactive ingredient
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension 0..*ExtensionExtensions that cannot be ignored
..... item S1..1Substance, MedicationThe product contained
..... amount S0..1RatioHow much ingredient in product
.... batch 0..*Information about a group of medication produced or packaged from one production run.
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension 0..*ExtensionExtensions that cannot be ignored
..... lotNumber 0..1stringThe assigned lot number of a batch of the specified product.
..... expirationDate 0..1dateTimeWhen this specific batch of product will expire.
... package 0..1codeDetails about packaged medications
.... extension 0..*ExtensionAdditional Content defined by implementations
.... value 0..1xsd:stringPrimitive value for code
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension 0..*ExtensionExtensions that cannot be ignored
.... container 0..1CodeableConceptE.g. box, vial, blister-pack
Binding: MedicationContainer (example, extensible)
.... content 0..*What is in the package?
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension 0..*ExtensionExtensions that cannot be ignored
..... item 1..1MedicationA product in the package
..... amount 0..1QuantityHow many are in the package?

XML Template

JSON Template

todo

Differential View

This structure is derived from Medication.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 1..1Used for identification and definition of a medication.
... name S0..1string
... code S0..1CodeableConcept
... isBrand S0..1boolean
... manufacturer 0..1Organization
... kind S0..1code
... product S0..1
.... form S0..1CodeableConcept
.... ingredient S0..*
..... item S1..1Substance, Medication
..... amount S0..1Ratio
... package 0..1code
.... container 0..1CodeableConcept
.... content 0..*
..... item 1..1Medication
..... amount 0..1Quantity

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 1..1Used for identification and definition of a medication.
... id 0..1idLogical id of this artefact
... meta 0..1MetaMetadata about the resource
... implicitRules M0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Language (required, not 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
... name S Σ0..1stringCommon / Commercial name
... code S Σ0..1CodeableConceptCodes that identify this medication
Binding: MedicationFormalRepresentation (example, extensible)
... isBrand S Σ0..1booleanTrue if a brand
... manufacturer Σ0..1OrganizationManufacturer of the item
... kind S Σ0..1codeproduct | package
Binding: MedicationKind (required, not extensible)
... product S0..1Administrable medication details
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension 0..*ExtensionExtensions that cannot be ignored
.... form S0..1CodeableConceptpowder | tablets | carton +
Binding: MedicationForm (example, extensible)
.... ingredient S0..*Active or inactive ingredient
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension 0..*ExtensionExtensions that cannot be ignored
..... item S1..1Substance, MedicationThe product contained
..... amount S0..1RatioHow much ingredient in product
.... batch 0..*Information about a group of medication produced or packaged from one production run.
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension 0..*ExtensionExtensions that cannot be ignored
..... lotNumber 0..1stringThe assigned lot number of a batch of the specified product.
..... expirationDate 0..1dateTimeWhen this specific batch of product will expire.
... package 0..1codeDetails about packaged medications
.... extension 0..*ExtensionAdditional Content defined by implementations
.... value 0..1xsd:stringPrimitive value for code
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension 0..*ExtensionExtensions that cannot be ignored
.... container 0..1CodeableConceptE.g. box, vial, blister-pack
Binding: MedicationContainer (example, extensible)
.... content 0..*What is in the package?
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension 0..*ExtensionExtensions that cannot be ignored
..... item 1..1MedicationA product in the package
..... amount 0..1QuantityHow many are in the package?

XML Template

JSON Template

todo

 

Other definitions: (todo)

Terminology Bindings

PathNameConformanceValueSet
Medication.languageLanguagerequiredhttp://tools.ietf.org/html/bcp47
Medication.codeMedicationFormalRepresentationexample (extensible)Snomed Medication Codes
Medication.kindMedicationKindrequiredMedicationKind
Medication.product.formMedicationFormexample (extensible)SNOMED CT Form Codes
Medication.package.containerMedicationContainerexample (extensible)SNOMED CT Form Codes

Constraints

IdPathNameDetails
.