Status: DRAFT: For Review

Introduction

This profile sets out the expectations for the Interweave medication resource. We use the madication structure definition as a base to this profile.

The Medication resource allows for medications to be characterized by the form of the drug. 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 – Describes the form of the item. Powder; tablets; capsule. sThis 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.

• amount – Specific amount of the drug in the packaged product. For example, when specifying a product that has the same strength (For example, Insulin glargine 100 unit per mL solution for injection), this attribute provides additional clarification of the package amount (For example, 3 mL, 10mL, etc.)

• batch – Information that only applies to packages (not products), such as assigned lot number or when this specific batch of product will expire.

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.

• The following fields have been removed to keep the medication model clear:

• status

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from UKCoreMedication

Name	Flags	Card.	Type	Description & Constraints
Medication		0..*	UKCoreMedication	Definition of a Medication
id	S	0..1	id	Logical id of this artifact
meta
id		0..0
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..*	canonical(StructureDefinition)	Profiles this resource claims to conform to. Should list (i) this profile (ii) base profile for this resource.
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
id		0..0
system		1..1	uri	Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Source
version		0..0
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
id		0..0
system		1..1	uri	Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Provenance
version		0..0
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
identifier
assigner		0..1	Reference(InterweaveOrganization)	Organization that issued id (may be just text)
code		1..1	CodeableConcept	Codes that identify this medication Binding: UK Core Medication Code (required)
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
manufacturer		0..1	Reference(InterweaveOrganization)	Manufacturer of the item
reference		1..1	string	Reference to a resource (could be Contained)
identifier		0..1	Identifier	If relevant could include an id
display		1..1	string	Description of the referenced resource
form	S	0..1	CodeableConcept	powder | tablets | capsule + Binding: UK Core Medication Form (required)
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
ingredient		0..*	BackboneElement	DISCOURAGED - Identifies a particular constituent of interest in the product.
item[x]	S	1..1	CodeableConcept, Reference(Substance | Medication)	The actual ingredient or content
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Medication.code	required	UKCoreMedicationCode https://fhir.hl7.org.uk/ValueSet/UKCore-MedicationCode from this IG
Medication.form	required	UKCoreMedicationForm https://fhir.hl7.org.uk/ValueSet/UKCore-MedicationForm from this IG

Name	Flags	Card.	Type	Description & Constraints
Medication		0..*	UKCoreMedication	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..*	canonical(StructureDefinition)	Profiles this resource claims to conform to. Should list (i) this profile (ii) base profile for this resource.
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: CommonTags (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: CommonTags (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://fhir.interweavedigital.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: CommonTags (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://fhir.interweavedigital.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: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
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				Content/Rules for all slices
MedicationTradeFamily		0..1	CodeableConcept	Used to identify a Trade Family or brand associated with a Medication, specifically when the medication is defined using a dm+d Virtual Therapeutic Moiety (VTM) concept URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MedicationTradeFamily Binding: UK Core Medication Trade Family (preferred)
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
code	SΣ	1..1	CodeableConcept	Codes that identify this medication Binding: UK Core Medication Code (required)
manufacturer	Σ	0..1	Reference(InterweaveOrganization)	Manufacturer of the item
reference	ΣC	1..1	string	Reference to a resource (could be Contained)
identifier	Σ	0..1	Identifier	If relevant could include an id
display	Σ	1..1	string	Description of the referenced resource
form	S	0..1	CodeableConcept	powder | tablets | capsule + Binding: UK Core Medication Form (required)
ingredient		0..*	BackboneElement	DISCOURAGED - Identifies a particular constituent of interest in the product.
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
item[x]	S	1..1		The actual ingredient or content
itemCodeableConcept			CodeableConcept
itemReference			Reference(Substance | Medication)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Medication.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
Medication.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
Medication.meta.tag:Source	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
Medication.meta.tag:Provenance	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
Medication.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Medication.code	required	UKCoreMedicationCode https://fhir.hl7.org.uk/ValueSet/UKCore-MedicationCode from this IG
Medication.form	required	UKCoreMedicationForm https://fhir.hl7.org.uk/ValueSet/UKCore-MedicationForm from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
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 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	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()
dom-5	error	Medication	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Medication	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (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..*	UKCoreMedication	Definition of a Medication
id	SΣ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
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.
source	Σ	0..1	uri	Identifies where the resource comes from
profile	SΣ	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to. Should list (i) this profile (ii) base profile for this resource.
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: CommonTags (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: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
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://fhir.interweavedigital.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
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: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
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://fhir.interweavedigital.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
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: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
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
MedicationTradeFamily		0..1	CodeableConcept	Used to identify a Trade Family or brand associated with a Medication, specifically when the medication is defined using a dm+d Virtual Therapeutic Moiety (VTM) concept URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MedicationTradeFamily Binding: UK Core Medication Trade Family (preferred)
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	Business identifier for this medication
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	0..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(InterweaveOrganization)	Organization that issued id (may be just text)
code	SΣ	1..1	CodeableConcept	Codes that identify this medication Binding: UK Core Medication Code (required)
id		0..1	string	Unique id for inter-element referencing
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	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
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(InterweaveOrganization)	Manufacturer of the item
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	1..1	string	Reference to a resource (could be Contained)
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	Σ	0..1	Identifier	If relevant could include an id
display	Σ	1..1	string	Description of the referenced resource
form	S	0..1	CodeableConcept	powder | tablets | capsule + Binding: UK Core Medication Form (required)
id		0..1	string	Unique id for inter-element referencing
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	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
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
amount	Σ	0..1	Ratio	Amount of drug in package
ingredient		0..*	BackboneElement	DISCOURAGED - Identifies a particular constituent of interest in the product.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
item[x]	S	1..1		The actual ingredient or content
itemCodeableConcept			CodeableConcept
itemReference			Reference(Substance | Medication)
isActive		0..1	boolean	Active ingredient indicator
strength		0..1	Ratio	Quantity of ingredient present
batch		0..1	BackboneElement	Details about packaged medications
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
lotNumber		0..1	string	Identifier assigned to batch
expirationDate		0..1	dateTime	When batch will expire
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Medication.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
Medication.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
Medication.meta.tag:Source	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
Medication.meta.tag:Provenance	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
Medication.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Medication.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Medication.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Medication.code	required	UKCoreMedicationCode https://fhir.hl7.org.uk/ValueSet/UKCore-MedicationCode from this IG
Medication.manufacturer.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
Medication.form	required	UKCoreMedicationForm https://fhir.hl7.org.uk/ValueSet/UKCore-MedicationForm from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
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 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	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()
dom-5	error	Medication	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Medication	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Differential View

This structure is derived from UKCoreMedication

Name	Flags	Card.	Type	Description & Constraints
Medication		0..*	UKCoreMedication	Definition of a Medication
id	S	0..1	id	Logical id of this artifact
meta
id		0..0
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..*	canonical(StructureDefinition)	Profiles this resource claims to conform to. Should list (i) this profile (ii) base profile for this resource.
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
id		0..0
system		1..1	uri	Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Source
version		0..0
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
id		0..0
system		1..1	uri	Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Provenance
version		0..0
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
identifier
assigner		0..1	Reference(InterweaveOrganization)	Organization that issued id (may be just text)
code		1..1	CodeableConcept	Codes that identify this medication Binding: UK Core Medication Code (required)
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
manufacturer		0..1	Reference(InterweaveOrganization)	Manufacturer of the item
reference		1..1	string	Reference to a resource (could be Contained)
identifier		0..1	Identifier	If relevant could include an id
display		1..1	string	Description of the referenced resource
form	S	0..1	CodeableConcept	powder | tablets | capsule + Binding: UK Core Medication Form (required)
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
ingredient		0..*	BackboneElement	DISCOURAGED - Identifies a particular constituent of interest in the product.
item[x]	S	1..1	CodeableConcept, Reference(Substance | Medication)	The actual ingredient or content
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Medication.code	required	UKCoreMedicationCode https://fhir.hl7.org.uk/ValueSet/UKCore-MedicationCode from this IG
Medication.form	required	UKCoreMedicationForm https://fhir.hl7.org.uk/ValueSet/UKCore-MedicationForm from this IG

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Medication		0..*	UKCoreMedication	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..*	canonical(StructureDefinition)	Profiles this resource claims to conform to. Should list (i) this profile (ii) base profile for this resource.
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: CommonTags (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: CommonTags (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://fhir.interweavedigital.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: CommonTags (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://fhir.interweavedigital.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: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
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				Content/Rules for all slices
MedicationTradeFamily		0..1	CodeableConcept	Used to identify a Trade Family or brand associated with a Medication, specifically when the medication is defined using a dm+d Virtual Therapeutic Moiety (VTM) concept URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MedicationTradeFamily Binding: UK Core Medication Trade Family (preferred)
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
code	SΣ	1..1	CodeableConcept	Codes that identify this medication Binding: UK Core Medication Code (required)
manufacturer	Σ	0..1	Reference(InterweaveOrganization)	Manufacturer of the item
reference	ΣC	1..1	string	Reference to a resource (could be Contained)
identifier	Σ	0..1	Identifier	If relevant could include an id
display	Σ	1..1	string	Description of the referenced resource
form	S	0..1	CodeableConcept	powder | tablets | capsule + Binding: UK Core Medication Form (required)
ingredient		0..*	BackboneElement	DISCOURAGED - Identifies a particular constituent of interest in the product.
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
item[x]	S	1..1		The actual ingredient or content
itemCodeableConcept			CodeableConcept
itemReference			Reference(Substance | Medication)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Medication.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
Medication.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
Medication.meta.tag:Source	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
Medication.meta.tag:Provenance	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
Medication.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Medication.code	required	UKCoreMedicationCode https://fhir.hl7.org.uk/ValueSet/UKCore-MedicationCode from this IG
Medication.form	required	UKCoreMedicationForm https://fhir.hl7.org.uk/ValueSet/UKCore-MedicationForm from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
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 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	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()
dom-5	error	Medication	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Medication	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (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..*	UKCoreMedication	Definition of a Medication
id	SΣ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
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.
source	Σ	0..1	uri	Identifies where the resource comes from
profile	SΣ	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to. Should list (i) this profile (ii) base profile for this resource.
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: CommonTags (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: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
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://fhir.interweavedigital.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
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: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
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://fhir.interweavedigital.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
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: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
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
MedicationTradeFamily		0..1	CodeableConcept	Used to identify a Trade Family or brand associated with a Medication, specifically when the medication is defined using a dm+d Virtual Therapeutic Moiety (VTM) concept URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MedicationTradeFamily Binding: UK Core Medication Trade Family (preferred)
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	Business identifier for this medication
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	0..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(InterweaveOrganization)	Organization that issued id (may be just text)
code	SΣ	1..1	CodeableConcept	Codes that identify this medication Binding: UK Core Medication Code (required)
id		0..1	string	Unique id for inter-element referencing
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	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
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(InterweaveOrganization)	Manufacturer of the item
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	1..1	string	Reference to a resource (could be Contained)
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	Σ	0..1	Identifier	If relevant could include an id
display	Σ	1..1	string	Description of the referenced resource
form	S	0..1	CodeableConcept	powder | tablets | capsule + Binding: UK Core Medication Form (required)
id		0..1	string	Unique id for inter-element referencing
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	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
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
amount	Σ	0..1	Ratio	Amount of drug in package
ingredient		0..*	BackboneElement	DISCOURAGED - Identifies a particular constituent of interest in the product.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
item[x]	S	1..1		The actual ingredient or content
itemCodeableConcept			CodeableConcept
itemReference			Reference(Substance | Medication)
isActive		0..1	boolean	Active ingredient indicator
strength		0..1	Ratio	Quantity of ingredient present
batch		0..1	BackboneElement	Details about packaged medications
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
lotNumber		0..1	string	Identifier assigned to batch
expirationDate		0..1	dateTime	When batch will expire
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Medication.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
Medication.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
Medication.meta.tag:Source	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
Medication.meta.tag:Provenance	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
Medication.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Medication.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Medication.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Medication.code	required	UKCoreMedicationCode https://fhir.hl7.org.uk/ValueSet/UKCore-MedicationCode from this IG
Medication.manufacturer.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
Medication.form	required	UKCoreMedicationForm https://fhir.hl7.org.uk/ValueSet/UKCore-MedicationForm from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
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 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	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()
dom-5	error	Medication	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Medication	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (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 UKCoreMedication

Summary

Mandatory: 0 element(14 nested mandatory elements)
Must-Support: 12 elements
Fixed: 2 elements
Prohibited: 6 elements

Structures

This structure refers to these other structures:

• InterweaveOrganization (https://fhir.interweavedigital.nhs.uk/R4/StructureDefinition/Interweave-Organization)

Slices

This structure defines the following Slices:

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