This page is part of the US Core (v3.1.0: STU3) based on FHIR R4. The current version which supercedes this version is 5.0.1. For a full list of available versions, 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:
- 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 AEST 2019 as active by the HL7 US Realm Steering Committee.
This profile builds on Medication
Medication
Summary of the Mandatory Requirements
- A CodeableConcept in
Medication.code
with an extensible binding to US Core Medication Codes (RxNorm)
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Medication | I | 0..* | Definition of a Medication | |
id | Σ | 0..1 | string | Logical id of this artifact |
meta | ΣI | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
identifier | ΣI | 0..* | Identifier | Business identifier for this medication |
code | SΣI | 1..1 | CodeableConcept | Codes that identify this medication Binding: US Core Medication Codes (RxNorm) (extensible) |
status | ?!ΣI | 0..1 | code | active | inactive | entered-in-error Binding: Medication Status Codes (required) |
manufacturer | ΣI | 0..1 | Reference(Organization) | Manufacturer of the item |
form | I | 0..1 | CodeableConcept | powder | tablets | capsule + Binding: SNOMEDCTFormCodes (example) |
amount | ΣI | 0..1 | Ratio | Amount of drug in package |
ingredient | I | 0..* | BackboneElement | Active or inactive ingredient |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
item[x] | I | 1..1 | The actual ingredient or content | |
itemCodeableConcept | CodeableConcept | |||
itemReference | Reference(Substance | Medication) | |||
isActive | I | 0..1 | boolean | Active ingredient indicator |
strength | I | 0..1 | Ratio | Quantity of ingredient present |
batch | I | 0..1 | BackboneElement | Details about packaged medications |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
lotNumber | I | 0..1 | string | Identifier assigned to batch |
expirationDate | I | 0..1 | dateTime | When batch will expire |
Documentation for this format |
Medication
Summary of the Mandatory Requirements
- A CodeableConcept in
Medication.code
with an extensible binding to US Core Medication Codes (RxNorm)
Differential View
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Medication | I | 0..* | Definition of a Medication | |
id | Σ | 0..1 | string | Logical id of this artifact |
meta | ΣI | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
identifier | ΣI | 0..* | Identifier | Business identifier for this medication |
code | SΣI | 1..1 | CodeableConcept | Codes that identify this medication Binding: US Core Medication Codes (RxNorm) (extensible) |
status | ?!ΣI | 0..1 | code | active | inactive | entered-in-error Binding: Medication Status Codes (required) |
manufacturer | ΣI | 0..1 | Reference(Organization) | Manufacturer of the item |
form | I | 0..1 | CodeableConcept | powder | tablets | capsule + Binding: SNOMEDCTFormCodes (example) |
amount | ΣI | 0..1 | Ratio | Amount of drug in package |
ingredient | I | 0..* | BackboneElement | Active or inactive ingredient |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
item[x] | I | 1..1 | The actual ingredient or content | |
itemCodeableConcept | CodeableConcept | |||
itemReference | Reference(Substance | Medication) | |||
isActive | I | 0..1 | boolean | Active ingredient indicator |
strength | I | 0..1 | Ratio | Quantity of ingredient present |
batch | I | 0..1 | BackboneElement | Details about packaged medications |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
lotNumber | I | 0..1 | string | Identifier assigned to batch |
expirationDate | I | 0..1 | dateTime | When batch will expire |
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.