HL7 FHIR® US Core Implementation Guide CI Build

US Core, published by HL7 International - US Realm Steering Committee. This is not an authorized publication; it is the continuous build for version 3.1.0). This version is based on the current content of https://github.com/HL7/US-Core-R4/ and changes regularly. See the Directory of published versions

StructureDefinition-us-core-medication

When referencing a medication, the MedicationStatement and MedicationRequest resources can either use a code or refer to a Medication resource. This profile sets minimum expectations for the Medication resource to record, search, and fetch medications associated with a patient. It identifies which core elements, extensions, vocabularies and value sets SHALL be present in the resource when using this profile.

Example Usage Scenarios:

Queries on Medication resource are expected to be within the context of a MedicationStatement or a MedicationRequest resource query. The following are example usage scenarios for the US Core Medication profile:

  • Query for Medications with a particular code

Mandatory and Must Support Data Elements

The following data-elements are mandatory (i.e data MUST be present) or must be supported if the data is present in the sending system (Must Support definition). They are presented below in a simple human-readable explanation. Profile specific guidance and examples are provided as well. The Formal Profile Definition below provides the formal summary, definitions, and terminology requirements.

Each Medication must have:

  1. A medication code

Profile specific implementation guidance:

  • Since the binding is extensible, when a code is unavailable just text is allowed.
  • When the medication is compounded and is a list of ingredients, the code is still present and may contain only the text.

Formal Views of Profile Content

Description of Profiles, Differentials, and Snapshots.

The official URL for this profile is: http://hl7.org/fhir/us/core/StructureDefinition/us-core-medication

Published on Tue May 21 00:00:00 UTC 2019 as active by the HL7 US Realm Steering Committee.

This profile builds on Medication


Medication

Summary of the Mandatory Requirements

  1. A CodeableConcept in Medication.code with an extensible binding to US Core Medication Codes (RxNorm)
NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication I0..*MedicationDefinition of a Medication
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*IdentifierBusiness identifier for this medication
... code SΣI1..1CodeableConceptCodes that identify this medication
Binding: US Core Medication Codes (RxNorm) (extensible)
... status ?!ΣI0..1codeactive | inactive | entered-in-error
Binding: Medication Status Codes (required)
... manufacturer ΣI0..1Reference(Organization)Manufacturer of the item
... form I0..1CodeableConceptpowder | tablets | capsule +
Binding: SNOMEDCTFormCodes (example)
... amount ΣI0..1RatioAmount of drug in package
... ingredient I0..*BackboneElementActive or inactive ingredient
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... item[x] I1..1The actual ingredient or content
..... itemCodeableConceptCodeableConcept
..... itemReferenceReference(Substance | Medication)
.... isActive I0..1booleanActive ingredient indicator
.... strength I0..1RatioQuantity of ingredient present
... batch I0..1BackboneElementDetails about packaged medications
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... lotNumber I0..1stringIdentifier assigned to batch
.... expirationDate I0..1dateTimeWhen batch will expire

doco Documentation for this format

Medication

Summary of the Mandatory Requirements

  1. A CodeableConcept in Medication.code with an extensible binding to US Core Medication Codes (RxNorm)

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication I0..*MedicationDefinition of a Medication
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*IdentifierBusiness identifier for this medication
... code SΣI1..1CodeableConceptCodes that identify this medication
Binding: US Core Medication Codes (RxNorm) (extensible)
... status ?!ΣI0..1codeactive | inactive | entered-in-error
Binding: Medication Status Codes (required)
... manufacturer ΣI0..1Reference(Organization)Manufacturer of the item
... form I0..1CodeableConceptpowder | tablets | capsule +
Binding: SNOMEDCTFormCodes (example)
... amount ΣI0..1RatioAmount of drug in package
... ingredient I0..*BackboneElementActive or inactive ingredient
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... item[x] I1..1The actual ingredient or content
..... itemCodeableConceptCodeableConcept
..... itemReferenceReference(Substance | Medication)
.... isActive I0..1booleanActive ingredient indicator
.... strength I0..1RatioQuantity of ingredient present
... batch I0..1BackboneElementDetails about packaged medications
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... lotNumber I0..1stringIdentifier assigned to batch
.... expirationDate I0..1dateTimeWhen batch will expire

doco Documentation for this format

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


Quick Start

Below is an overview of the required set of RESTful FHIR interactions - for example, search and read operations - for this profile. See the Conformance requirements for a complete list of supported RESTful interactions for this IG.

  • See the [General Guidance] section for additional rules and expectations when a server requires status parameters.

No required search criteria for us-core-medication profile.