Standard Health Record FHIR Implementation Guide

SHR Medication Profile

 

The official URL for this profile is:

http://standardhealthrecord.org/fhir/StructureDefinition/shr-entity-Medication

A type of prescription drug or over-the-counter drug that is used to prevent, treat, or relieve symptoms of a disease or abnormal condition, but excluding vaccines.

This profile builds on US Core Medication Profile.

This profile was published on Tue Feb 27 00:00:00 EST 2018 as a draft by The MITRE Corporation: Standard Health Record Collaborative.

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

Summary

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

SHR Mapping Source

This structure represents the following SHR mapping definition:

shr.entity.Medication maps to http://hl7.org/fhir/us/core/StructureDefinition/us-core-medication:
  Type maps to code
  DoseForm maps to form
  MedicationIngredient.CodeableConcept maps to ingredient.item[x]
  MedicationIngredient.Substance maps to ingredient.item[x]
  MedicationIngredient.Medication maps to ingredient.item[x]
  MedicationIngredient.IngredientAmount maps to ingredient.amount
  MedicationIngredient.IsActiveIngredient maps to ingredient.isActive
  Brand maps to isBrand
  OverTheCounter maps to isOverTheCounter
  Manufacturer maps to manufacturer
  constrain package.batch to 0..1
  LotNumber maps to package.batch.lotNumber
  ExpirationDate maps to package.batch.expirationDate
  Package maps to package.container

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication I0..*SHR Medication Profile
... 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
... shr-base-RelatedEncounter-extension 0..1Reference(SHR EncounterPerformed Profile)SHR RelatedEncounter Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-RelatedEncounter-extension
... shr-base-Author-extension 0..1(Complex)SHR Author Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Author-extension
... shr-base-Informant-extension 0..1(Complex)SHR Informant Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Informant-extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... code SΣ1..1CodeableConceptCodes that identify this medication
Binding: Medication Clinical Drug (RxNorm) (extensible)
... status Σ0..1codeactive | inactive | entered-in-error
Binding: MedicationStatus (required)
... isBrand Σ0..1booleanTrue if a brand
... isOverTheCounter Σ0..1booleanTrue if medication does not require a prescription
... manufacturer Σ0..1Reference(SHR Organization Profile)Manufacturer of the item
... form 0..1CodeableConceptpowder | tablets | capsule +
Binding: SNOMED CT Form Codes (required)
... ingredient I0..*BackboneElementActive or inactive ingredient
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... item[x] 1..1CodeableConcept, Reference(SHR Substance Profile), Reference(SHR Medication Profile)The product contained
.... isActive 0..1booleanActive ingredient indicator
.... amount 0..1SHR Ratio ProfileQuantity of ingredient present
... package I0..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: MedicationContainer (example)
.... content I0..*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
..... item[x] 1..1CodeableConcept, Reference(Medication)The item in the package
..... amount 0..1SimpleQuantityQuantity present in the package
.... batch I0..1BackboneElementIdentifies a single production run
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... lotNumber 0..1stringIdentifier assigned to batch
..... expirationDate 0..1dateTimeWhen batch will expire
... image 0..*AttachmentPicture of the medication

doco Documentation for this format

Summary

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

SHR Mapping Source

This structure represents the following SHR mapping definition:

shr.entity.Medication maps to http://hl7.org/fhir/us/core/StructureDefinition/us-core-medication:
  Type maps to code
  DoseForm maps to form
  MedicationIngredient.CodeableConcept maps to ingredient.item[x]
  MedicationIngredient.Substance maps to ingredient.item[x]
  MedicationIngredient.Medication maps to ingredient.item[x]
  MedicationIngredient.IngredientAmount maps to ingredient.amount
  MedicationIngredient.IsActiveIngredient maps to ingredient.isActive
  Brand maps to isBrand
  OverTheCounter maps to isOverTheCounter
  Manufacturer maps to manufacturer
  constrain package.batch to 0..1
  LotNumber maps to package.batch.lotNumber
  ExpirationDate maps to package.batch.expirationDate
  Package maps to package.container

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication I0..*SHR Medication Profile
... 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
... shr-base-RelatedEncounter-extension 0..1Reference(SHR EncounterPerformed Profile)SHR RelatedEncounter Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-RelatedEncounter-extension
... shr-base-Author-extension 0..1(Complex)SHR Author Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Author-extension
... shr-base-Informant-extension 0..1(Complex)SHR Informant Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Informant-extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... code SΣ1..1CodeableConceptCodes that identify this medication
Binding: Medication Clinical Drug (RxNorm) (extensible)
... status Σ0..1codeactive | inactive | entered-in-error
Binding: MedicationStatus (required)
... isBrand Σ0..1booleanTrue if a brand
... isOverTheCounter Σ0..1booleanTrue if medication does not require a prescription
... manufacturer Σ0..1Reference(SHR Organization Profile)Manufacturer of the item
... form 0..1CodeableConceptpowder | tablets | capsule +
Binding: SNOMED CT Form Codes (required)
... ingredient I0..*BackboneElementActive or inactive ingredient
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... item[x] 1..1CodeableConcept, Reference(SHR Substance Profile), Reference(SHR Medication Profile)The product contained
.... isActive 0..1booleanActive ingredient indicator
.... amount 0..1SHR Ratio ProfileQuantity of ingredient present
... package I0..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: MedicationContainer (example)
.... content I0..*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
..... item[x] 1..1CodeableConcept, Reference(Medication)The item in the package
..... amount 0..1SimpleQuantityQuantity present in the package
.... batch I0..1BackboneElementIdentifies a single production run
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... lotNumber 0..1stringIdentifier assigned to batch
..... expirationDate 0..1dateTimeWhen batch will expire
... image 0..*AttachmentPicture of the medication

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON, TTL), Schema: XML Schematron

 

Terminology Bindings

PathNameConformanceValueSet
Medication.languageCommon LanguagesextensibleCommon Languages
Medication.codeMedication Clinical Drug (RxNorm)extensibleMedication Clinical Drug (RxNorm)
Medication.statusMedicationStatusrequiredMedicationStatus
Medication.formSNOMED CT Form CodesrequiredSNOMED CT Form Codes
Medication.package.containerMedicationContainerexampleMedicationContainer

 

Constraints

IdPathDetailsRequirements
dom-2MedicationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-1MedicationIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-4MedicationIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-3MedicationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
: contained.where(('#'+id in %resource.descendants().reference).not()).empty()
ele-1Medication.ingredientAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ele-1Medication.packageAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ele-1Medication.package.contentAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ele-1Medication.package.batchAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())