STU 2 Ballot

This page is part of the Quality Improvement Core Framework (v1.6.0: STU 2 Ballot) based on FHIR (HL7® FHIR® Standard) v1.6.0. The current version which supersedes this version is 7.0.2. For a full list of available versions, see the Directory of published versions

D.4.1 StructureDefinition: qicore-medication

D.4.1.1 Formal Views of Profile Content

The official URL for this profile is: 

http://hl7.org/fhir/qicore/StructureDefinition/qicore-medication

This profile was published on Fri Feb 27 00:00:00 AEDT 2015 as a draft by Health Level Seven International (Clinical Quality Information - QICore).

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication I0..*Definition of a Medication
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
... 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
... code S0..1CodeableConceptCodes that identify this medication
Binding: 7.org/fhir/daf/ValueSet/daf-medication-codes (preferred)
... isBrand ∑0..1booleanTrue if a brand
... manufacturer 0..1Reference(Profile qicore-organization)Manufacturer of the item
... product 0..1BackboneElementAdministrable medication details
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... form 0..1CodeableConceptpowder | tablets | carton +
Binding: SNOMED CT Form Codes (example)
.... ingredient 0..*BackboneElementActive or inactive ingredient
..... id 0..1stringxml:id (or equivalent in JSON)
..... medication-isActiveIngredient I0..1booleanExtension
URL: http://hl7.org/fhir/StructureDefinition/medication-isActiveIngredient
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
..... item[x] 1..1Reference(Profile qicore-substance | Profile qicore-medication)The product contained
..... amount 0..1RatioQuantity of ingredient present
.... batch 0..*BackboneElement
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
..... lotNumber 0..1string
..... expirationDate 0..1dateTime
... package 0..1BackboneElementDetails about packaged medications
.... id 0..1stringxml: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: SNOMED CT Form Codes (example)
.... content 0..*BackboneElementWhat is in the package
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
..... itemReference 1..1Reference(Profile qicore-medication)The item in the package
..... amount 0..1SimpleQuantityQuantity present in the package

doco Documentation for this format

yet to be done: Xml template

yet to be done: Json template

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication I0..*Definition of a Medication
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
... 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
... code S0..1CodeableConceptCodes that identify this medication
Binding: 7.org/fhir/daf/ValueSet/daf-medication-codes (preferred)
... isBrand ∑0..1booleanTrue if a brand
... manufacturer 0..1Reference(Profile qicore-organization)Manufacturer of the item
... product 0..1BackboneElementAdministrable medication details
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... form 0..1CodeableConceptpowder | tablets | carton +
Binding: SNOMED CT Form Codes (example)
.... ingredient 0..*BackboneElementActive or inactive ingredient
..... id 0..1stringxml:id (or equivalent in JSON)
..... medication-isActiveIngredient I0..1booleanExtension
URL: http://hl7.org/fhir/StructureDefinition/medication-isActiveIngredient
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
..... item[x] 1..1Reference(Profile qicore-substance | Profile qicore-medication)The product contained
..... amount 0..1RatioQuantity of ingredient present
.... batch 0..*BackboneElement
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
..... lotNumber 0..1string
..... expirationDate 0..1dateTime
... package 0..1BackboneElementDetails about packaged medications
.... id 0..1stringxml: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: SNOMED CT Form Codes (example)
.... content 0..*BackboneElementWhat is in the package
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
..... itemReference 1..1Reference(Profile qicore-medication)The item in the package
..... amount 0..1SimpleQuantityQuantity present in the package

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
Medication.languageCommon LanguagesextensibleCommon Languages
Medication.code?extpreferredhttp://hl7.org/fhir/daf/ValueSet/daf-medication-codes
Medication.product.formSNOMED CT Form CodesexampleSNOMED CT Form Codes
Medication.package.containerSNOMED CT Form CodesexampleSNOMED CT Form Codes

D.4.1.3 Constraints

Constraints

IdPathDetailsRequirements
dom-2MedicationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
XPath: not(parent::f:contained and f:contained)
dom-1MedicationIf the resource is contained in another resource, it SHALL NOT contain any narrative
XPath: not(parent::f:contained and f:text)
dom-4MedicationIf 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-3MedicationIf 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))]))
ele-1Medication.product.ingredient.extensionAll FHIR elements must have a @value or children
XPath: @value|f:*|h:div
ext-1Medication.product.ingredient.extensionMust have either extensions or value[x], not both
XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
.