International Patient Summary 1.0.0 Release
1.0 - CI Build

International Patient Summary 1.0.0 Release - Local Development build (v1.0). See the Directory of published versions

Resource Profile: IPSMedicationStatement - Detailed Descriptions

Draft as of 2021-09-02

Definitions for the 2.16.840.1.113883.10.22.4.4--20210902121754 resource profile.

Guidance on how to interpret the contents of this table can be found here.

1. SubstanceAdministration
Control1..*1
Must Supporttrue
XML RepresentationIn the XML format, this property has the namespace urn:hl7-org:v3.
2. SubstanceAdministration.nullFlavor
Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
3. SubstanceAdministration.low
Control1..1
Must Supporttrue
4. SubstanceAdministration.high
Control0..1
Must Supporttrue
5. SubstanceAdministration.low
Control0..0
6. SubstanceAdministration.width
Control1..1
Must Supporttrue
7. SubstanceAdministration.width.unit
Control1..1
BindingThe codes SHALL be taken from Medication Time Units (UCUM.html) Medication Time Units (UCUM.html
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
8. SubstanceAdministration.classCode
XML RepresentationIn the XML format, this property is represented as an attribute.
9. SubstanceAdministration.moodCode
Definition

If the statement refers to a prescribed medication then a intent (moodCode='INT'.html) is used; otherwise, to record medications which are stated to have taken, the moodCode shall be set to 'EVN'.

BindingThe codes SHALL be taken from MoodCodeEvnIntFor codes, see (unbound) MoodCodeEvnIn
XML RepresentationIn the XML format, this property is represented as an attribute.
10. SubstanceAdministration.templateId
SlicingThis element introduces a set of slices on SubstanceAdministration.templateId. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ root
  • value @ root,
11. SubstanceAdministration.templateId:primary
SliceNameprimary
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Must Supporttrue
12. SubstanceAdministration.templateId:primary.root
Control1..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed Value2.16.840.1.113883.10.22.4.4
13. SubstanceAdministration.id
Must Supporttrue
14. SubstanceAdministration.code
Definition

The <code> element is valorized with the Substance Administration ACT code "DRUG" unless it is used for asserting the  known absence of medication treatments or no information about them.

Control10..1
BindingThe codes SHALL be taken from Absent or Unknown MedicationThe codes SHALL be taken from ActSubstanceAdministrationCode; other codes may be used where these codes are not suitable Absent or Unknown Medicatio
Must Supporttrue
15. SubstanceAdministration.text
Definition

The URI given in the value attribute of the <reference> element points to an element in the narrative content that contains the complete text describing the medication.

In a CDA document, the URI given in the value attribute of the <reference> element points to an element in the narrative content that contains the complete text describing the medication.

Must Supporttrue
16. SubstanceAdministration.text.reference
Control1..1
Must Supporttrue
17. SubstanceAdministration.text.reference.value
Definition

Reference pointing to the narrative, typically #{label}-{generated-id}, e.g. #xxx-1

Control1..1
Typeuri
XML RepresentationIn the XML format, this property is represented as an attribute.
18. SubstanceAdministration.statusCode
Control10..1
BindingThe codes SHALL be taken from ActStatusActiveCompletedAbortedSuspendedThe codes SHALL be taken from ActStatus ActStatusActiveCompletedAbortedSuspende
Must Supporttrue
19. SubstanceAdministration.routeCode
Definition

The <routeCode> element specifies the route of administration using the EDQM route of administration vocabulary.

A code must be specified if the route is known. 

Since the EDQM Standards Terms, together with UCUM, is one of the IDMP terminologies actually available for usage, this code system has been selected  as referecne terminology for representing Pharmaceutical Dose forms; Packages and Route of Administration.

It is known that also alternative jurisdictional and international terminologies are also used for this concept domain, as NCI or SNOMED CT.

Official NCI and EDQM maps for the route of administration are available from the EDQM site.

BindingThe codes SHALL be taken from Medicine Route of AdministrationThe codes SHALL be taken from RouteOfAdministration; other codes may be used where these codes are not suitable Medicine Route of Administratio
Must Supporttrue
20. SubstanceAdministration.doseQuantity
Control0..01
21. SubstanceAdministration.rateQuantity
Control0..01
22. SubstanceAdministration.administrationUnitCode
Control0..01
23. SubstanceAdministration.consumable
Must Supporttrue
24. SubstanceAdministration.consumable.typeCode
XML RepresentationIn the XML format, this property is represented as an attribute.
25. SubstanceAdministration.author
26. SubstanceAdministration.entryRelationship
SlicingThis element introduces a set of slices on SubstanceAdministration.entryRelationship. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ profile
27. SubstanceAdministration.entryRelationship:entryRelationship-1
SliceNameentryRelationship-1
Definition

Subordinate Substance Administration Statement as a component of the overall medication statement.

Unless medications are unknown or known absent, at least one subordinated <substanceAdministration> has to be present to convey information about dosages (dose, frequency of intakes,...html).

Subordinated <substanceAdministration> elements can be also used either to handle split dosing, or to support combination medications.At least one subordinate  element SHALL be present unless medications are unknown or known absent.

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration(UVSubordinateadministration)
InvariantsDefined on this element
entryRelationship-1: contains UV Subordinate Substance Administration 2.16.840.1.113883.10.21.4.6 (2017-04-30.html) (: null)
28. SubstanceAdministration.entryRelationship:entryRelationship-1.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueCOMP

Guidance on how to interpret the contents of this table can be found here.

1. SubstanceAdministration
Definition

Base definition for all types defined in FHIR type system.

Control0..*
Must Supporttrue
XML RepresentationIn the XML format, this property has the namespace urn:hl7-org:v3.
2. SubstanceAdministration.classCode
Control1..1
BindingThe codes SHALL be taken from ActClass
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueSBADM
Fixed ValueSBADM
3. SubstanceAdministration.moodCode
Definition

If the statement refers to a prescribed medication then a intent (moodCode='INT'.html) is used; otherwise, to record medications which are stated to have taken, the moodCode shall be set to 'EVN'.

Control1..1
BindingThe codes SHALL be taken from MoodCodeEvnInt MoodCodeEvnIn
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
4. SubstanceAdministration.templateId
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
SlicingThis element introduces a set of slices on SubstanceAdministration.templateId. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ root
  • value @ root,
5. SubstanceAdministration.templateId:primary
SliceNameprimary
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Must Supporttrue
6. SubstanceAdministration.templateId:primary.root
Definition

A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.

Control1..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed Value2.16.840.1.113883.10.22.4.4
7. SubstanceAdministration.id
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Must Supporttrue
8. SubstanceAdministration.code
Definition

The <code> element is valorized with the Substance Administration ACT code "DRUG" unless it is used for asserting the  known absence of medication treatments or no information about them.

Control1..1
BindingThe codes SHALL be taken from Absent or Unknown Medication Absent or Unknown Medicatio
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
Must Supporttrue
9. SubstanceAdministration.text
Definition

The URI given in the value attribute of the <reference> element points to an element in the narrative content that contains the complete text describing the medication.

In a CDA document, the URI given in the value attribute of the <reference> element points to an element in the narrative content that contains the complete text describing the medication.

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
Must Supporttrue
10. SubstanceAdministration.text.reference
Definition

A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data.

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
Must Supporttrue
11. SubstanceAdministration.text.reference.value
Definition

Reference pointing to the narrative, typically #{label}-{generated-id}, e.g. #xxx-1

Control1..1
Typeuri
XML RepresentationIn the XML format, this property is represented as an attribute.
12. SubstanceAdministration.statusCode
Control1..1
BindingThe codes SHALL be taken from ActStatusActiveCompletedAbortedSuspended ActStatusActiveCompletedAbortedSuspende
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
Must Supporttrue
13. SubstanceAdministration.routeCode
Definition

The <routeCode> element specifies the route of administration using the EDQM route of administration vocabulary.

A code must be specified if the route is known. 

Since the EDQM Standards Terms, together with UCUM, is one of the IDMP terminologies actually available for usage, this code system has been selected  as referecne terminology for representing Pharmaceutical Dose forms; Packages and Route of Administration.

It is known that also alternative jurisdictional and international terminologies are also used for this concept domain, as NCI or SNOMED CT.

Official NCI and EDQM maps for the route of administration are available from the EDQM site.

Control0..1
BindingThe codes SHALL be taken from Medicine Route of Administration Medicine Route of Administratio
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
Must Supporttrue
14. SubstanceAdministration.doseQuantity
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-PQ
15. SubstanceAdministration.rateQuantity
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-PQ
16. SubstanceAdministration.administrationUnitCode
Control0..0
BindingThe codes SHALL be taken from AdministrableDrugForm; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
17. SubstanceAdministration.consumable
Control1..1
TypeElement
Must Supporttrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
18. SubstanceAdministration.consumable.typeCode
Control1..1
BindingThe codes SHALL be taken from ParticipationTargetDirect
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueCSM
Fixed ValueCSM
19. SubstanceAdministration.consumable.manufacturedProduct
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ManufacturedProduct
20. SubstanceAdministration.author
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Author
21. SubstanceAdministration.entryRelationship
Control0..*
TypeElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
subst-er-1: Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act (: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1)
SlicingThis element introduces a set of slices on SubstanceAdministration.entryRelationship. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ profile
22. SubstanceAdministration.entryRelationship.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
23. SubstanceAdministration.entryRelationship.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
24. SubstanceAdministration.entryRelationship:entryRelationship-1
SliceNameentryRelationship-1
Definition

Subordinate Substance Administration Statement as a component of the overall medication statement.

Unless medications are unknown or known absent, at least one subordinated <substanceAdministration> has to be present to convey information about dosages (dose, frequency of intakes,...html).

Subordinated <substanceAdministration> elements can be also used either to handle split dosing, or to support combination medications.At least one subordinate  element SHALL be present unless medications are unknown or known absent.

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration(UVSubordinateadministration)
Must Supporttrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
entryRelationship-1: contains UV Subordinate Substance Administration 2.16.840.1.113883.10.21.4.6 (2017-04-30.html) (: null)
subst-er-1: Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act (: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1)
25. SubstanceAdministration.entryRelationship:entryRelationship-1.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueCOMP
26. SubstanceAdministration.entryRelationship:entryRelationship-1.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue

Guidance on how to interpret the contents of this table can be found here.

1. SubstanceAdministration
Definition

Base definition for all types defined in FHIR type system.

Control0..*
Must Supporttrue
XML RepresentationIn the XML format, this property has the namespace urn:hl7-org:v3.
2. SubstanceAdministration.classCode
Control1..1
BindingThe codes SHALL be taken from ActClass
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueSBADM
Fixed ValueSBADM
3. SubstanceAdministration.moodCode
Definition

If the statement refers to a prescribed medication then a intent (moodCode='INT'.html) is used; otherwise, to record medications which are stated to have taken, the moodCode shall be set to 'EVN'.

Control1..1
BindingThe codes SHALL be taken from MoodCodeEvnInt MoodCodeEvnIn
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
4. SubstanceAdministration.realmCode
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
5. SubstanceAdministration.typeId
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
6. SubstanceAdministration.templateId
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
SlicingThis element introduces a set of slices on SubstanceAdministration.templateId. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ root
  • value @ root,
7. SubstanceAdministration.templateId:primary
SliceNameprimary
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Must Supporttrue
8. SubstanceAdministration.templateId:primary.nullFlavor
Definition

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
9. SubstanceAdministration.templateId:primary.assigningAuthorityName
Definition

A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
10. SubstanceAdministration.templateId:primary.displayable
Definition

Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).

Control0..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
11. SubstanceAdministration.templateId:primary.root
Definition

A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.

Control1..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed Value2.16.840.1.113883.10.22.4.4
12. SubstanceAdministration.templateId:primary.extension
Definition

A character string as a unique identifier within the scope of the identifier root.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
13. SubstanceAdministration.id
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Must Supporttrue
14. SubstanceAdministration.code
Definition

The <code> element is valorized with the Substance Administration ACT code "DRUG" unless it is used for asserting the  known absence of medication treatments or no information about them.

Control1..1
BindingThe codes SHALL be taken from Absent or Unknown Medication Absent or Unknown Medicatio
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
Must Supporttrue
15. SubstanceAdministration.negationInd
Control0..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
16. SubstanceAdministration.text
Definition

The URI given in the value attribute of the <reference> element points to an element in the narrative content that contains the complete text describing the medication.

In a CDA document, the URI given in the value attribute of the <reference> element points to an element in the narrative content that contains the complete text describing the medication.

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
Must Supporttrue
17. SubstanceAdministration.text.nullFlavor
Definition

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
18. SubstanceAdministration.text.charset
Definition

For character-based encoding types, this property specifies the character set and character encoding used. The charset shall be identified by an Internet Assigned Numbers Authority (IANA) Charset Registration [] in accordance with RFC 2978 [].

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
19. SubstanceAdministration.text.compression
Definition

Indicates whether the raw byte data is compressed, and what compression algorithm was used.

Control0..1
BindingThe codes SHALL be taken from CompressionAlgorithm
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
20. SubstanceAdministration.text.integrityCheck
Definition

The integrity check is a short binary value representing a cryptographically strong checksum that is calculated over the binary data. The purpose of this property, when communicated with a reference is for anyone to validate later whether the reference still resolved to the same data that the reference resolved to when the encapsulated data value with reference was created.

Control0..1
Typebase64Binary
XML RepresentationIn the XML format, this property is represented as an attribute.
21. SubstanceAdministration.text.integrityCheckAlgorithm
Definition

Specifies the algorithm used to compute the integrityCheck value. The cryptographically strong checksum algorithm Secure Hash Algorithm-1 (SHA-1) is currently the industry standard. It has superseded the MD5 algorithm only a couple of years ago, when certain flaws in the security of MD5 were discovered. Currently the SHA-1 hash algorithm is the default choice for the integrity check algorithm. Note that SHA-256 is also entering widespread usage.

Control0..1
BindingThe codes SHALL be taken from IntegrityCheckAlgorithm
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
22. SubstanceAdministration.text.language
Definition

For character based information the language property specifies the human language of the text.

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
23. SubstanceAdministration.text.mediaType
Definition

Identifies the type of the encapsulated data and identifies a method to interpret or render the data.

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
24. SubstanceAdministration.text.representation
Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
25. SubstanceAdministration.text.data[x]
Definition

Data that is primarily intended for human interpretation or for further machine processing is outside the scope of HL7. This includes unformatted or formatted written language, multimedia data, or structured information as defined by a different standard (e.g., XML-signatures.)

Control0..1
TypeChoice of: string, base64Binary
[x] NoteSee Choice of Data Types for further information about how to use [x]
XML RepresentationIn the XML format, this property is represented as unadorned text.
26. SubstanceAdministration.text.reference
Definition

A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data.

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
Must Supporttrue
27. SubstanceAdministration.text.reference.nullFlavor
Definition

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
28. SubstanceAdministration.text.reference.value
Definition

Reference pointing to the narrative, typically #{label}-{generated-id}, e.g. #xxx-1

Control1..1
Typeuri
XML RepresentationIn the XML format, this property is represented as an attribute.
29. SubstanceAdministration.text.reference.useablePeriod
Definition

Specifies the periods of time during which the telecommunication address can be used. For a telephone number, this can indicate the time of day in which the party can be reached on that telephone. For a web address, it may specify a time range in which the web content is promised to be available under the given address.

Control0..*
TypeChoice of: http://hl7.org/fhir/cda/StructureDefinition/IVL-TS, http://hl7.org/fhir/cda/StructureDefinition/EIVL-TS, http://hl7.org/fhir/cda/StructureDefinition/PIVL-TS, http://hl7.org/fhir/cda/StructureDefinition/SXPR-TS
Default Typehttp://hl7.org/fhir/cda/StructureDefinition/SXPR-TS
XML RepresentationThe type of this property is determined using the xsi:type attribute.
30. SubstanceAdministration.text.reference.use
Definition

One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need.

Control0..*
BindingThe codes SHALL be taken from AddressUse
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
31. SubstanceAdministration.text.thumbnail
Definition

An abbreviated rendition of the full data. A thumbnail requires significantly fewer resources than the full data, while still maintaining some distinctive similarity with the full data. A thumbnail is typically used with by-reference encapsulated data. It allows a user to select data more efficiently before actually downloading through the reference.

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
32. SubstanceAdministration.statusCode
Control1..1
BindingThe codes SHALL be taken from ActStatusActiveCompletedAbortedSuspended ActStatusActiveCompletedAbortedSuspende
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
Must Supporttrue
33. SubstanceAdministration.effectiveTime
Control0..*
TypeChoice of: http://hl7.org/fhir/cda/StructureDefinition/SXCM-TS, http://hl7.org/fhir/cda/StructureDefinition/IVL-TS, http://hl7.org/fhir/cda/StructureDefinition/EIVL-TS, http://hl7.org/fhir/cda/StructureDefinition/PIVL-TS, http://hl7.org/fhir/cda/StructureDefinition/SXPR-TS
Default Typehttp://hl7.org/fhir/cda/StructureDefinition/SXCM-TS
XML RepresentationThe type of this property is determined using the xsi:type attribute.
34. SubstanceAdministration.priorityCode
Control0..1
BindingThe codes SHALL be taken from ActPriority; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
35. SubstanceAdministration.repeatNumber
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-INT
36. SubstanceAdministration.routeCode
Definition

The <routeCode> element specifies the route of administration using the EDQM route of administration vocabulary.

A code must be specified if the route is known. 

Since the EDQM Standards Terms, together with UCUM, is one of the IDMP terminologies actually available for usage, this code system has been selected  as referecne terminology for representing Pharmaceutical Dose forms; Packages and Route of Administration.

It is known that also alternative jurisdictional and international terminologies are also used for this concept domain, as NCI or SNOMED CT.

Official NCI and EDQM maps for the route of administration are available from the EDQM site.

Control0..1
BindingThe codes SHALL be taken from Medicine Route of Administration Medicine Route of Administratio
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
Must Supporttrue
37. SubstanceAdministration.approachSiteCode
Control0..*
BindingThe codes SHALL be taken from http://terminology.hl7.org/ValueSet/v3-ActSite; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
38. SubstanceAdministration.doseQuantity
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-PQ
39. SubstanceAdministration.rateQuantity
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-PQ
40. SubstanceAdministration.maxDoseQuantity
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/RTO-PQ-PQ
41. SubstanceAdministration.administrationUnitCode
Control0..0
BindingThe codes SHALL be taken from AdministrableDrugForm; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
42. SubstanceAdministration.consumable
Control1..1
TypeElement
Must Supporttrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
43. SubstanceAdministration.consumable.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typeid
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
44. SubstanceAdministration.consumable.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on SubstanceAdministration.consumable.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
45. SubstanceAdministration.consumable.typeCode
Control1..1
BindingThe codes SHALL be taken from ParticipationTargetDirect
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueCSM
Fixed ValueCSM
46. SubstanceAdministration.consumable.manufacturedProduct
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ManufacturedProduct
47. SubstanceAdministration.subject
Control0..1
TypeElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
48. SubstanceAdministration.subject.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typeid
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
49. SubstanceAdministration.subject.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on SubstanceAdministration.subject.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
50. SubstanceAdministration.subject.typeCode
Control1..1
BindingThe codes SHALL be taken from ParticipationTargetSubject
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueSBJ
Fixed ValueSBJ
51. SubstanceAdministration.subject.contextControlCode
Control1..1
BindingThe codes SHALL be taken from ContextControl
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueOP
Fixed ValueOP
52. SubstanceAdministration.subject.awarenessCode
Control0..1
BindingThe codes SHALL be taken from TargetAwareness; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
53. SubstanceAdministration.subject.relatedSubject
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/RelatedSubject
54. SubstanceAdministration.specimen
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Specimen
55. SubstanceAdministration.performer
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Performer2
56. SubstanceAdministration.author
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Author
57. SubstanceAdministration.informant
Control0..*
TypeElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
58. SubstanceAdministration.informant.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typeid
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
59. SubstanceAdministration.informant.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on SubstanceAdministration.informant.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
60. SubstanceAdministration.informant.typeCode
Control1..1
BindingThe codes SHALL be taken from ParticipationInformationGenerator
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueINF
Fixed ValueINF
61. SubstanceAdministration.informant.contextControlCode
Control1..1
BindingThe codes SHALL be taken from ContextControl
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueOP
Fixed ValueOP
62. SubstanceAdministration.informant.assignedEntity
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/AssignedEntity
63. SubstanceAdministration.informant.relatedEntity
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/RelatedEntity
64. SubstanceAdministration.participant
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Participant2
65. SubstanceAdministration.entryRelationship
Control0..*
TypeElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
subst-er-1: Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act (: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1)
SlicingThis element introduces a set of slices on SubstanceAdministration.entryRelationship. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ profile
66. SubstanceAdministration.entryRelationship.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typeid
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
67. SubstanceAdministration.entryRelationship.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on SubstanceAdministration.entryRelationship.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
68. SubstanceAdministration.entryRelationship.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
69. SubstanceAdministration.entryRelationship.inversionInd
Control0..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
70. SubstanceAdministration.entryRelationship.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
71. SubstanceAdministration.entryRelationship.sequenceNumber
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/INT
72. SubstanceAdministration.entryRelationship.negationInd
Control0..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
73. SubstanceAdministration.entryRelationship.seperatableInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
74. SubstanceAdministration.entryRelationship.observation
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Observation
75. SubstanceAdministration.entryRelationship.regionOfInterest
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest
76. SubstanceAdministration.entryRelationship.observationMedia
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ObservationMedia
77. SubstanceAdministration.entryRelationship.substanceAdministration
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration
78. SubstanceAdministration.entryRelationship.supply
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Supply
79. SubstanceAdministration.entryRelationship.procedure
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Procedure
80. SubstanceAdministration.entryRelationship.encounter
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Encounter
81. SubstanceAdministration.entryRelationship.organizer
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organizer
82. SubstanceAdministration.entryRelationship.act
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Act
83. SubstanceAdministration.entryRelationship:entryRelationship-1
SliceNameentryRelationship-1
Definition

Subordinate Substance Administration Statement as a component of the overall medication statement.

Unless medications are unknown or known absent, at least one subordinated <substanceAdministration> has to be present to convey information about dosages (dose, frequency of intakes,...html).

Subordinated <substanceAdministration> elements can be also used either to handle split dosing, or to support combination medications.At least one subordinate  element SHALL be present unless medications are unknown or known absent.

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration(UVSubordinateadministration)
Must Supporttrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
entryRelationship-1: contains UV Subordinate Substance Administration 2.16.840.1.113883.10.21.4.6 (2017-04-30.html) (: )
subst-er-1: Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act (: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1)
84. SubstanceAdministration.entryRelationship:entryRelationship-1.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typeid
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
85. SubstanceAdministration.entryRelationship:entryRelationship-1.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on SubstanceAdministration.entryRelationship.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
86. SubstanceAdministration.entryRelationship:entryRelationship-1.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueCOMP
87. SubstanceAdministration.entryRelationship:entryRelationship-1.inversionInd
Control0..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
88. SubstanceAdministration.entryRelationship:entryRelationship-1.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
89. SubstanceAdministration.entryRelationship:entryRelationship-1.sequenceNumber
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/INT
90. SubstanceAdministration.entryRelationship:entryRelationship-1.negationInd
Control0..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
91. SubstanceAdministration.entryRelationship:entryRelationship-1.seperatableInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
92. SubstanceAdministration.entryRelationship:entryRelationship-1.observation
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Observation
93. SubstanceAdministration.entryRelationship:entryRelationship-1.regionOfInterest
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest
94. SubstanceAdministration.entryRelationship:entryRelationship-1.observationMedia
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ObservationMedia
95. SubstanceAdministration.entryRelationship:entryRelationship-1.substanceAdministration
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration
96. SubstanceAdministration.entryRelationship:entryRelationship-1.supply
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Supply
97. SubstanceAdministration.entryRelationship:entryRelationship-1.procedure
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Procedure
98. SubstanceAdministration.entryRelationship:entryRelationship-1.encounter
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Encounter
99. SubstanceAdministration.entryRelationship:entryRelationship-1.organizer
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organizer
100. SubstanceAdministration.entryRelationship:entryRelationship-1.act
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Act
101. SubstanceAdministration.reference
Control0..*
TypeElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
102. SubstanceAdministration.reference.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typeid
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
103. SubstanceAdministration.reference.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on SubstanceAdministration.reference.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
104. SubstanceAdministration.reference.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
105. SubstanceAdministration.reference.seperatableInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
106. SubstanceAdministration.reference.externalAct
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalAct
107. SubstanceAdministration.reference.externalObservation
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalObservation
108. SubstanceAdministration.reference.externalProcedure
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalProcedure
109. SubstanceAdministration.reference.externalDocument
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalDocument
110. SubstanceAdministration.precondition
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Precondition