HL7 FHIR® UK Core - Local Development build (v4.0.0). See the Directory of published versions
StructureDefinition: UKCoreMedication
Defines the UK Core constraints and extensions on the Medication resource for the minimal set of data to query and retrieve medication information.
The official URL for this profile is:
https://fhir.nhs.uk/R4/StructureDefinition/UKCore-Medication
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Medication
This structure is derived from Medication
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Medication | 0..* | Medication | ||
  identifier | ||||
   assigner | 0..1 | Reference(UK Core Organization) | ||
 code | 0..1 | CodeableConcept | Binding: UK Core Medication Code (extensible) | |
| manufacturer | 0..1 | Reference(UK Core Organization) | ||
 identifier | ||||
 assigner | 0..1 | Reference(UK Core Organization) | ||
| form | 0..1 | CodeableConcept | Binding: UK Core Medication Form (extensible) | |
| ingredient | ||||
 item[x] | 1..1 | |||
 itemCodeableConcept | CodeableConcept | |||
| itemReference | Reference(Substance | UK Core Medication) | |||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Medication | I | 0..* | Medication | 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 |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| use | ?!ΣI | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
| type | ΣI | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
| system | ΣI | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | ΣI | 0..1 | string | The value that is unique Example General: 123456 |
| period | ΣI | 0..1 | Period | Time period when id is/was valid for use |
| assigner | ΣI | 0..1 | Reference(UK Core Organization) | Organization that issued id (may be just text) |
| code | ΣI | 0..1 | CodeableConcept | Codes that identify this medication Binding: UK Core Medication Code (extensible) |
| status | ?!ΣI | 0..1 | code | active | inactive | entered-in-error Binding: Medication Status Codes (required) |
| manufacturer | ΣI | 0..1 | Reference(UK Core Organization) | Manufacturer of the item |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| reference | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| type | ΣI | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) |
| identifier | ΣI | 0..1 | Identifier | Logical reference, when literal reference is not known |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| use | ?!ΣI | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
| type | ΣI | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
| system | ΣI | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | ΣI | 0..1 | string | The value that is unique Example General: 123456 |
| period | ΣI | 0..1 | Period | Time period when id is/was valid for use |
| assigner | ΣI | 0..1 | Reference(UK Core Organization) | Organization that issued id (may be just text) |
| display | ΣI | 0..1 | string | Text alternative for the resource |
| form | I | 0..1 | CodeableConcept | powder | tablets | capsule + Binding: UK Core Medication Form (extensible) |
| 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 | UK Core 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 | ||||
This structure is derived from Medication
Differential View
This structure is derived from Medication
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Medication | 0..* | Medication | ||
| identifier | ||||
| assigner | 0..1 | Reference(UK Core Organization) | ||
| code | 0..1 | CodeableConcept | Binding: UK Core Medication Code (extensible) | |
| manufacturer | 0..1 | Reference(UK Core Organization) | ||
| identifier | ||||
| assigner | 0..1 | Reference(UK Core Organization) | ||
| form | 0..1 | CodeableConcept | Binding: UK Core Medication Form (extensible) | |
| ingredient | ||||
| item[x] | 1..1 | |||
| itemCodeableConcept | CodeableConcept | |||
| itemReference | Reference(Substance | UK Core Medication) | |||
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Medication | I | 0..* | Medication | 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 |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| use | ?!ΣI | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
| type | ΣI | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
| system | ΣI | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | ΣI | 0..1 | string | The value that is unique Example General: 123456 |
| period | ΣI | 0..1 | Period | Time period when id is/was valid for use |
| assigner | ΣI | 0..1 | Reference(UK Core Organization) | Organization that issued id (may be just text) |
| code | ΣI | 0..1 | CodeableConcept | Codes that identify this medication Binding: UK Core Medication Code (extensible) |
| status | ?!ΣI | 0..1 | code | active | inactive | entered-in-error Binding: Medication Status Codes (required) |
| manufacturer | ΣI | 0..1 | Reference(UK Core Organization) | Manufacturer of the item |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| reference | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| type | ΣI | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) |
| identifier | ΣI | 0..1 | Identifier | Logical reference, when literal reference is not known |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| use | ?!ΣI | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
| type | ΣI | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
| system | ΣI | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | ΣI | 0..1 | string | The value that is unique Example General: 123456 |
| period | ΣI | 0..1 | Period | Time period when id is/was valid for use |
| assigner | ΣI | 0..1 | Reference(UK Core Organization) | Organization that issued id (may be just text) |
| display | ΣI | 0..1 | string | Text alternative for the resource |
| form | I | 0..1 | CodeableConcept | powder | tablets | capsule + Binding: UK Core Medication Form (extensible) |
| 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 | UK Core 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 | ||||
Other representations of profile: Schematron
Terminology Bindings
Terminology Bindings
| Path | Conformance | ValueSet |
| Medication.language | preferred | CommonLanguages Max Binding: AllLanguages |
| Medication.identifier.use | required | IdentifierUse |
| Medication.identifier.type | extensible | Identifier Type Codes |
| Medication.code | extensible | UKCoreMedicationCode |
| Medication.status | required | Medication Status Codes |
| Medication.manufacturer.type | extensible | ResourceType |
| Medication.manufacturer.identifier.use | required | IdentifierUse |
| Medication.manufacturer.identifier.type | extensible | Identifier Type Codes |
| Medication.form | extensible | UKCoreMedicationForm |
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-3 | Medication | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).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-5 | Medication | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | Medication | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | Medication.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Medication.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Medication.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Medication.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Medication.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Medication.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Medication.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Medication.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Medication.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Medication.identifier.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Medication.identifier.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Medication.identifier.use | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Medication.identifier.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Medication.identifier.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Medication.identifier.value | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Medication.identifier.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Medication.identifier.assigner | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Medication.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Medication.status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Medication.manufacturer | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Medication.manufacturer.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Medication.manufacturer.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Medication.manufacturer.reference | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Medication.manufacturer.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Medication.manufacturer.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Medication.manufacturer.identifier.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Medication.manufacturer.identifier.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Medication.manufacturer.identifier.use | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Medication.manufacturer.identifier.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Medication.manufacturer.identifier.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Medication.manufacturer.identifier.value | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Medication.manufacturer.identifier.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Medication.manufacturer.identifier.assigner | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Medication.manufacturer.display | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Medication.form | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Medication.amount | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Medication.ingredient | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Medication.ingredient.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Medication.ingredient.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Medication.ingredient.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Medication.ingredient.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Medication.ingredient.item[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Medication.ingredient.isActive | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Medication.ingredient.strength | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Medication.batch | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Medication.batch.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Medication.batch.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Medication.batch.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Medication.batch.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Medication.batch.lotNumber | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Medication.batch.expirationDate | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |