INTEROPen CareConnect Base STU3 Implementation Guide - Local Development build (v3.0.0). See the Directory of published versions
StructureDefinition: CareConnect-Medication-1
This Medication Resource is primarily used for the identification and definition of a medication.
The official URL for this profile is:
https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Medication-1
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Medication
Summary
Mandatory: 0 element (3 nested mandatory elements)
Fixed Value: 1 element
Structures
This structure refers to these other structures:
- https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Organization-1
- https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Medication-1
Extensions
This structure refers to these extensions:
This structure is derived from Medication
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Medication | I | 0..* | Medication | Definition of a Medication |
  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) Max Binding: All Languages | |
| 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 | Σ | 0..1 | CodeableConcept | Codes that identify this medication Binding: Care Connect Medication Code (required) |
 id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | 0..* | Coding | Code defined by a terminology system |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
 Extension-coding-sctdescid | 0..* | (Complex) | The SNOMED CT Description ID for the display URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid | |
| system | Σ | 0..1 | uri | Identity of the terminology system |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | Σ | 0..1 | code | Symbol in syntax defined by the system |
| display | Σ | 0..1 | string | Representation defined by the system |
 userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| text | Σ | 0..1 | string | Plain text representation of the concept |
| 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(CareConnect-Organization-1) | Manufacturer of the item |
| form | 0..1 | CodeableConcept | Codes that describe a medication dose form Binding: Care Connect Medication Form (required) | |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | 0..* | Coding | Code defined by a terminology system |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| Extension-coding-sctdescid | 0..* | (Complex) | The SNOMED CT Description ID for the display URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid | |
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | Σ | 1..1 | code | Symbol in syntax defined by the system |
| display | Σ | 1..1 | string | Representation defined by the system |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| text | Σ | 0..1 | string | Plain text representation of the concept |
| 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 | The product contained | ||
| itemCodeableConcept | CodeableConcept | |||
| itemReference | Reference(Substance | CareConnect-Medication-1) | |||
| isActive | 0..1 | boolean | Active ingredient indicator | |
| amount | 0..1 | Ratio | 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 | The item in the package | ||
| itemCodeableConcept | CodeableConcept | |||
| itemReference | Reference(CareConnect-Medication-1) | |||
| amount | 0..1 | SimpleQuantity | Quantity present in the package | |
 batch | I | 0..* | 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 | ||||
This structure is derived from Medication
Summary
Mandatory: 0 element (3 nested mandatory elements)
Fixed Value: 1 element
Structures
This structure refers to these other structures:
- https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Organization-1
- https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Medication-1
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from Medication
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Medication | I | 0..* | Medication | Definition of a Medication |
| 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) Max Binding: All Languages | |
| 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 | Σ | 0..1 | CodeableConcept | Codes that identify this medication Binding: Care Connect Medication Code (required) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | 0..* | Coding | Code defined by a terminology system |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| Extension-coding-sctdescid | 0..* | (Complex) | The SNOMED CT Description ID for the display URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid | |
| system | Σ | 0..1 | uri | Identity of the terminology system |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | Σ | 0..1 | code | Symbol in syntax defined by the system |
| display | Σ | 0..1 | string | Representation defined by the system |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| text | Σ | 0..1 | string | Plain text representation of the concept |
| 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(CareConnect-Organization-1) | Manufacturer of the item |
| form | 0..1 | CodeableConcept | Codes that describe a medication dose form Binding: Care Connect Medication Form (required) | |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | 0..* | Coding | Code defined by a terminology system |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| Extension-coding-sctdescid | 0..* | (Complex) | The SNOMED CT Description ID for the display URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid | |
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | Σ | 1..1 | code | Symbol in syntax defined by the system |
| display | Σ | 1..1 | string | Representation defined by the system |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| text | Σ | 0..1 | string | Plain text representation of the concept |
| 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 | The product contained | ||
| itemCodeableConcept | CodeableConcept | |||
| itemReference | Reference(Substance | CareConnect-Medication-1) | |||
| isActive | 0..1 | boolean | Active ingredient indicator | |
| amount | 0..1 | Ratio | 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 | The item in the package | ||
| itemCodeableConcept | CodeableConcept | |||
| itemReference | Reference(CareConnect-Medication-1) | |||
| amount | 0..1 | SimpleQuantity | Quantity present in the package | |
| batch | I | 0..* | 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 | ||||
Other representations of profile: Schematron
Terminology Bindings
Terminology Bindings
| Path | Conformance | ValueSet |
| Medication.language | extensible | Common Languages Max Binding: All Languages |
| Medication.code | required | Care Connect Medication Code |
| Medication.status | required | MedicationStatus |
| Medication.form | required | Care Connect Medication Form |
| Medication.package.container | example | MedicationContainer |
Constraints
Constraints
| 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()) |