HL7 FHIR Implementation Guide: Breast Cancer Data, Release 1 - US Realm (Draft for Comment 2)
This page is part of the Breast Cancer Data Logical Models and FHIR Profiles (v0.2.0: STU 1 Draft) based on FHIR R3. . For a full list of available versions, see the Directory of published versions 
The official URL for this profile is:
http://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-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 Fri Aug 17 00:00:00 AEST 2018 as a draft by The HL7 Cancer Interoperability Group sponsored by Clinical Interoperability Council Work Group (CIC).
View the corresponding MedicationModel logical model.
Summary
Structures
This structure refers to these other structures:
BC Mapping Source
This structure represents the following BC mapping definition:
cimi.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
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Medication | BC Medication Profile | |||
  manufacturer | Reference(BC Organization Profile) | |||
| form | Binding: SNOMED CT Form Codes (required) | |||
| ingredient | ||||
  item[x] | CodeableConcept, Reference(BC Substance Profile | BC Medication Profile) | |||
  amount | RatioProfile | |||
| package | ||||
 batch | 0..1 | |||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Medication | I | 0..* | BC Medication Profile | |
 id | Σ | 0..1 | id | Logical id of this artifact |
| meta | Σ | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) | |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
 contained | 0..* | Resource | Contained, inline Resources | |
 extension | 0..* | Extension | Additional Content defined by implementations | |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| code | SΣ | 1..1 | CodeableConcept | Codes that identify this medication Binding: Medication Clinical Drug (RxNorm) (extensible) |
| status | Σ | 0..1 | code | active | inactive | entered-in-error Binding: MedicationStatus (required) |
| isBrand | Σ | 0..1 | boolean | True if a brand |
| isOverTheCounter | Σ | 0..1 | boolean | True if medication does not require a prescription |
| manufacturer | Σ | 0..1 | Reference(BC Organization Profile) | Manufacturer of the item |
| form | 0..1 | CodeableConcept | powder | tablets | capsule + Binding: SNOMED CT Form Codes (required) | |
| ingredient | I | 0..* | BackboneElement | Active or inactive ingredient |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| item[x] | 1..1 | CodeableConcept, Reference(BC Substance Profile | BC Medication Profile) | The product contained | |
| isActive | 0..1 | boolean | Active ingredient indicator | |
| amount | 0..1 | RatioProfile | Quantity of ingredient present | |
| package | I | 0..1 | BackboneElement | Details about packaged medications |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| container | 0..1 | CodeableConcept | E.g. box, vial, blister-pack Binding: MedicationContainer (example) | |
| content | I | 0..* | BackboneElement | What is in the package |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| item[x] | 1..1 | CodeableConcept, Reference(Medication) | The item in the package | |
| amount | 0..1 | SimpleQuantity | Quantity present in the package | |
| batch | I | 0..1 | BackboneElement | Identifies a single production run |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| lotNumber | 0..1 | string | Identifier assigned to batch | |
| expirationDate | 0..1 | dateTime | When batch will expire | |
| image | 0..* | Attachment | Picture of the medication | |
| Documentation for this format | ||||
Summary
Structures
This structure refers to these other structures:
BC Mapping Source
This structure represents the following BC mapping definition:
cimi.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
Differential View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Medication | BC Medication Profile | |||
| manufacturer | Reference(BC Organization Profile) | |||
| form | Binding: SNOMED CT Form Codes (required) | |||
| ingredient | ||||
| item[x] | CodeableConcept, Reference(BC Substance Profile | BC Medication Profile) | |||
| amount | RatioProfile | |||
| package | ||||
| batch | 0..1 | |||
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Medication | I | 0..* | BC Medication Profile | |
| id | Σ | 0..1 | id | Logical id of this artifact |
| meta | Σ | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) | |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| code | SΣ | 1..1 | CodeableConcept | Codes that identify this medication Binding: Medication Clinical Drug (RxNorm) (extensible) |
| status | Σ | 0..1 | code | active | inactive | entered-in-error Binding: MedicationStatus (required) |
| isBrand | Σ | 0..1 | boolean | True if a brand |
| isOverTheCounter | Σ | 0..1 | boolean | True if medication does not require a prescription |
| manufacturer | Σ | 0..1 | Reference(BC Organization Profile) | Manufacturer of the item |
| form | 0..1 | CodeableConcept | powder | tablets | capsule + Binding: SNOMED CT Form Codes (required) | |
| ingredient | I | 0..* | BackboneElement | Active or inactive ingredient |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| item[x] | 1..1 | CodeableConcept, Reference(BC Substance Profile | BC Medication Profile) | The product contained | |
| isActive | 0..1 | boolean | Active ingredient indicator | |
| amount | 0..1 | RatioProfile | Quantity of ingredient present | |
| package | I | 0..1 | BackboneElement | Details about packaged medications |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| container | 0..1 | CodeableConcept | E.g. box, vial, blister-pack Binding: MedicationContainer (example) | |
| content | I | 0..* | BackboneElement | What is in the package |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| item[x] | 1..1 | CodeableConcept, Reference(Medication) | The item in the package | |
| amount | 0..1 | SimpleQuantity | Quantity present in the package | |
| batch | I | 0..1 | BackboneElement | Identifies a single production run |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| lotNumber | 0..1 | string | Identifier assigned to batch | |
| expirationDate | 0..1 | dateTime | When batch will expire | |
| image | 0..* | Attachment | Picture of the medication | |
| Documentation for this format | ||||
Downloads: StructureDefinition: (XML, JSON, TTL), Schema: XML Schematron
| Path | Name | Conformance | ValueSet |
| Medication.language | Common Languages | extensible | Common Languages |
| Medication.code | Medication Clinical Drug (RxNorm) | extensible | Medication Clinical Drug (RxNorm) |
| Medication.status | MedicationStatus | required | MedicationStatus |
| Medication.form | SNOMED CT Form Codes | required | SNOMED CT Form Codes |
| Medication.package.container | MedicationContainer | example | MedicationContainer |
| Id | Path | Details | Requirements |
| dom-2 | Medication | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-1 | Medication | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty() | |
| dom-4 | Medication | If 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-3 | Medication | If 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-1 | Medication.ingredient | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
| ele-1 | Medication.package | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
| ele-1 | Medication.package.content | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
| ele-1 | Medication.package.batch | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) |