HL7 FHIR Implementation Guide: minimal Common Oncology Data Elements (mCODE), v0.9.0

Publish Box goes here

Medication

 

The official URL for this profile is:

http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-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. In FHIR DSTU2 and STU3, Medication lacks the identifier attribute, which is included in SHR as an extension. DSTU2 lacks the status attribute, which is required by US-Core. Batch is 0..1 in FHIR R4, and accordingly is restricted here.

This profile builds on http://fhir.org/guides/argonaut/StructureDefinition/argo-medication.

This profile was published on Wed Apr 17 00:00:00 EDT 2019 as a draft by The MITRE Corporation.

Summary

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Mapping Source

This structure represents the following mapping definition:

shr.core.Medication maps to http://fhir.org/guides/argonaut/StructureDefinition/argo-medication:
  _Entry.EntryId maps to id
  Language maps to language
  Narrative maps to text
  ImplicitRules maps to implicitRules
  Metadata.VersionId maps to meta.versionId
  Metadata.Profile maps to meta.profile
  Metadata.LastUpdated maps to meta.lastUpdated
  Metadata.SecurityLabel maps to meta.security
  Metadata.Tag maps to meta.tag
  Identifier maps to extension
  Status maps to extension
  Type maps to code
  DoseForm maps to product.form
  Ingredient.SubstanceOrCode maps to product.ingredient.item
  Ingredient.IngredientAmount maps to product.ingredient.amount
  Brand.IsBrand maps to isBrand
  Manufacturer maps to manufacturer
  constrain product.batch to 0..1
  LotNumber maps to product.batch.lotNumber
  ExpirationDate maps to product.batch.expirationDate
  Package maps to package.container

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..*shr-core-Medication
... 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: http://tools.ietf.org/html/bcp47 (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
... shr-core-Identifier-extension 0..*IdentifierIdentifier
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-Identifier-extension
... shr-core-Status-extension 0..1CodeableConceptStatus
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-Status-extension
.... id 0..1stringxml:id (or equivalent in JSON)
.... url 1..1uri"http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-Status-extension"
.... valueCodeableConcept 1..1CodeableConceptValue of extension
Binding: medication-status (required)
... shr-core-OverTheCounter-extension 0..1booleanOverTheCounter
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-OverTheCounter-extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... code S1..1CodeableConceptCodes that identify this medication
Binding: http://hl7.org/fhir/us/core/ValueSet/us-core-medication-codes (extensible)
... isBrand Σ0..1booleanTrue if a brand
... manufacturer Σ0..1Reference(shr-core-Organization)Manufacturer of the item
... product 0..1BackboneElementAdministrable 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 0..1CodeableConceptpowder | tablets | carton +
Binding: SNOMED CT Form Codes (required)
.... ingredient 0..*BackboneElementActive 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 1..1Reference(shr-core-Substance | shr-core-Medication)The product contained
..... amount 0..1RatioQuantity of ingredient present
.... batch 0..1BackboneElement
..... id 0..1idxml: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..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: medication-package-form (example)
.... content 0..*BackboneElementWhat 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..1Reference(Medication)A product in the package
..... amount 0..1SimpleQuantityQuantity present in the package

doco Documentation for this format

Summary

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Mapping Source

This structure represents the following mapping definition:

shr.core.Medication maps to http://fhir.org/guides/argonaut/StructureDefinition/argo-medication:
  _Entry.EntryId maps to id
  Language maps to language
  Narrative maps to text
  ImplicitRules maps to implicitRules
  Metadata.VersionId maps to meta.versionId
  Metadata.Profile maps to meta.profile
  Metadata.LastUpdated maps to meta.lastUpdated
  Metadata.SecurityLabel maps to meta.security
  Metadata.Tag maps to meta.tag
  Identifier maps to extension
  Status maps to extension
  Type maps to code
  DoseForm maps to product.form
  Ingredient.SubstanceOrCode maps to product.ingredient.item
  Ingredient.IngredientAmount maps to product.ingredient.amount
  Brand.IsBrand maps to isBrand
  Manufacturer maps to manufacturer
  constrain product.batch to 0..1
  LotNumber maps to product.batch.lotNumber
  ExpirationDate maps to product.batch.expirationDate
  Package maps to package.container

Differential View

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..*shr-core-Medication
... 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: http://tools.ietf.org/html/bcp47 (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
... shr-core-Identifier-extension 0..*IdentifierIdentifier
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-Identifier-extension
... shr-core-Status-extension 0..1CodeableConceptStatus
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-Status-extension
.... id 0..1stringxml:id (or equivalent in JSON)
.... url 1..1uri"http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-Status-extension"
.... valueCodeableConcept 1..1CodeableConceptValue of extension
Binding: medication-status (required)
... shr-core-OverTheCounter-extension 0..1booleanOverTheCounter
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-OverTheCounter-extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... code S1..1CodeableConceptCodes that identify this medication
Binding: http://hl7.org/fhir/us/core/ValueSet/us-core-medication-codes (extensible)
... isBrand Σ0..1booleanTrue if a brand
... manufacturer Σ0..1Reference(shr-core-Organization)Manufacturer of the item
... product 0..1BackboneElementAdministrable 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 0..1CodeableConceptpowder | tablets | carton +
Binding: SNOMED CT Form Codes (required)
.... ingredient 0..*BackboneElementActive 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 1..1Reference(shr-core-Substance | shr-core-Medication)The product contained
..... amount 0..1RatioQuantity of ingredient present
.... batch 0..1BackboneElement
..... id 0..1idxml: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..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: medication-package-form (example)
.... content 0..*BackboneElementWhat 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..1Reference(Medication)A product in the package
..... amount 0..1SimpleQuantityQuantity present in the package

doco Documentation for this format

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

 

Terminology Bindings

PathConformanceValueSet
Medication.codeextensiblehttp://hl7.org/fhir/us/core/ValueSet/us-core-medication-codes

 

Constraints

IdPathDetailsRequirements