Interweave Implementation Guide
0.1.0 - ci-build

Interweave Implementation Guide - Local Development build (v0.1.0). See the Directory of published versions

Resource Profile: InterweaveMedication

Official URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Interweave-Medication Version: 0.1.0
Active as of 2024-06-10 Computable Name: InterweaveMedication

Interweave Medication resource profile.

 Status: Active: Approved (STU)

Introduction

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.

Mandatory fields

The following fields are mandatory:

  • code – This field is the most important, we need to know what the medication is. A SNOMED dm+d code MUST be supplied.

Must Support fields

In addition, the following fields are “Must Support” - i.e. they must be populated if relevant and known:

  • form – This field is recommended by PRSB. Useful information if it is available.

Optional fields

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.

Discouraged or Removed fields

  • 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:

    • package
    • image
    • status
    • isBrand
    • isOverTheCounter

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from CareConnect-Medication-1

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..*CareConnect-Medication-1Definition of a Medication
... id S0..1idLogical id of this artifact
... meta
.... versionId S0..1idVersion specific identifier
.... lastUpdated S0..1instantMANDATORY except in Contained Resources. When the resource version last changed.
.... profile S0..*uriProfiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
.... security 0..*CodingDISCOURAGED - may not be honoured by Data Consumers
.... Slices for tag 0..*CodingTags applied to this resource
Slice: Unordered, Open by value:system
..... tag:Source S0..1CodingMANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data
...... system 1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Source
...... code S1..1codeThe Data Provider Id of the system supplying the data
...... display S1..1stringName of the system supplying the data
..... tag:Provenance S0..1CodingMANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data
...... system 1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Provenance
...... code S1..1codeThe ODS Code of the organisation responsible for the data
...... display S1..1stringName of the organisation supplying the data
... implicitRules 0..1uriDISCOURAGED - may not be honoured by Data Consumers
... text 0..1NarrativeDISCOURAGED - 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..*ExtensionExtension
Slice: Unordered, Open by value:url
... R4Identifier 0..*IdentifierBusiness identifier for this resource.
URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-R4Identifier
... code S1..1CodeableConceptCodes that identify this medication
.... coding
..... system 1..1uriIdentity of the terminology system
..... code 1..1codeSymbol in syntax defined by the system
..... display 1..1stringRepresentation defined by the system
... status 0..0
... isBrand 0..0
... isOverTheCounter 0..0
... form S0..1CodeableConceptCodes that describe a medication dose form
... ingredient
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... strengthR4 0..1RatioQuantity of ingredient present.
URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-R4IngredientStrength
.... item[x] S1..1CodeableConcept, Reference(Substance | CareConnect-Medication-1)The product contained
.... amount 0..0
... package 0..0
... image 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..*CareConnect-Medication-1Definition of a Medication
... id SΣ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... versionId SΣ0..1idVersion specific identifier
.... lastUpdated SΣ0..1instantMANDATORY except in Contained Resources. When the resource version last changed.
.... profile SΣ0..*uriProfiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
.... security Σ0..*CodingDISCOURAGED - 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..*CodingTags 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..1CodingMANDATORY 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..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Source
...... code SΣ1..1codeThe Data Provider Id of the system supplying the data
...... display SΣ1..1stringName of the system supplying the data
..... tag:Provenance SΣ0..1CodingMANDATORY 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..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Provenance
...... code SΣ1..1codeThe ODS Code of the organisation responsible for the data
...... display SΣ1..1stringName of the organisation supplying the data
... implicitRules ?!Σ0..1uriDISCOURAGED - may not be honoured by Data Consumers
... text 0..1NarrativeDISCOURAGED - 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..*ExtensionExtension
Slice: Unordered, Open by value:url
... R4Identifier 0..*IdentifierBusiness identifier for this resource.
URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-R4Identifier
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... code SΣ1..1CodeableConceptCodes 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 S0..1CodeableConceptCodes 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..*BackboneElementActive or inactive ingredient
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... strengthR4 0..1RatioQuantity of ingredient present.
URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-R4IngredientStrength
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... item[x] S1..1The product contained
..... itemCodeableConceptCodeableConcept
..... itemReferenceReference(Substance | CareConnect-Medication-1)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Medication.meta.securityextensibleAll Security Labels
Medication.meta.tagexampleCommon Tags
Medication.meta.tag:SourceexampleCommon Tags
Medication.meta.tag:ProvenanceexampleCommon Tags
Medication.languageextensibleCommon Languages
Additional Bindings Purpose
AllLanguages Max Binding
Medication.coderequiredCare Connect Medication Code
Medication.formrequiredCare Connect Medication Form

Constraints

IdGradePath(s)DetailsRequirements
dom-1errorMedicationIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-2errorMedicationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationIf 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-4errorMedicationIf 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-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..*CareConnect-Medication-1Definition of a Medication
... id SΣ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... versionId SΣ0..1idVersion specific identifier
.... lastUpdated SΣ0..1instantMANDATORY except in Contained Resources. When the resource version last changed.
.... profile SΣ0..*uriProfiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
.... security Σ0..*CodingDISCOURAGED - 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..*CodingTags 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..1CodingMANDATORY 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..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Source
...... version Σ0..1stringVersion of the system - if relevant
...... code SΣ1..1codeThe Data Provider Id of the system supplying the data
...... display SΣ1..1stringName of the system supplying the data
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... tag:Provenance SΣ0..1CodingMANDATORY 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..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Provenance
...... version Σ0..1stringVersion of the system - if relevant
...... code SΣ1..1codeThe ODS Code of the organisation responsible for the data
...... display SΣ1..1stringName of the organisation supplying the data
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
... implicitRules ?!Σ0..1uriDISCOURAGED - may not be honoured by Data Consumers
... text 0..1NarrativeDISCOURAGED - 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..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... R4Identifier 0..*IdentifierBusiness identifier for this resource.
URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-R4Identifier
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... code SΣ1..1CodeableConceptCodes 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..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ0..*CodingCode defined by a terminology system
..... id 0..1stringxml:id (or equivalent in JSON)
..... Slices for extension 0..*ExtensionExtension
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..1uriIdentity of the terminology system
..... version Σ0..1stringVersion of the system - if relevant
..... code Σ1..1codeSymbol in syntax defined by the system
..... display Σ1..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... manufacturer Σ0..1Reference(CareConnect-Organization-1)Manufacturer of the item
... form S0..1CodeableConceptCodes 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..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ0..*CodingCode defined by a terminology system
..... id 0..1stringxml:id (or equivalent in JSON)
..... Slices for extension 0..*ExtensionExtension
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..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
..... version Σ0..1stringVersion of the system - if relevant
..... code Σ1..1codeSymbol in syntax defined by the system
..... display Σ1..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... ingredient 0..*BackboneElementActive or inactive ingredient
.... id 0..1stringxml:id (or equivalent in JSON)
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... strengthR4 0..1RatioQuantity of ingredient present.
URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-R4IngredientStrength
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... item[x] S1..1The product contained
..... itemCodeableConceptCodeableConcept
..... itemReferenceReference(Substance | CareConnect-Medication-1)
.... isActive 0..1booleanActive ingredient indicator

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Medication.meta.securityextensibleAll Security Labels
Medication.meta.tagexampleCommon Tags
Medication.meta.tag:SourceexampleCommon Tags
Medication.meta.tag:ProvenanceexampleCommon Tags
Medication.languageextensibleCommon Languages
Additional Bindings Purpose
AllLanguages Max Binding
Medication.coderequiredCare Connect Medication Code
Medication.formrequiredCare Connect Medication Form
Medication.package.containerexampleMedicationContainer

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1error**ALL** extensionsMust 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:

  • The element Medication.meta.tag is sliced based on the value of value:system

Differential View

This structure is derived from CareConnect-Medication-1

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..*CareConnect-Medication-1Definition of a Medication
... id S0..1idLogical id of this artifact
... meta
.... versionId S0..1idVersion specific identifier
.... lastUpdated S0..1instantMANDATORY except in Contained Resources. When the resource version last changed.
.... profile S0..*uriProfiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
.... security 0..*CodingDISCOURAGED - may not be honoured by Data Consumers
.... Slices for tag 0..*CodingTags applied to this resource
Slice: Unordered, Open by value:system
..... tag:Source S0..1CodingMANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data
...... system 1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Source
...... code S1..1codeThe Data Provider Id of the system supplying the data
...... display S1..1stringName of the system supplying the data
..... tag:Provenance S0..1CodingMANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data
...... system 1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Provenance
...... code S1..1codeThe ODS Code of the organisation responsible for the data
...... display S1..1stringName of the organisation supplying the data
... implicitRules 0..1uriDISCOURAGED - may not be honoured by Data Consumers
... text 0..1NarrativeDISCOURAGED - 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..*ExtensionExtension
Slice: Unordered, Open by value:url
... R4Identifier 0..*IdentifierBusiness identifier for this resource.
URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-R4Identifier
... code S1..1CodeableConceptCodes that identify this medication
.... coding
..... system 1..1uriIdentity of the terminology system
..... code 1..1codeSymbol in syntax defined by the system
..... display 1..1stringRepresentation defined by the system
... status 0..0
... isBrand 0..0
... isOverTheCounter 0..0
... form S0..1CodeableConceptCodes that describe a medication dose form
... ingredient
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... strengthR4 0..1RatioQuantity of ingredient present.
URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-R4IngredientStrength
.... item[x] S1..1CodeableConcept, Reference(Substance | CareConnect-Medication-1)The product contained
.... amount 0..0
... package 0..0
... image 0..0

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..*CareConnect-Medication-1Definition of a Medication
... id SΣ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... versionId SΣ0..1idVersion specific identifier
.... lastUpdated SΣ0..1instantMANDATORY except in Contained Resources. When the resource version last changed.
.... profile SΣ0..*uriProfiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
.... security Σ0..*CodingDISCOURAGED - 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..*CodingTags 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..1CodingMANDATORY 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..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Source
...... code SΣ1..1codeThe Data Provider Id of the system supplying the data
...... display SΣ1..1stringName of the system supplying the data
..... tag:Provenance SΣ0..1CodingMANDATORY 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..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Provenance
...... code SΣ1..1codeThe ODS Code of the organisation responsible for the data
...... display SΣ1..1stringName of the organisation supplying the data
... implicitRules ?!Σ0..1uriDISCOURAGED - may not be honoured by Data Consumers
... text 0..1NarrativeDISCOURAGED - 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..*ExtensionExtension
Slice: Unordered, Open by value:url
... R4Identifier 0..*IdentifierBusiness identifier for this resource.
URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-R4Identifier
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... code SΣ1..1CodeableConceptCodes 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 S0..1CodeableConceptCodes 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..*BackboneElementActive or inactive ingredient
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... strengthR4 0..1RatioQuantity of ingredient present.
URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-R4IngredientStrength
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... item[x] S1..1The product contained
..... itemCodeableConceptCodeableConcept
..... itemReferenceReference(Substance | CareConnect-Medication-1)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Medication.meta.securityextensibleAll Security Labels
Medication.meta.tagexampleCommon Tags
Medication.meta.tag:SourceexampleCommon Tags
Medication.meta.tag:ProvenanceexampleCommon Tags
Medication.languageextensibleCommon Languages
Additional Bindings Purpose
AllLanguages Max Binding
Medication.coderequiredCare Connect Medication Code
Medication.formrequiredCare Connect Medication Form

Constraints

IdGradePath(s)DetailsRequirements
dom-1errorMedicationIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-2errorMedicationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationIf 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-4errorMedicationIf 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-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..*CareConnect-Medication-1Definition of a Medication
... id SΣ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... versionId SΣ0..1idVersion specific identifier
.... lastUpdated SΣ0..1instantMANDATORY except in Contained Resources. When the resource version last changed.
.... profile SΣ0..*uriProfiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
.... security Σ0..*CodingDISCOURAGED - 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..*CodingTags 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..1CodingMANDATORY 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..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Source
...... version Σ0..1stringVersion of the system - if relevant
...... code SΣ1..1codeThe Data Provider Id of the system supplying the data
...... display SΣ1..1stringName of the system supplying the data
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... tag:Provenance SΣ0..1CodingMANDATORY 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..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Provenance
...... version Σ0..1stringVersion of the system - if relevant
...... code SΣ1..1codeThe ODS Code of the organisation responsible for the data
...... display SΣ1..1stringName of the organisation supplying the data
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
... implicitRules ?!Σ0..1uriDISCOURAGED - may not be honoured by Data Consumers
... text 0..1NarrativeDISCOURAGED - 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..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... R4Identifier 0..*IdentifierBusiness identifier for this resource.
URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-R4Identifier
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... code SΣ1..1CodeableConceptCodes 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..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ0..*CodingCode defined by a terminology system
..... id 0..1stringxml:id (or equivalent in JSON)
..... Slices for extension 0..*ExtensionExtension
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..1uriIdentity of the terminology system
..... version Σ0..1stringVersion of the system - if relevant
..... code Σ1..1codeSymbol in syntax defined by the system
..... display Σ1..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... manufacturer Σ0..1Reference(CareConnect-Organization-1)Manufacturer of the item
... form S0..1CodeableConceptCodes 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..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ0..*CodingCode defined by a terminology system
..... id 0..1stringxml:id (or equivalent in JSON)
..... Slices for extension 0..*ExtensionExtension
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..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
..... version Σ0..1stringVersion of the system - if relevant
..... code Σ1..1codeSymbol in syntax defined by the system
..... display Σ1..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... ingredient 0..*BackboneElementActive or inactive ingredient
.... id 0..1stringxml:id (or equivalent in JSON)
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... strengthR4 0..1RatioQuantity of ingredient present.
URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-R4IngredientStrength
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... item[x] S1..1The product contained
..... itemCodeableConceptCodeableConcept
..... itemReferenceReference(Substance | CareConnect-Medication-1)
.... isActive 0..1booleanActive ingredient indicator

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Medication.meta.securityextensibleAll Security Labels
Medication.meta.tagexampleCommon Tags
Medication.meta.tag:SourceexampleCommon Tags
Medication.meta.tag:ProvenanceexampleCommon Tags
Medication.languageextensibleCommon Languages
Additional Bindings Purpose
AllLanguages Max Binding
Medication.coderequiredCare Connect Medication Code
Medication.formrequiredCare Connect Medication Form
Medication.package.containerexampleMedicationContainer

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1error**ALL** extensionsMust 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:

  • The element Medication.meta.tag is sliced based on the value of value:system

 

Other representations of profile: CSV, Excel, Schematron