Interweave Implementation Guide
0.1.0 - ci-build
Interweave Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the R4 profiles here.
Official URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Interweave-Medication | Version: 0.1.0 | |||
Active as of 2024-07-17 | Computable Name: InterweaveMedication |
Interweave Medication resource profile.
Status: Active: Approved (STU)
This profile sets out the expectations for the Interweave medication resource. For shared care, the importance needs to be placed on “What” the medication is and its form. We therefore have defined a very minimal dataset and removed all unnecessary fields.
The following fields are mandatory:
In addition, the following fields are “Must Support” - i.e. they must be populated if relevant and known:
Other fields are optional and may be populated if known - on the understanding that not all data consumers will necessarily make use of them. Optional fields to note include:
identifier – Allows for an additional local medication identifier to be shared in addition to the official DM&D identifier.
manufacturer – Option to provide a reference to the organization which manufactured the medication.
ingredient – DISCOURAGED. This field has been discouraged to removed complexity. No real use case was identified at the time of writing, however, it was recognised that it may have a part to play in relation to allergies/intolerances, so it has been left in rather than removed. To keep this field inline with R4, the subfield ‘amount’ is removed and the field ‘strength’ introduced.
The following fields have been removed to keep the medication model clear:
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from CareConnect-Medication-1
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Medication | 0..* | CareConnect-Medication-1 | Definition of a Medication | |
id | S | 0..1 | id | Logical id of this artifact |
meta | ||||
versionId | S | 0..1 | id | Version specific identifier |
lastUpdated | S | 0..1 | instant | MANDATORY except in Contained Resources. When the resource version last changed. |
profile | S | 0..* | uri | Profiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile |
security | 0..* | Coding | DISCOURAGED - may not be honoured by Data Consumers | |
Slices for tag | 0..* | Coding | Tags applied to this resource Slice: Unordered, Open by value:system | |
tag:Source | S | 0..1 | Coding | MANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data |
system | 1..1 | uri | Identity of the terminology system Fixed Value: https://yhcr.nhs.uk/Source | |
code | S | 1..1 | code | The Data Provider Id of the system supplying the data |
display | S | 1..1 | string | Name of the system supplying the data |
tag:Provenance | S | 0..1 | Coding | MANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data |
system | 1..1 | uri | Identity of the terminology system Fixed Value: https://yhcr.nhs.uk/Provenance | |
code | S | 1..1 | code | The ODS Code of the organisation responsible for the data |
display | S | 1..1 | string | Name of the organisation supplying the data |
implicitRules | 0..1 | uri | DISCOURAGED - may not be honoured by Data Consumers | |
language | 0..1 | code | English is assumed (not currently a multi-lingual implementation) | |
text | 0..1 | Narrative | DISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
R4Identifier | 0..* | Identifier | Business identifier for this resource. URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-R4Identifier | |
code | S | 1..1 | CodeableConcept | Codes that identify this medication |
coding | ||||
system | 1..1 | uri | Identity of the terminology system | |
code | 1..1 | code | Symbol in syntax defined by the system | |
display | 1..1 | string | Representation defined by the system | |
status | 0..0 | |||
isBrand | 0..0 | |||
isOverTheCounter | 0..0 | |||
form | S | 0..1 | CodeableConcept | Codes that describe a medication dose form |
ingredient | ||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
strengthR4 | 0..1 | Ratio | Quantity of ingredient present. URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-R4IngredientStrength | |
item[x] | S | 1..1 | CodeableConcept, Reference(Substance | CareConnect-Medication-1) | The product contained |
amount | 0..0 | |||
package | 0..0 | |||
image | 0..0 | |||
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Medication | 0..* | CareConnect-Medication-1 | Definition of a Medication | |||||
id | SΣ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
versionId | SΣ | 0..1 | id | Version specific identifier | ||||
lastUpdated | SΣ | 0..1 | instant | MANDATORY except in Contained Resources. When the resource version last changed. | ||||
profile | SΣ | 0..* | uri | Profiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile | ||||
security | Σ | 0..* | Coding | DISCOURAGED - may not be honoured by Data Consumers Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
Slices for tag | Σ | 0..* | Coding | Tags applied to this resource Slice: Unordered, Open by value:system Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones" | ||||
tag:Source | SΣ | 0..1 | Coding | MANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones" | ||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: https://yhcr.nhs.uk/Source | ||||
code | SΣ | 1..1 | code | The Data Provider Id of the system supplying the data | ||||
display | SΣ | 1..1 | string | Name of the system supplying the data | ||||
tag:Provenance | SΣ | 0..1 | Coding | MANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones" | ||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: https://yhcr.nhs.uk/Provenance | ||||
code | SΣ | 1..1 | code | The ODS Code of the organisation responsible for the data | ||||
display | SΣ | 1..1 | string | Name of the organisation supplying the data | ||||
implicitRules | ?!Σ | 0..1 | uri | DISCOURAGED - may not be honoured by Data Consumers | ||||
language | 0..1 | code | English is assumed (not currently a multi-lingual implementation) Binding: Common Languages (extensible): A human language.
| |||||
text | 0..1 | Narrative | DISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
R4Identifier | 0..* | Identifier | Business identifier for this resource. URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-R4Identifier | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
code | SΣ | 1..1 | CodeableConcept | Codes that identify this medication Binding: Care Connect Medication Code (required): A code from the SNOMED Clinical Terminology UK coding system that describes a medication from the VTM/VMP/VMPP/AMP/AMPP subsets from the dm+d terminology | ||||
form | S | 0..1 | CodeableConcept | Codes that describe a medication dose form Binding: Care Connect Medication Form (required): A code from the SNOMED Clinical Terminology UK coding system that describes a medication dose form | ||||
ingredient | 0..* | BackboneElement | Active or inactive ingredient | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
strengthR4 | 0..1 | Ratio | Quantity of ingredient present. URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-R4IngredientStrength | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
item[x] | S | 1..1 | The product contained | |||||
itemCodeableConcept | CodeableConcept | |||||||
itemReference | Reference(Substance | CareConnect-Medication-1) | |||||||
Documentation for this format |
Path | Conformance | ValueSet | ||||
Medication.meta.security | extensible | All Security Labels | ||||
Medication.meta.tag | example | Common Tags | ||||
Medication.meta.tag:Source | example | Common Tags | ||||
Medication.meta.tag:Provenance | example | Common Tags | ||||
Medication.language | extensible | Common Languages
| ||||
Medication.code | required | Care Connect Medication Code | ||||
Medication.form | required | Care Connect Medication Form |
Id | Grade | Path(s) | Details | Requirements |
dom-1 | error | Medication | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty() | |
dom-2 | error | Medication | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | 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() | |
dom-4 | error | 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() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Medication | 0..* | CareConnect-Medication-1 | Definition of a Medication | |||||
id | SΣ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
versionId | SΣ | 0..1 | id | Version specific identifier | ||||
lastUpdated | SΣ | 0..1 | instant | MANDATORY except in Contained Resources. When the resource version last changed. | ||||
profile | SΣ | 0..* | uri | Profiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile | ||||
security | Σ | 0..* | Coding | DISCOURAGED - may not be honoured by Data Consumers Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
Slices for tag | Σ | 0..* | Coding | Tags applied to this resource Slice: Unordered, Open by value:system Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones" | ||||
tag:Source | SΣ | 0..1 | Coding | MANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones" | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: https://yhcr.nhs.uk/Source | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | SΣ | 1..1 | code | The Data Provider Id of the system supplying the data | ||||
display | SΣ | 1..1 | string | Name of the system supplying the data | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
tag:Provenance | SΣ | 0..1 | Coding | MANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones" | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: https://yhcr.nhs.uk/Provenance | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | SΣ | 1..1 | code | The ODS Code of the organisation responsible for the data | ||||
display | SΣ | 1..1 | string | Name of the organisation supplying the data | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
implicitRules | ?!Σ | 0..1 | uri | DISCOURAGED - may not be honoured by Data Consumers | ||||
language | 0..1 | code | English is assumed (not currently a multi-lingual implementation) Binding: Common Languages (extensible): A human language.
| |||||
text | 0..1 | Narrative | DISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
R4Identifier | 0..* | Identifier | Business identifier for this resource. URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-R4Identifier | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
code | SΣ | 1..1 | CodeableConcept | Codes that identify this medication Binding: Care Connect Medication Code (required): A code from the SNOMED Clinical Terminology UK coding system that describes a medication from the VTM/VMP/VMPP/AMP/AMPP subsets from the dm+d terminology | ||||
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) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
snomedCTDescriptionID | 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 | ||||
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 | ||||
manufacturer | Σ | 0..1 | Reference(CareConnect-Organization-1) | Manufacturer of the item | ||||
form | S | 0..1 | CodeableConcept | Codes that describe a medication dose form Binding: Care Connect Medication Form (required): A code from the SNOMED Clinical Terminology UK coding system that describes a medication dose form | ||||
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) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
snomedCTDescriptionID | 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 | 0..* | BackboneElement | Active or inactive ingredient | |||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
strengthR4 | 0..1 | Ratio | Quantity of ingredient present. URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-R4IngredientStrength | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
item[x] | S | 1..1 | The product contained | |||||
itemCodeableConcept | CodeableConcept | |||||||
itemReference | Reference(Substance | CareConnect-Medication-1) | |||||||
isActive | 0..1 | boolean | Active ingredient indicator | |||||
Documentation for this format |
Path | Conformance | ValueSet | ||||
Medication.meta.security | extensible | All Security Labels | ||||
Medication.meta.tag | example | Common Tags | ||||
Medication.meta.tag:Source | example | Common Tags | ||||
Medication.meta.tag:Provenance | example | Common Tags | ||||
Medication.language | extensible | Common Languages
| ||||
Medication.code | required | Care Connect Medication Code | ||||
Medication.form | required | Care Connect Medication Form | ||||
Medication.package.container | example | MedicationContainer |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from CareConnect-Medication-1
Summary
Mandatory: 1 element (9 nested mandatory elements)
Must-Support: 13 elements
Fixed Value: 2 elements
Prohibited: 6 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from CareConnect-Medication-1
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Medication | 0..* | CareConnect-Medication-1 | Definition of a Medication | |
id | S | 0..1 | id | Logical id of this artifact |
meta | ||||
versionId | S | 0..1 | id | Version specific identifier |
lastUpdated | S | 0..1 | instant | MANDATORY except in Contained Resources. When the resource version last changed. |
profile | S | 0..* | uri | Profiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile |
security | 0..* | Coding | DISCOURAGED - may not be honoured by Data Consumers | |
Slices for tag | 0..* | Coding | Tags applied to this resource Slice: Unordered, Open by value:system | |
tag:Source | S | 0..1 | Coding | MANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data |
system | 1..1 | uri | Identity of the terminology system Fixed Value: https://yhcr.nhs.uk/Source | |
code | S | 1..1 | code | The Data Provider Id of the system supplying the data |
display | S | 1..1 | string | Name of the system supplying the data |
tag:Provenance | S | 0..1 | Coding | MANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data |
system | 1..1 | uri | Identity of the terminology system Fixed Value: https://yhcr.nhs.uk/Provenance | |
code | S | 1..1 | code | The ODS Code of the organisation responsible for the data |
display | S | 1..1 | string | Name of the organisation supplying the data |
implicitRules | 0..1 | uri | DISCOURAGED - may not be honoured by Data Consumers | |
language | 0..1 | code | English is assumed (not currently a multi-lingual implementation) | |
text | 0..1 | Narrative | DISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
R4Identifier | 0..* | Identifier | Business identifier for this resource. URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-R4Identifier | |
code | S | 1..1 | CodeableConcept | Codes that identify this medication |
coding | ||||
system | 1..1 | uri | Identity of the terminology system | |
code | 1..1 | code | Symbol in syntax defined by the system | |
display | 1..1 | string | Representation defined by the system | |
status | 0..0 | |||
isBrand | 0..0 | |||
isOverTheCounter | 0..0 | |||
form | S | 0..1 | CodeableConcept | Codes that describe a medication dose form |
ingredient | ||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
strengthR4 | 0..1 | Ratio | Quantity of ingredient present. URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-R4IngredientStrength | |
item[x] | S | 1..1 | CodeableConcept, Reference(Substance | CareConnect-Medication-1) | The product contained |
amount | 0..0 | |||
package | 0..0 | |||
image | 0..0 | |||
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Medication | 0..* | CareConnect-Medication-1 | Definition of a Medication | |||||
id | SΣ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
versionId | SΣ | 0..1 | id | Version specific identifier | ||||
lastUpdated | SΣ | 0..1 | instant | MANDATORY except in Contained Resources. When the resource version last changed. | ||||
profile | SΣ | 0..* | uri | Profiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile | ||||
security | Σ | 0..* | Coding | DISCOURAGED - may not be honoured by Data Consumers Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
Slices for tag | Σ | 0..* | Coding | Tags applied to this resource Slice: Unordered, Open by value:system Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones" | ||||
tag:Source | SΣ | 0..1 | Coding | MANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones" | ||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: https://yhcr.nhs.uk/Source | ||||
code | SΣ | 1..1 | code | The Data Provider Id of the system supplying the data | ||||
display | SΣ | 1..1 | string | Name of the system supplying the data | ||||
tag:Provenance | SΣ | 0..1 | Coding | MANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones" | ||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: https://yhcr.nhs.uk/Provenance | ||||
code | SΣ | 1..1 | code | The ODS Code of the organisation responsible for the data | ||||
display | SΣ | 1..1 | string | Name of the organisation supplying the data | ||||
implicitRules | ?!Σ | 0..1 | uri | DISCOURAGED - may not be honoured by Data Consumers | ||||
language | 0..1 | code | English is assumed (not currently a multi-lingual implementation) Binding: Common Languages (extensible): A human language.
| |||||
text | 0..1 | Narrative | DISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
R4Identifier | 0..* | Identifier | Business identifier for this resource. URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-R4Identifier | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
code | SΣ | 1..1 | CodeableConcept | Codes that identify this medication Binding: Care Connect Medication Code (required): A code from the SNOMED Clinical Terminology UK coding system that describes a medication from the VTM/VMP/VMPP/AMP/AMPP subsets from the dm+d terminology | ||||
form | S | 0..1 | CodeableConcept | Codes that describe a medication dose form Binding: Care Connect Medication Form (required): A code from the SNOMED Clinical Terminology UK coding system that describes a medication dose form | ||||
ingredient | 0..* | BackboneElement | Active or inactive ingredient | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
strengthR4 | 0..1 | Ratio | Quantity of ingredient present. URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-R4IngredientStrength | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
item[x] | S | 1..1 | The product contained | |||||
itemCodeableConcept | CodeableConcept | |||||||
itemReference | Reference(Substance | CareConnect-Medication-1) | |||||||
Documentation for this format |
Path | Conformance | ValueSet | ||||
Medication.meta.security | extensible | All Security Labels | ||||
Medication.meta.tag | example | Common Tags | ||||
Medication.meta.tag:Source | example | Common Tags | ||||
Medication.meta.tag:Provenance | example | Common Tags | ||||
Medication.language | extensible | Common Languages
| ||||
Medication.code | required | Care Connect Medication Code | ||||
Medication.form | required | Care Connect Medication Form |
Id | Grade | Path(s) | Details | Requirements |
dom-1 | error | Medication | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty() | |
dom-2 | error | Medication | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | 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() | |
dom-4 | error | 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() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Medication | 0..* | CareConnect-Medication-1 | Definition of a Medication | |||||
id | SΣ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
versionId | SΣ | 0..1 | id | Version specific identifier | ||||
lastUpdated | SΣ | 0..1 | instant | MANDATORY except in Contained Resources. When the resource version last changed. | ||||
profile | SΣ | 0..* | uri | Profiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile | ||||
security | Σ | 0..* | Coding | DISCOURAGED - may not be honoured by Data Consumers Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
Slices for tag | Σ | 0..* | Coding | Tags applied to this resource Slice: Unordered, Open by value:system Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones" | ||||
tag:Source | SΣ | 0..1 | Coding | MANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones" | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: https://yhcr.nhs.uk/Source | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | SΣ | 1..1 | code | The Data Provider Id of the system supplying the data | ||||
display | SΣ | 1..1 | string | Name of the system supplying the data | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
tag:Provenance | SΣ | 0..1 | Coding | MANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones" | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: https://yhcr.nhs.uk/Provenance | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | SΣ | 1..1 | code | The ODS Code of the organisation responsible for the data | ||||
display | SΣ | 1..1 | string | Name of the organisation supplying the data | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
implicitRules | ?!Σ | 0..1 | uri | DISCOURAGED - may not be honoured by Data Consumers | ||||
language | 0..1 | code | English is assumed (not currently a multi-lingual implementation) Binding: Common Languages (extensible): A human language.
| |||||
text | 0..1 | Narrative | DISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
R4Identifier | 0..* | Identifier | Business identifier for this resource. URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-R4Identifier | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
code | SΣ | 1..1 | CodeableConcept | Codes that identify this medication Binding: Care Connect Medication Code (required): A code from the SNOMED Clinical Terminology UK coding system that describes a medication from the VTM/VMP/VMPP/AMP/AMPP subsets from the dm+d terminology | ||||
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) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
snomedCTDescriptionID | 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 | ||||
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 | ||||
manufacturer | Σ | 0..1 | Reference(CareConnect-Organization-1) | Manufacturer of the item | ||||
form | S | 0..1 | CodeableConcept | Codes that describe a medication dose form Binding: Care Connect Medication Form (required): A code from the SNOMED Clinical Terminology UK coding system that describes a medication dose form | ||||
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) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
snomedCTDescriptionID | 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 | 0..* | BackboneElement | Active or inactive ingredient | |||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
strengthR4 | 0..1 | Ratio | Quantity of ingredient present. URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-R4IngredientStrength | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
item[x] | S | 1..1 | The product contained | |||||
itemCodeableConcept | CodeableConcept | |||||||
itemReference | Reference(Substance | CareConnect-Medication-1) | |||||||
isActive | 0..1 | boolean | Active ingredient indicator | |||||
Documentation for this format |
Path | Conformance | ValueSet | ||||
Medication.meta.security | extensible | All Security Labels | ||||
Medication.meta.tag | example | Common Tags | ||||
Medication.meta.tag:Source | example | Common Tags | ||||
Medication.meta.tag:Provenance | example | Common Tags | ||||
Medication.language | extensible | Common Languages
| ||||
Medication.code | required | Care Connect Medication Code | ||||
Medication.form | required | Care Connect Medication Form | ||||
Medication.package.container | example | MedicationContainer |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from CareConnect-Medication-1
Summary
Mandatory: 1 element (9 nested mandatory elements)
Must-Support: 13 elements
Fixed Value: 2 elements
Prohibited: 6 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron