Consolidated CDA Release 2.1 StructureDefinition Prototype Publication
2.1.0-draft1 - CI Build United States of America

This page is part of the CCDA: Consolidated CDA Release (v2.1.0-draft1: CCDA 2.1 Draft) based on FHIR v5.0.0. . For a full list of available versions, see the Directory of published versions

Resource Profile: PlannedImmunizationActivity - Detailed Descriptions

Active as of 2023-01-16

Definitions for the 2.16.840.1.113883.10.20.22.4.120 resource profile.

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

1. SubstanceAdministration
2. SubstanceAdministration.classCode
Requirements

SHALL contain exactly one [1..1] @classCode="SBADM" (CONF:1098-32091).

Pattern ValueSBADM
3. SubstanceAdministration.moodCode
BindingThe codes SHALL be taken from Planned moodCode (SubstanceAdministration/Supply)For codes, see (unbound)
Requirements

SHALL contain exactly one [1..1] @moodCode, which SHALL be selected from ValueSet Planned moodCode (SubstanceAdministration/Supply) urn:oid:2.16.840.1.113883.11.20.9.24 STATIC 2014-09-01 (CONF:1098-32097).

4. 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
5. SubstanceAdministration.templateId:primary
SliceNameprimary
Control1..1
Requirements

SHALL contain exactly one [1..1] templateId (CONF:1098-32098) such that it

6. SubstanceAdministration.templateId:primary.root
Control1..1
Requirements

SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.120" (CONF:1098-32099).

Pattern Value2.16.840.1.113883.10.20.22.4.120
7. SubstanceAdministration.id
Control10..*
Requirements

SHALL contain at least one [1..*] id (CONF:1098-32100).

8. SubstanceAdministration.statusCode
Control10..1
Requirements

SHALL contain exactly one [1..1] statusCode (CONF:1098-32101).

9. SubstanceAdministration.statusCode.code
Control1..1
Requirements

This statusCode SHALL contain exactly one [1..1] @code="active" Active (CodeSystem: HL7ActStatus urn:oid:2.16.840.1.113883.5.14) (CONF:1098-32102).

Pattern Valueactive
10. SubstanceAdministration.effectiveTime
Control10..1*
Requirements

SHALL contain exactly one [1..1] effectiveTime (CONF:1098-32103).

11. SubstanceAdministration.repeatNumber
Requirements

MAY contain zero or one [0..1] repeatNumber (CONF:1098-32126).

12. SubstanceAdministration.routeCode
BindingThe codes SHALL be taken from SPL Drug Route of Administration TerminologyThe codes SHALL be taken from RouteOfAdministration; other codes may be used where these codes are not suitable
Requirements

MAY contain zero or one [0..1] routeCode, which SHALL be selected from ValueSet SPL Drug Route of Administration Terminology urn:oid:2.16.840.1.113883.3.88.12.3221.8.7 DYNAMIC (CONF:1098-32127).

13. SubstanceAdministration.routeCode.translation
Control0..*
BindingThe codes SHALL be taken from Medication Route
Requirements

The routeCode, if present, SHOULD contain zero or more [0..*] translation, which SHALL be selected from ValueSet Medication Route urn:oid:2.16.840.1.113762.1.4.1099.12 DYNAMIC (CONF:1098-32951).

14. SubstanceAdministration.approachSiteCode
BindingThe codes SHALL be taken from Body Site Value SetThe codes SHALL be taken from http://terminology.hl7.org/ValueSet/v3-ActSite; other codes may be used where these codes are not suitable
Requirements

MAY contain zero or more [0..*] approachSiteCode, which SHALL be selected from ValueSet Body Site Value Set urn:oid:2.16.840.1.113883.3.88.12.3221.8.9 DYNAMIC (CONF:1098-32128).

15. SubstanceAdministration.doseQuantity
Requirements

MAY contain zero or one [0..1] doseQuantity (CONF:1098-32129).

16. SubstanceAdministration.doseQuantity.unit
Control0..1
BindingThe codes SHALL be taken from UnitsOfMeasureCaseSensitive
Requirements

The doseQuantity, if present, SHOULD contain zero or one [0..1] @unit, which SHALL be selected from ValueSet UnitsOfMeasureCaseSensitive urn:oid:2.16.840.1.113883.1.11.12839 DYNAMIC (CONF:1098-32130).

17. SubstanceAdministration.consumable
Requirements

SHALL contain exactly one [1..1] consumable (CONF:1098-32131).

18. SubstanceAdministration.consumable.manufacturedProduct
Typehttp://hl7.org/fhir/cda/StructureDefinition/ManufacturedProduct(ImmunizationMedicationInformation)
Requirements

This consumable SHALL contain exactly one [1..1] Immunization Medication Information (V2) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.54:2014-06-09) (CONF:1098-32132).

19. SubstanceAdministration.performer
Requirements

MAY contain zero or more [0..*] performer (CONF:1098-32104).

20. SubstanceAdministration.author
Typehttp://hl7.org/fhir/cda/StructureDefinition/Author(AuthorParticipation)
Requirements

MAY contain zero or more [0..*] Author Participation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.119) (CONF:1098-32105).

21. 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:
  • profile @ observation
  • profile @ observation,
22. SubstanceAdministration.entryRelationship:priorityPreference
SliceNamepriorityPreference
Control0..*
Requirements

MAY contain zero or more [0..*] entryRelationship (CONF:1098-32108) such that it

23. SubstanceAdministration.entryRelationship:priorityPreference.typeCode
Control1..1
Requirements

SHALL contain exactly one [1..1] @typeCode="REFR" Refers to (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-32109).

Pattern ValueREFR
24. SubstanceAdministration.entryRelationship:priorityPreference.observation
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Observation(PriorityPreference)
Requirements

SHALL contain exactly one [1..1] Priority Preference (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.143) (CONF:1098-32110).

25. SubstanceAdministration.entryRelationship:indication
SliceNameindication
Control0..*
Requirements

MAY contain zero or more [0..*] entryRelationship (CONF:1098-32114) such that it

26. SubstanceAdministration.entryRelationship:indication.typeCode
Control1..1
Requirements

SHALL contain exactly one [1..1] @typeCode="RSON" Has Reason (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-32115).

Pattern ValueRSON
27. SubstanceAdministration.entryRelationship:indication.observation
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Observation(Indication)
Requirements

SHALL contain exactly one [1..1] Indication (V2) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.19:2014-06-09) (CONF:1098-32116).

28. SubstanceAdministration.entryRelationship:instruction
SliceNameinstruction
Control0..*
Requirements

MAY contain zero or more [0..*] entryRelationship (CONF:1098-32117) such that it

29. SubstanceAdministration.entryRelationship:instruction.typeCode
Control1..1
Requirements

SHALL contain exactly one [1..1] @typeCode="SUBJ" Has Subject (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-32118).

Pattern ValueSUBJ
30. SubstanceAdministration.entryRelationship:instruction.act
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Act(Instruction)
Requirements

SHALL contain exactly one [1..1] Instruction (V2) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.20:2014-06-09) (CONF:1098-32119).

31. SubstanceAdministration.precondition
SlicingThis element introduces a set of slices on SubstanceAdministration.precondition. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • profile @ criterion
32. SubstanceAdministration.precondition:pronditionForSubstanceAdmin
SliceNamepronditionForSubstanceAdmin
Control0..*
Requirements

MAY contain zero or more [0..*] precondition (CONF:1098-32123) such that it

33. SubstanceAdministration.precondition:pronditionForSubstanceAdmin.typeCode
Control1..1
Requirements

SHALL contain exactly one [1..1] @typeCode="PRCN" Precondition (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-32124).

Pattern ValuePRCN
34. SubstanceAdministration.precondition:pronditionForSubstanceAdmin.criterion
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Criterion(PreconditionforSubstanceAdministration)
Requirements

SHALL contain exactly one [1..1] Precondition for Substance Administration (V2) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.25:2014-06-09) (CONF:1098-32125).

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.

Control10..1*
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
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.
Requirements

SHALL contain exactly one [1..1] @classCode="SBADM" (CONF:1098-32091).

Default ValueSBADM
Fixed ValueSBADM
Pattern ValueSBADM
3. SubstanceAdministration.moodCode
Control1..1
BindingThe codes SHALL be taken from Planned moodCode (SubstanceAdministration/Supply)
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

SHALL contain exactly one [1..1] @moodCode, which SHALL be selected from ValueSet Planned moodCode (SubstanceAdministration/Supply) urn:oid:2.16.840.1.113883.11.20.9.24 STATIC 2014-09-01 (CONF:1098-32097).

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
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
Requirements

SHALL contain exactly one [1..1] templateId (CONF:1098-32098) such that it

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.
Requirements

SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.120" (CONF:1098-32099).

Pattern Value2.16.840.1.113883.10.20.22.4.120
7. SubstanceAdministration.id
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Requirements

SHALL contain at least one [1..*] id (CONF:1098-32100).

8. SubstanceAdministration.statusCode
Control1..1
BindingThe codes SHALL be taken from ActStatus
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
Requirements

SHALL contain exactly one [1..1] statusCode (CONF:1098-32101).

9. SubstanceAdministration.statusCode.code
Definition

The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache.

Control1..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

This statusCode SHALL contain exactly one [1..1] @code="active" Active (CodeSystem: HL7ActStatus urn:oid:2.16.840.1.113883.5.14) (CONF:1098-32102).

Pattern Valueactive
10. SubstanceAdministration.statusCode.codeSystem
Definition

Specifies the code system that defines the code.

Control0..0
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
11. SubstanceAdministration.statusCode.codeSystemName
Definition

The common name of the coding system.

Control0..0
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
12. SubstanceAdministration.statusCode.codeSystemVersion
Definition

If applicable, a version descriptor defined specifically for the given code system.

Control0..0
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
13. SubstanceAdministration.statusCode.displayName
Definition

A name or title for the code, under which the sending system shows the code value to its users.

Control0..0
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
14. SubstanceAdministration.statusCode.originalText
Definition

The text or phrase used as the basis for the coding.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
15. SubstanceAdministration.statusCode.qualifier
Definition

Specifies additional codes that increase the specificity of the the primary code.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/CR
16. SubstanceAdministration.statusCode.translation
Definition

A set of other concept descriptors that translate this concept descriptor into other code systems.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
XML RepresentationThe type of this property is determined using the xsi:type attribute.
17. SubstanceAdministration.effectiveTime
Control1..1
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.
Requirements

SHALL contain exactly one [1..1] effectiveTime (CONF:1098-32103).

18. SubstanceAdministration.repeatNumber
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-INT
Requirements

MAY contain zero or one [0..1] repeatNumber (CONF:1098-32126).

19. SubstanceAdministration.routeCode
Control0..1
BindingThe codes SHALL be taken from SPL Drug Route of Administration Terminology
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
Requirements

MAY contain zero or one [0..1] routeCode, which SHALL be selected from ValueSet SPL Drug Route of Administration Terminology urn:oid:2.16.840.1.113883.3.88.12.3221.8.7 DYNAMIC (CONF:1098-32127).

20. SubstanceAdministration.routeCode.qualifier
Definition

Specifies additional codes that increase the specificity of the the primary code.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/CR
21. SubstanceAdministration.routeCode.translation
Definition

A set of other concept descriptors that translate this concept descriptor into other code systems.

Control0..*
BindingThe codes SHALL be taken from Medication Route
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
XML RepresentationThe type of this property is determined using the xsi:type attribute.
Requirements

The routeCode, if present, SHOULD contain zero or more [0..*] translation, which SHALL be selected from ValueSet Medication Route urn:oid:2.16.840.1.113762.1.4.1099.12 DYNAMIC (CONF:1098-32951).

22. SubstanceAdministration.approachSiteCode
Control0..*
BindingThe codes SHALL be taken from Body Site Value Set
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
Requirements

MAY contain zero or more [0..*] approachSiteCode, which SHALL be selected from ValueSet Body Site Value Set urn:oid:2.16.840.1.113883.3.88.12.3221.8.9 DYNAMIC (CONF:1098-32128).

23. SubstanceAdministration.doseQuantity
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-PQ
Requirements

MAY contain zero or one [0..1] doseQuantity (CONF:1098-32129).

24. SubstanceAdministration.doseQuantity.unit
Definition

The unit of measure specified in the Unified Code for Units of Measure (UCUM) [].

Control0..1
BindingThe codes SHALL be taken from UnitsOfMeasureCaseSensitive
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

The doseQuantity, if present, SHOULD contain zero or one [0..1] @unit, which SHALL be selected from ValueSet UnitsOfMeasureCaseSensitive urn:oid:2.16.840.1.113883.1.11.12839 DYNAMIC (CONF:1098-32130).

25. SubstanceAdministration.consumable
Control1..1
TypeElement
Requirements

SHALL contain exactly one [1..1] consumable (CONF:1098-32131).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
26. 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
27. SubstanceAdministration.consumable.manufacturedProduct
Definition

Base definition for all types defined in FHIR type system.

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ManufacturedProduct(ImmunizationMedicationInformation)
Requirements

This consumable SHALL contain exactly one [1..1] Immunization Medication Information (V2) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.54:2014-06-09) (CONF:1098-32132).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
28. SubstanceAdministration.performer
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Performer2
Requirements

MAY contain zero or more [0..*] performer (CONF:1098-32104).

29. SubstanceAdministration.author
Definition

Base definition for all types defined in FHIR type system.

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Author(AuthorParticipation)
Requirements

MAY contain zero or more [0..*] Author Participation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.119) (CONF:1098-32105).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
30. 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:
  • profile @ observation
  • profile @ observation,
31. SubstanceAdministration.entryRelationship.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
32. SubstanceAdministration.entryRelationship.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
33. SubstanceAdministration.entryRelationship:priorityPreference
SliceNamepriorityPreference
Control0..*
TypeElement
Requirements

MAY contain zero or more [0..*] entryRelationship (CONF:1098-32108) such that it

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)
34. SubstanceAdministration.entryRelationship:priorityPreference.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

SHALL contain exactly one [1..1] @typeCode="REFR" Refers to (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-32109).

Pattern ValueREFR
35. SubstanceAdministration.entryRelationship:priorityPreference.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
36. SubstanceAdministration.entryRelationship:priorityPreference.observation
Definition

Base definition for all types defined in FHIR type system.

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Observation(PriorityPreference)
Requirements

SHALL contain exactly one [1..1] Priority Preference (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.143) (CONF:1098-32110).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
37. SubstanceAdministration.entryRelationship:priorityPreference.regionOfInterest
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest
38. SubstanceAdministration.entryRelationship:priorityPreference.observationMedia
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ObservationMedia
39. SubstanceAdministration.entryRelationship:priorityPreference.substanceAdministration
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration
40. SubstanceAdministration.entryRelationship:priorityPreference.supply
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Supply
41. SubstanceAdministration.entryRelationship:priorityPreference.procedure
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Procedure
42. SubstanceAdministration.entryRelationship:priorityPreference.encounter
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Encounter
43. SubstanceAdministration.entryRelationship:priorityPreference.organizer
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organizer
44. SubstanceAdministration.entryRelationship:priorityPreference.act
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Act
45. SubstanceAdministration.entryRelationship:indication
SliceNameindication
Control0..*
TypeElement
Requirements

MAY contain zero or more [0..*] entryRelationship (CONF:1098-32114) such that it

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)
46. SubstanceAdministration.entryRelationship:indication.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

SHALL contain exactly one [1..1] @typeCode="RSON" Has Reason (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-32115).

Pattern ValueRSON
47. SubstanceAdministration.entryRelationship:indication.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
48. SubstanceAdministration.entryRelationship:indication.observation
Definition

Base definition for all types defined in FHIR type system.

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Observation(Indication)
Requirements

SHALL contain exactly one [1..1] Indication (V2) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.19:2014-06-09) (CONF:1098-32116).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
49. SubstanceAdministration.entryRelationship:indication.regionOfInterest
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest
50. SubstanceAdministration.entryRelationship:indication.observationMedia
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ObservationMedia
51. SubstanceAdministration.entryRelationship:indication.substanceAdministration
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration
52. SubstanceAdministration.entryRelationship:indication.supply
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Supply
53. SubstanceAdministration.entryRelationship:indication.procedure
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Procedure
54. SubstanceAdministration.entryRelationship:indication.encounter
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Encounter
55. SubstanceAdministration.entryRelationship:indication.organizer
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organizer
56. SubstanceAdministration.entryRelationship:indication.act
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Act
57. SubstanceAdministration.entryRelationship:instruction
SliceNameinstruction
Control0..*
TypeElement
Requirements

MAY contain zero or more [0..*] entryRelationship (CONF:1098-32117) such that it

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)
58. SubstanceAdministration.entryRelationship:instruction.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

SHALL contain exactly one [1..1] @typeCode="SUBJ" Has Subject (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-32118).

Pattern ValueSUBJ
59. SubstanceAdministration.entryRelationship:instruction.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
60. SubstanceAdministration.entryRelationship:instruction.observation
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Observation
61. SubstanceAdministration.entryRelationship:instruction.regionOfInterest
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest
62. SubstanceAdministration.entryRelationship:instruction.observationMedia
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ObservationMedia
63. SubstanceAdministration.entryRelationship:instruction.substanceAdministration
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration
64. SubstanceAdministration.entryRelationship:instruction.supply
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Supply
65. SubstanceAdministration.entryRelationship:instruction.procedure
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Procedure
66. SubstanceAdministration.entryRelationship:instruction.encounter
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Encounter
67. SubstanceAdministration.entryRelationship:instruction.organizer
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organizer
68. SubstanceAdministration.entryRelationship:instruction.act
Definition

Base definition for all types defined in FHIR type system.

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Act(Instruction)
Requirements

SHALL contain exactly one [1..1] Instruction (V2) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.20:2014-06-09) (CONF:1098-32119).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
69. SubstanceAdministration.precondition
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Precondition
SlicingThis element introduces a set of slices on SubstanceAdministration.precondition. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • profile @ criterion
70. SubstanceAdministration.precondition:pronditionForSubstanceAdmin
SliceNamepronditionForSubstanceAdmin
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Precondition
Requirements

MAY contain zero or more [0..*] precondition (CONF:1098-32123) such that it

71. SubstanceAdministration.precondition:pronditionForSubstanceAdmin.typeCode
Control1..1
BindingThe codes SHALL be taken from ActRelationshipType
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

SHALL contain exactly one [1..1] @typeCode="PRCN" Precondition (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-32124).

Pattern ValuePRCN
72. SubstanceAdministration.precondition:pronditionForSubstanceAdmin.criterion
Definition

Base definition for all types defined in FHIR type system.

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Criterion(PreconditionforSubstanceAdministration)
Requirements

SHALL contain exactly one [1..1] Precondition for Substance Administration (V2) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.25:2014-06-09) (CONF:1098-32125).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))

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.

Control1..1
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.
Requirements

SHALL contain exactly one [1..1] @classCode="SBADM" (CONF:1098-32091).

Default ValueSBADM
Fixed ValueSBADM
Pattern ValueSBADM
3. SubstanceAdministration.moodCode
Control1..1
BindingThe codes SHALL be taken from Planned moodCode (SubstanceAdministration/Supply)
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

SHALL contain exactly one [1..1] @moodCode, which SHALL be selected from ValueSet Planned moodCode (SubstanceAdministration/Supply) urn:oid:2.16.840.1.113883.11.20.9.24 STATIC 2014-09-01 (CONF:1098-32097).

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
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
Requirements

SHALL contain exactly one [1..1] templateId (CONF:1098-32098) such that it

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.
Requirements

SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.120" (CONF:1098-32099).

Pattern Value2.16.840.1.113883.10.20.22.4.120
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
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Requirements

SHALL contain at least one [1..*] id (CONF:1098-32100).

14. SubstanceAdministration.code
Control0..1
BindingThe codes SHALL be taken from ActSubstanceAdministrationCode; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
15. SubstanceAdministration.negationInd
Control0..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
16. SubstanceAdministration.text
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
17. SubstanceAdministration.statusCode
Control1..1
BindingThe codes SHALL be taken from ActStatus
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
Requirements

SHALL contain exactly one [1..1] statusCode (CONF:1098-32101).

18. SubstanceAdministration.statusCode.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.
19. SubstanceAdministration.statusCode.code
Definition

The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache.

Control1..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

This statusCode SHALL contain exactly one [1..1] @code="active" Active (CodeSystem: HL7ActStatus urn:oid:2.16.840.1.113883.5.14) (CONF:1098-32102).

Pattern Valueactive
20. SubstanceAdministration.statusCode.codeSystem
Definition

Specifies the code system that defines the code.

Control0..0
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
21. SubstanceAdministration.statusCode.codeSystemName
Definition

The common name of the coding system.

Control0..0
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
22. SubstanceAdministration.statusCode.codeSystemVersion
Definition

If applicable, a version descriptor defined specifically for the given code system.

Control0..0
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
23. SubstanceAdministration.statusCode.displayName
Definition

A name or title for the code, under which the sending system shows the code value to its users.

Control0..0
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
24. SubstanceAdministration.statusCode.sdtcValueSet
Definition

The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name valueSet.
25. SubstanceAdministration.statusCode.sdtcValueSetVersion
Definition

The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name valueSetVersion.
26. SubstanceAdministration.statusCode.originalText
Definition

The text or phrase used as the basis for the coding.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
27. SubstanceAdministration.statusCode.qualifier
Definition

Specifies additional codes that increase the specificity of the the primary code.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/CR
28. SubstanceAdministration.statusCode.translation
Definition

A set of other concept descriptors that translate this concept descriptor into other code systems.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
XML RepresentationThe type of this property is determined using the xsi:type attribute.
29. SubstanceAdministration.effectiveTime
Control1..1
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.
Requirements

SHALL contain exactly one [1..1] effectiveTime (CONF:1098-32103).

30. 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
31. SubstanceAdministration.repeatNumber
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-INT
Requirements

MAY contain zero or one [0..1] repeatNumber (CONF:1098-32126).

32. SubstanceAdministration.routeCode
Control0..1
BindingThe codes SHALL be taken from SPL Drug Route of Administration Terminology
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
Requirements

MAY contain zero or one [0..1] routeCode, which SHALL be selected from ValueSet SPL Drug Route of Administration Terminology urn:oid:2.16.840.1.113883.3.88.12.3221.8.7 DYNAMIC (CONF:1098-32127).

33. SubstanceAdministration.routeCode.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.
34. SubstanceAdministration.routeCode.code
Definition

The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
35. SubstanceAdministration.routeCode.codeSystem
Definition

Specifies the code system that defines the code.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
36. SubstanceAdministration.routeCode.codeSystemName
Definition

The common name of the coding system.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
37. SubstanceAdministration.routeCode.codeSystemVersion
Definition

If applicable, a version descriptor defined specifically for the given code system.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
38. SubstanceAdministration.routeCode.displayName
Definition

A name or title for the code, under which the sending system shows the code value to its users.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
39. SubstanceAdministration.routeCode.sdtcValueSet
Definition

The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name valueSet.
40. SubstanceAdministration.routeCode.sdtcValueSetVersion
Definition

The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name valueSetVersion.
41. SubstanceAdministration.routeCode.originalText
Definition

The text or phrase used as the basis for the coding.

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
42. SubstanceAdministration.routeCode.qualifier
Definition

Specifies additional codes that increase the specificity of the the primary code.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/CR
43. SubstanceAdministration.routeCode.translation
Definition

A set of other concept descriptors that translate this concept descriptor into other code systems.

Control0..*
BindingThe codes SHALL be taken from Medication Route
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
XML RepresentationThe type of this property is determined using the xsi:type attribute.
Requirements

The routeCode, if present, SHOULD contain zero or more [0..*] translation, which SHALL be selected from ValueSet Medication Route urn:oid:2.16.840.1.113762.1.4.1099.12 DYNAMIC (CONF:1098-32951).

44. SubstanceAdministration.approachSiteCode
Control0..*
BindingThe codes SHALL be taken from Body Site Value Set
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
Requirements

MAY contain zero or more [0..*] approachSiteCode, which SHALL be selected from ValueSet Body Site Value Set urn:oid:2.16.840.1.113883.3.88.12.3221.8.9 DYNAMIC (CONF:1098-32128).

45. SubstanceAdministration.doseQuantity
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-PQ
Requirements

MAY contain zero or one [0..1] doseQuantity (CONF:1098-32129).

46. SubstanceAdministration.doseQuantity.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.
47. SubstanceAdministration.doseQuantity.unit
Definition

The unit of measure specified in the Unified Code for Units of Measure (UCUM) [].

Control0..1
BindingThe codes SHALL be taken from UnitsOfMeasureCaseSensitive
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

The doseQuantity, if present, SHOULD contain zero or one [0..1] @unit, which SHALL be selected from ValueSet UnitsOfMeasureCaseSensitive urn:oid:2.16.840.1.113883.1.11.12839 DYNAMIC (CONF:1098-32130).

48. SubstanceAdministration.doseQuantity.value
Definition

The magnitude of the quantity measured in terms of the unit.

Control0..1
Typedecimal
XML RepresentationIn the XML format, this property is represented as an attribute.
49. SubstanceAdministration.doseQuantity.low
Definition

This is the low limit of the interval.

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/PQ
50. SubstanceAdministration.doseQuantity.high
Definition

This is the high limit of the interval.

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/PQ
51. SubstanceAdministration.doseQuantity.width
Definition

The difference between high and low boundary. The purpose of distinguishing a width property is to handle all cases of incomplete information symmetrically. In any interval representation only two of the three properties high, low, and width need to be stated and the third can be derived.

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/PQ
52. SubstanceAdministration.doseQuantity.center
Definition

The arithmetic mean of the interval (low plus high divided by 2). The purpose of distinguishing the center as a semantic property is for conversions of intervals from and to point values.

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/PQ
53. SubstanceAdministration.rateQuantity
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-PQ
54. SubstanceAdministration.maxDoseQuantity
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/RTO-PQ-PQ
55. SubstanceAdministration.administrationUnitCode
Control0..1
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
56. SubstanceAdministration.consumable
Control1..1
TypeElement
Requirements

SHALL contain exactly one [1..1] consumable (CONF:1098-32131).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
57. 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
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
58. 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
59. 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
60. SubstanceAdministration.consumable.manufacturedProduct
Definition

Base definition for all types defined in FHIR type system.

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ManufacturedProduct(ImmunizationMedicationInformation)
Requirements

This consumable SHALL contain exactly one [1..1] Immunization Medication Information (V2) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.54:2014-06-09) (CONF:1098-32132).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
61. 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()))
62. 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
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
63. 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
64. 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
65. 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
66. 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
67. SubstanceAdministration.subject.relatedSubject
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/RelatedSubject
68. SubstanceAdministration.specimen
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Specimen
69. SubstanceAdministration.performer
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Performer2
Requirements

MAY contain zero or more [0..*] performer (CONF:1098-32104).

70. SubstanceAdministration.author
Definition

Base definition for all types defined in FHIR type system.

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Author(AuthorParticipation)
Requirements

MAY contain zero or more [0..*] Author Participation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.119) (CONF:1098-32105).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
71. 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()))
72. 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
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
73. 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
74. 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
75. 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
76. SubstanceAdministration.informant.assignedEntity
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/AssignedEntity
77. SubstanceAdministration.informant.relatedEntity
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/RelatedEntity
78. SubstanceAdministration.participant
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Participant2
79. 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:
  • profile @ observation
  • profile @ observation,
80. 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
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
81. 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
82. SubstanceAdministration.entryRelationship.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
83. SubstanceAdministration.entryRelationship.inversionInd
Control0..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
84. SubstanceAdministration.entryRelationship.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
85. SubstanceAdministration.entryRelationship.sequenceNumber
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/INT
86. SubstanceAdministration.entryRelationship.negationInd
Control0..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
87. SubstanceAdministration.entryRelationship.seperatableInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
88. SubstanceAdministration.entryRelationship.observation
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Observation
89. SubstanceAdministration.entryRelationship.regionOfInterest
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest
90. SubstanceAdministration.entryRelationship.observationMedia
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ObservationMedia
91. SubstanceAdministration.entryRelationship.substanceAdministration
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration
92. SubstanceAdministration.entryRelationship.supply
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Supply
93. SubstanceAdministration.entryRelationship.procedure
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Procedure
94. SubstanceAdministration.entryRelationship.encounter
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Encounter
95. SubstanceAdministration.entryRelationship.organizer
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organizer
96. SubstanceAdministration.entryRelationship.act
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Act
97. SubstanceAdministration.entryRelationship:priorityPreference
SliceNamepriorityPreference
Control0..*
TypeElement
Requirements

MAY contain zero or more [0..*] entryRelationship (CONF:1098-32108) such that it

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)
98. SubstanceAdministration.entryRelationship:priorityPreference.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
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
99. SubstanceAdministration.entryRelationship:priorityPreference.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
100. SubstanceAdministration.entryRelationship:priorityPreference.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

SHALL contain exactly one [1..1] @typeCode="REFR" Refers to (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-32109).

Pattern ValueREFR
101. SubstanceAdministration.entryRelationship:priorityPreference.inversionInd
Control0..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
102. SubstanceAdministration.entryRelationship:priorityPreference.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
103. SubstanceAdministration.entryRelationship:priorityPreference.sequenceNumber
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/INT
104. SubstanceAdministration.entryRelationship:priorityPreference.negationInd
Control0..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
105. SubstanceAdministration.entryRelationship:priorityPreference.seperatableInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
106. SubstanceAdministration.entryRelationship:priorityPreference.observation
Definition

Base definition for all types defined in FHIR type system.

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Observation(PriorityPreference)
Requirements

SHALL contain exactly one [1..1] Priority Preference (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.143) (CONF:1098-32110).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
107. SubstanceAdministration.entryRelationship:priorityPreference.regionOfInterest
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest
108. SubstanceAdministration.entryRelationship:priorityPreference.observationMedia
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ObservationMedia
109. SubstanceAdministration.entryRelationship:priorityPreference.substanceAdministration
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration
110. SubstanceAdministration.entryRelationship:priorityPreference.supply
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Supply
111. SubstanceAdministration.entryRelationship:priorityPreference.procedure
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Procedure
112. SubstanceAdministration.entryRelationship:priorityPreference.encounter
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Encounter
113. SubstanceAdministration.entryRelationship:priorityPreference.organizer
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organizer
114. SubstanceAdministration.entryRelationship:priorityPreference.act
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Act
115. SubstanceAdministration.entryRelationship:indication
SliceNameindication
Control0..*
TypeElement
Requirements

MAY contain zero or more [0..*] entryRelationship (CONF:1098-32114) such that it

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)
116. SubstanceAdministration.entryRelationship:indication.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
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
117. SubstanceAdministration.entryRelationship:indication.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
118. SubstanceAdministration.entryRelationship:indication.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

SHALL contain exactly one [1..1] @typeCode="RSON" Has Reason (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-32115).

Pattern ValueRSON
119. SubstanceAdministration.entryRelationship:indication.inversionInd
Control0..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
120. SubstanceAdministration.entryRelationship:indication.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
121. SubstanceAdministration.entryRelationship:indication.sequenceNumber
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/INT
122. SubstanceAdministration.entryRelationship:indication.negationInd
Control0..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
123. SubstanceAdministration.entryRelationship:indication.seperatableInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
124. SubstanceAdministration.entryRelationship:indication.observation
Definition

Base definition for all types defined in FHIR type system.

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Observation(Indication)
Requirements

SHALL contain exactly one [1..1] Indication (V2) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.19:2014-06-09) (CONF:1098-32116).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
125. SubstanceAdministration.entryRelationship:indication.regionOfInterest
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest
126. SubstanceAdministration.entryRelationship:indication.observationMedia
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ObservationMedia
127. SubstanceAdministration.entryRelationship:indication.substanceAdministration
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration
128. SubstanceAdministration.entryRelationship:indication.supply
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Supply
129. SubstanceAdministration.entryRelationship:indication.procedure
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Procedure
130. SubstanceAdministration.entryRelationship:indication.encounter
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Encounter
131. SubstanceAdministration.entryRelationship:indication.organizer
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organizer
132. SubstanceAdministration.entryRelationship:indication.act
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Act
133. SubstanceAdministration.entryRelationship:instruction
SliceNameinstruction
Control0..*
TypeElement
Requirements

MAY contain zero or more [0..*] entryRelationship (CONF:1098-32117) such that it

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)
134. SubstanceAdministration.entryRelationship:instruction.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
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
135. SubstanceAdministration.entryRelationship:instruction.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
136. SubstanceAdministration.entryRelationship:instruction.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

SHALL contain exactly one [1..1] @typeCode="SUBJ" Has Subject (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-32118).

Pattern ValueSUBJ
137. SubstanceAdministration.entryRelationship:instruction.inversionInd
Control0..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
138. SubstanceAdministration.entryRelationship:instruction.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
139. SubstanceAdministration.entryRelationship:instruction.sequenceNumber
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/INT
140. SubstanceAdministration.entryRelationship:instruction.negationInd
Control0..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
141. SubstanceAdministration.entryRelationship:instruction.seperatableInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
142. SubstanceAdministration.entryRelationship:instruction.observation
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Observation
143. SubstanceAdministration.entryRelationship:instruction.regionOfInterest
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest
144. SubstanceAdministration.entryRelationship:instruction.observationMedia
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ObservationMedia
145. SubstanceAdministration.entryRelationship:instruction.substanceAdministration
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration
146. SubstanceAdministration.entryRelationship:instruction.supply
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Supply
147. SubstanceAdministration.entryRelationship:instruction.procedure
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Procedure
148. SubstanceAdministration.entryRelationship:instruction.encounter
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Encounter
149. SubstanceAdministration.entryRelationship:instruction.organizer
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organizer
150. SubstanceAdministration.entryRelationship:instruction.act
Definition

Base definition for all types defined in FHIR type system.

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Act(Instruction)
Requirements

SHALL contain exactly one [1..1] Instruction (V2) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.20:2014-06-09) (CONF:1098-32119).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
151. 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()))
152. 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
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
153. 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
154. SubstanceAdministration.reference.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
155. SubstanceAdministration.reference.seperatableInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
156. SubstanceAdministration.reference.externalAct
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalAct
157. SubstanceAdministration.reference.externalObservation
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalObservation
158. SubstanceAdministration.reference.externalProcedure
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalProcedure
159. SubstanceAdministration.reference.externalDocument
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalDocument
160. SubstanceAdministration.precondition
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Precondition
SlicingThis element introduces a set of slices on SubstanceAdministration.precondition. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • profile @ criterion
161. SubstanceAdministration.precondition:pronditionForSubstanceAdmin
SliceNamepronditionForSubstanceAdmin
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Precondition
Requirements

MAY contain zero or more [0..*] precondition (CONF:1098-32123) such that it

162. SubstanceAdministration.precondition:pronditionForSubstanceAdmin.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.
163. SubstanceAdministration.precondition:pronditionForSubstanceAdmin.typeCode
Control1..1
BindingThe codes SHALL be taken from ActRelationshipType
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

SHALL contain exactly one [1..1] @typeCode="PRCN" Precondition (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-32124).

Pattern ValuePRCN
164. SubstanceAdministration.precondition:pronditionForSubstanceAdmin.realmCode
Definition

When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
165. SubstanceAdministration.precondition:pronditionForSubstanceAdmin.typeId
Definition

When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
166. SubstanceAdministration.precondition:pronditionForSubstanceAdmin.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
167. SubstanceAdministration.precondition:pronditionForSubstanceAdmin.criterion
Definition

Base definition for all types defined in FHIR type system.

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Criterion(PreconditionforSubstanceAdministration)
Requirements

SHALL contain exactly one [1..1] Precondition for Substance Administration (V2) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.25:2014-06-09) (CONF:1098-32125).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))