lhssFHIRIG, published by IntelliSOFT Consulting Kenya. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/IntelliSOFT-Consulting/LHSS-FHIR-IG/ and changes regularly. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON
• TTL

Resource Profile: Medication Profile

A profile for documenting medications with translations and multiple coding systems.

Usage:

• This Resource Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

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

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

This structure is derived from Medication

Name	Flags	Card.	Type	Description & Constraints
Medication		0..*	Medication	Definition of a Medication
code	S	1..1	CodeableConcept	Codes that identify this medication
coding		1..*	Coding	Code defined by a terminology system
system	S	1..1	uri	Identity of the terminology system
code	S	1..1	code	Symbol in syntax defined by the system
display	S	1..1	string	Representation defined by the system
extension
extension
extension		..0
​ url	S
​ Slices for value[x]		1..		Slice: Unordered, Open by type:$this
​ value[x]:valueCode	S	1..1	code
​ value[x]:valueString	S	0..1	string
url	S	1..1	uri	identifies the meaning of the extension
value[x]		0..0
text	S	0..1	string	Plain text representation of the concept
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Medication		0..*	Medication	Definition of a Medication
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
code	SΣ	1..1	CodeableConcept	Codes that identify this medication Binding: SNOMEDCTMedicationCodes (example): A coded concept that defines the type of a medication.
coding	Σ	1..*	Coding	Code defined by a terminology system
system	SΣ	1..1	uri	Identity of the terminology system
code	SΣ	1..1	code	Symbol in syntax defined by the system
display	SΣ	1..1	string	Representation defined by the system
extension		0..*	Extension	Additional content defined by implementations
url	S	1..1	uri	identifies the meaning of the extension
text	SΣ	0..1	string	Plain text representation of the concept
status	?!Σ	0..1	code	active | inactive | entered-in-error Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Medication.code	example	SNOMEDCTMedicationCodes http://hl7.org/fhir/ValueSet/medication-codes from the FHIR Standard
Medication.status	required	Medication Status Codes http://hl7.org/fhir/ValueSet/medication-status|4.0.1 from the FHIR Standard

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..*	Medication	Definition of a Medication
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	Business identifier for this medication
code	SΣ	1..1	CodeableConcept	Codes that identify this medication Binding: SNOMEDCTMedicationCodes (example): A coded concept that defines the type of a 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
coding	Σ	1..*	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	SΣ	1..1	uri	Identity of the terminology system
version	Σ	0..1	string	Version of the system - if relevant
code	SΣ	1..1	code	Symbol in syntax defined by the system
display	SΣ	1..1	string	Representation defined by the system
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional content defined by implementations
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
url	S	1..1	uri	identifies the meaning of the extension
value		0..1	string	Primitive value for string Max Length: 1048576
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	SΣ	0..1	string	Plain text representation of the concept
status	?!Σ	0..1	code	active | inactive | entered-in-error Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use.
manufacturer	Σ	0..1	Reference(Organization)	Manufacturer of the item
form		0..1	CodeableConcept	powder | tablets | capsule + Binding: SNOMEDCTFormCodes (example): A coded concept defining the form of a medication.
amount	Σ	0..1	Ratio	Amount of drug in package
ingredient		0..*	BackboneElement	Active or inactive ingredient
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]		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.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Medication.code	example	SNOMEDCTMedicationCodes http://hl7.org/fhir/ValueSet/medication-codes from the FHIR Standard
Medication.status	required	Medication Status Codes http://hl7.org/fhir/ValueSet/medication-status|4.0.1 from the FHIR Standard
Medication.form	example	SNOMEDCTFormCodes http://hl7.org/fhir/ValueSet/medication-form-codes from the FHIR Standard

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 Medication

Summary

Mandatory: 5 elements(2 nested mandatory elements)
Must-Support: 9 elements
Prohibited: 2 elements

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Medication.code.coding.display.extension.extension.value[x]

Differential View

This structure is derived from Medication

Name	Flags	Card.	Type	Description & Constraints
Medication		0..*	Medication	Definition of a Medication
code	S	1..1	CodeableConcept	Codes that identify this medication
coding		1..*	Coding	Code defined by a terminology system
system	S	1..1	uri	Identity of the terminology system
code	S	1..1	code	Symbol in syntax defined by the system
display	S	1..1	string	Representation defined by the system
extension
extension
extension		..0
​ url	S
​ Slices for value[x]		1..		Slice: Unordered, Open by type:$this
​ value[x]:valueCode	S	1..1	code
​ value[x]:valueString	S	0..1	string
url	S	1..1	uri	identifies the meaning of the extension
value[x]		0..0
text	S	0..1	string	Plain text representation of the concept
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Medication		0..*	Medication	Definition of a Medication
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
code	SΣ	1..1	CodeableConcept	Codes that identify this medication Binding: SNOMEDCTMedicationCodes (example): A coded concept that defines the type of a medication.
coding	Σ	1..*	Coding	Code defined by a terminology system
system	SΣ	1..1	uri	Identity of the terminology system
code	SΣ	1..1	code	Symbol in syntax defined by the system
display	SΣ	1..1	string	Representation defined by the system
extension		0..*	Extension	Additional content defined by implementations
url	S	1..1	uri	identifies the meaning of the extension
text	SΣ	0..1	string	Plain text representation of the concept
status	?!Σ	0..1	code	active | inactive | entered-in-error Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Medication.code	example	SNOMEDCTMedicationCodes http://hl7.org/fhir/ValueSet/medication-codes from the FHIR Standard
Medication.status	required	Medication Status Codes http://hl7.org/fhir/ValueSet/medication-status|4.0.1 from the FHIR Standard

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..*	Medication	Definition of a Medication
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	Business identifier for this medication
code	SΣ	1..1	CodeableConcept	Codes that identify this medication Binding: SNOMEDCTMedicationCodes (example): A coded concept that defines the type of a 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
coding	Σ	1..*	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	SΣ	1..1	uri	Identity of the terminology system
version	Σ	0..1	string	Version of the system - if relevant
code	SΣ	1..1	code	Symbol in syntax defined by the system
display	SΣ	1..1	string	Representation defined by the system
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional content defined by implementations
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
url	S	1..1	uri	identifies the meaning of the extension
value		0..1	string	Primitive value for string Max Length: 1048576
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	SΣ	0..1	string	Plain text representation of the concept
status	?!Σ	0..1	code	active | inactive | entered-in-error Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use.
manufacturer	Σ	0..1	Reference(Organization)	Manufacturer of the item
form		0..1	CodeableConcept	powder | tablets | capsule + Binding: SNOMEDCTFormCodes (example): A coded concept defining the form of a medication.
amount	Σ	0..1	Ratio	Amount of drug in package
ingredient		0..*	BackboneElement	Active or inactive ingredient
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]		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.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Medication.code	example	SNOMEDCTMedicationCodes http://hl7.org/fhir/ValueSet/medication-codes from the FHIR Standard
Medication.status	required	Medication Status Codes http://hl7.org/fhir/ValueSet/medication-status|4.0.1 from the FHIR Standard
Medication.form	example	SNOMEDCTFormCodes http://hl7.org/fhir/ValueSet/medication-form-codes from the FHIR Standard

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 Medication

Summary

Mandatory: 5 elements(2 nested mandatory elements)
Must-Support: 9 elements
Prohibited: 2 elements

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Medication.code.coding.display.extension.extension.value[x]

Other representations of profile: CSV, Excel, Schematron