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: ImmunizationActivity - Detailed Descriptions

Active as of 2023-01-16

Definitions for the 2.16.840.1.113883.10.20.22.4.52 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" (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:1198-8826).

3. SubstanceAdministration.moodCode
BindingThe codes SHALL be taken from MoodCodeEvnIntFor codes, see (unbound)
Requirements

SHALL contain exactly one [1..1] @moodCode, which SHALL be selected from ValueSet MoodCodeEvnInt urn:oid:2.16.840.1.113883.11.20.9.18 STATIC (CONF:1198-8827).

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
  • value @ root,
5. SubstanceAdministration.templateId:primary
SliceNameprimary
Control1..1
Requirements

SHALL contain exactly one [1..1] templateId (CONF:1198-8828) 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.52" (CONF:1198-10498).

Pattern Value2.16.840.1.113883.10.20.22.4.52
7. SubstanceAdministration.templateId:primary.extension
Control1..1
Requirements

SHALL contain exactly one [1..1] @extension="2015-08-01" (CONF:1198-32528).

Pattern Value2015-08-01
8. SubstanceAdministration.id
Control10..*
Requirements

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

9. SubstanceAdministration.code
Requirements

MAY contain zero or one [0..1] code (CONF:1198-8830).

10. SubstanceAdministration.negationInd
Control10..1
Requirements

SHALL contain exactly one [1..1] @negationInd (CONF:1198-8985).

11. SubstanceAdministration.statusCode
Control10..1
Requirements

SHALL contain exactly one [1..1] statusCode (CONF:1198-8833).

12. SubstanceAdministration.statusCode.code
Control1..1
BindingThe codes SHALL be taken from ActStatus
Requirements

This statusCode SHALL contain exactly one [1..1] @code, which SHALL be selected from ValueSet ActStatus urn:oid:2.16.840.1.113883.1.11.15933 DYNAMIC (CONF:1198-32359).

13. SubstanceAdministration.effectiveTime
Control10..1*
Requirements

SHALL contain exactly one [1..1] effectiveTime (CONF:1198-8834).

14. SubstanceAdministration.repeatNumber
Requirements

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

15. 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:1198-8839).

16. 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:1198-32960).

17. SubstanceAdministration.approachSiteCode
Control0..1*
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 one [0..1] approachSiteCode, where the code SHALL be selected from ValueSet Body Site Value Set urn:oid:2.16.840.1.113883.3.88.12.3221.8.9 DYNAMIC (CONF:1198-8840).

18. SubstanceAdministration.doseQuantity
Requirements

SHOULD contain zero or one [0..1] doseQuantity (CONF:1198-8841).

19. 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:1198-8842).

20. SubstanceAdministration.administrationUnitCode
BindingThe codes SHALL be taken from AdministrationUnitDoseFormThe codes SHALL be taken from AdministrableDrugForm; other codes may be used where these codes are not suitable
Requirements

MAY contain zero or one [0..1] administrationUnitCode, which SHALL be selected from ValueSet AdministrationUnitDoseForm urn:oid:2.16.840.1.113762.1.4.1021.30 DYNAMIC (CONF:1198-8846).

21. SubstanceAdministration.consumable
Requirements

SHALL contain exactly one [1..1] consumable (CONF:1198-8847).

22. 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:1198-15546).

23. SubstanceAdministration.performer
Control0..1*
Requirements

SHOULD contain zero or one [0..1] performer (CONF:1198-8849).

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

SHOULD contain zero or more [0..*] Author Participation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.119) (CONF:1198-31151).

25. SubstanceAdministration.participant
SlicingThis element introduces a set of slices on SubstanceAdministration.participant. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ typeCode
  • value @ typeCode,
26. SubstanceAdministration.participant:drugVehicle
SliceNamedrugVehicle
Control0..*
Requirements

MAY contain zero or more [0..*] participant (CONF:1198-8850) such that it

27. SubstanceAdministration.participant:drugVehicle.typeCode
Control1..1
Requirements

SHALL contain exactly one [1..1] @typeCode="CSM" (CodeSystem: HL7ParticipationType urn:oid:2.16.840.1.113883.5.90 STATIC) (CONF:1198-8851).

Pattern ValueCSM
28. SubstanceAdministration.participant:drugVehicle.participantRole
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ParticipantRole(DrugVehicle)
Requirements

SHALL contain exactly one [1..1] Drug Vehicle (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.24) (CONF:1198-15547).

29. 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 @ act
  • profile @ act,
  • profile @ act,
30. SubstanceAdministration.entryRelationship:indication
SliceNameindication
Control0..*
Requirements

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

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

SHALL contain exactly one [1..1] @typeCode="RSON" (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:1198-8854).

Pattern ValueRSON
32. 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:1198-15537).

33. SubstanceAdministration.entryRelationship:instruction
SliceNameinstruction
Control0..1
Requirements

MAY contain zero or one [0..1] entryRelationship (CONF:1198-8856) such that it

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

SHALL contain exactly one [1..1] @typeCode="SUBJ" (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:1198-8857).

Pattern ValueSUBJ
35. SubstanceAdministration.entryRelationship:instruction.inversionInd
Control1..1
Requirements

SHALL contain exactly one [1..1] @inversionInd="true" True (CONF:1198-8858).

Pattern Valuetrue
36. 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:1198-31392).

37. SubstanceAdministration.entryRelationship:medSupplyOrder
SliceNamemedSupplyOrder
Control0..1
Requirements

MAY contain zero or one [0..1] entryRelationship (CONF:1198-8860) such that it

38. SubstanceAdministration.entryRelationship:medSupplyOrder.typeCode
Control1..1
Requirements

SHALL contain exactly one [1..1] @typeCode="REFR" (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:1198-8861).

Pattern ValueREFR
39. SubstanceAdministration.entryRelationship:medSupplyOrder.supply
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Supply(MedicationSupplyOrder)
Requirements

SHALL contain exactly one [1..1] Medication Supply Order (V2) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.17:2014-06-09) (CONF:1198-15539).

40. SubstanceAdministration.entryRelationship:medDispense
SliceNamemedDispense
Control0..1
Requirements

MAY contain zero or one [0..1] entryRelationship (CONF:1198-8863) such that it

41. SubstanceAdministration.entryRelationship:medDispense.typeCode
Control1..1
Requirements

SHALL contain exactly one [1..1] @typeCode="REFR" (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:1198-8864).

Pattern ValueREFR
42. SubstanceAdministration.entryRelationship:medDispense.supply
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Supply(MedicationDispense)
Requirements

SHALL contain exactly one [1..1] Medication Dispense (V2) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.18:2014-06-09) (CONF:1198-15540).

43. SubstanceAdministration.entryRelationship:reactionObs
SliceNamereactionObs
Control0..1
Requirements

MAY contain zero or one [0..1] entryRelationship (CONF:1198-8866) such that it

44. SubstanceAdministration.entryRelationship:reactionObs.typeCode
Control1..1
Requirements

SHALL contain exactly one [1..1] @typeCode="CAUS" (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:1198-8867).

Pattern ValueCAUS
45. SubstanceAdministration.entryRelationship:reactionObs.observation
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Observation(ReactionObservation)
Requirements

SHALL contain exactly one [1..1] Reaction Observation (V2) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.9:2014-06-09) (CONF:1198-15541).

46. SubstanceAdministration.entryRelationship:immunizationRefusal
SliceNameimmunizationRefusal
Control0..1
Requirements

MAY contain zero or one [0..1] entryRelationship (CONF:1198-8988) such that it

47. SubstanceAdministration.entryRelationship:immunizationRefusal.typeCode
Control1..1
Requirements

SHALL contain exactly one [1..1] @typeCode="RSON" (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:1198-8989).

Pattern ValueRSON
48. SubstanceAdministration.entryRelationship:immunizationRefusal.observation
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Observation(ImmunizationRefusalReason)
Requirements

SHALL contain exactly one [1..1] Immunization Refusal Reason (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.53) (CONF:1198-15542).

49. SubstanceAdministration.entryRelationship:substanceAdmin
SliceNamesubstanceAdmin
Control0..*
Requirements

SHOULD contain zero or more [0..*] entryRelationship (CONF:1198-31510) such that it

50. SubstanceAdministration.entryRelationship:substanceAdmin.typeCode
Control1..1
Requirements

SHALL contain exactly one [1..1] @typeCode="COMP" Component (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1198-31511).

Pattern ValueCOMP
51. SubstanceAdministration.entryRelationship:substanceAdmin.inversionInd
Control1..1
Requirements

SHALL contain exactly one [1..1] @inversionInd="true" (CONF:1198-31512).

Pattern Valuetrue
52. SubstanceAdministration.entryRelationship:substanceAdmin.sequenceNumber
Control0..1
Requirements

MAY contain zero or one [0..1] sequenceNumber (CONF:1198-31513).

53. SubstanceAdministration.entryRelationship:substanceAdmin.act
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Act(SubstanceAdministeredAct)
Requirements

SHALL contain exactly one [1..1] Substance Administered Act (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.118) (CONF:1198-31514).

54. 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
55. SubstanceAdministration.precondition:substanceAdmin
SliceNamesubstanceAdmin
Control0..*
Requirements

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

56. SubstanceAdministration.precondition:substanceAdmin.typeCode
Control1..1
Requirements

SHALL contain exactly one [1..1] @typeCode="PRCN" (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:1198-8870).

Pattern ValuePRCN
57. SubstanceAdministration.precondition:substanceAdmin.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:1198-15548).

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" (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:1198-8826).

Default ValueSBADM
Fixed ValueSBADM
3. SubstanceAdministration.moodCode
Control1..1
BindingThe codes SHALL be taken from MoodCodeEvnInt
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 MoodCodeEvnInt urn:oid:2.16.840.1.113883.11.20.9.18 STATIC (CONF:1198-8827).

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
Requirements

SHALL contain exactly one [1..1] templateId (CONF:1198-8828) 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.52" (CONF:1198-10498).

Pattern Value2.16.840.1.113883.10.20.22.4.52
7. SubstanceAdministration.templateId:primary.extension
Definition

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

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

SHALL contain exactly one [1..1] @extension="2015-08-01" (CONF:1198-32528).

Pattern Value2015-08-01
8. SubstanceAdministration.id
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Requirements

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

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

MAY contain zero or one [0..1] code (CONF:1198-8830).

10. SubstanceAdministration.negationInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

SHALL contain exactly one [1..1] @negationInd (CONF:1198-8985).

11. 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:1198-8833).

12. 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
BindingThe codes SHALL be taken from ActStatus
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

This statusCode SHALL contain exactly one [1..1] @code, which SHALL be selected from ValueSet ActStatus urn:oid:2.16.840.1.113883.1.11.15933 DYNAMIC (CONF:1198-32359).

13. 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.
14. 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.
15. 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.
16. 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.
17. SubstanceAdministration.statusCode.originalText
Definition

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

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
18. 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
19. 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.
20. 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:1198-8834).

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

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

22. 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:1198-8839).

23. 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
24. 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:1198-32960).

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

MAY contain zero or one [0..1] approachSiteCode, where the code SHALL be selected from ValueSet Body Site Value Set urn:oid:2.16.840.1.113883.3.88.12.3221.8.9 DYNAMIC (CONF:1198-8840).

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

SHOULD contain zero or one [0..1] doseQuantity (CONF:1198-8841).

27. 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:1198-8842).

28. SubstanceAdministration.administrationUnitCode
Control0..1
BindingThe codes SHALL be taken from AdministrationUnitDoseForm
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
Requirements

MAY contain zero or one [0..1] administrationUnitCode, which SHALL be selected from ValueSet AdministrationUnitDoseForm urn:oid:2.16.840.1.113762.1.4.1021.30 DYNAMIC (CONF:1198-8846).

29. SubstanceAdministration.consumable
Control1..1
TypeElement
Requirements

SHALL contain exactly one [1..1] consumable (CONF:1198-8847).

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

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

SHOULD contain zero or one [0..1] performer (CONF:1198-8849).

33. SubstanceAdministration.author
Definition

Base definition for all types defined in FHIR type system.

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

SHOULD contain zero or more [0..*] Author Participation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.119) (CONF:1198-31151).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
34. SubstanceAdministration.participant
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Participant2
SlicingThis element introduces a set of slices on SubstanceAdministration.participant. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ typeCode
  • value @ typeCode,
35. SubstanceAdministration.participant:drugVehicle
SliceNamedrugVehicle
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Participant2
Requirements

MAY contain zero or more [0..*] participant (CONF:1198-8850) such that it

36. SubstanceAdministration.participant:drugVehicle.typeCode
Control1..1
BindingThe codes SHALL be taken from ParticipationType
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

SHALL contain exactly one [1..1] @typeCode="CSM" (CodeSystem: HL7ParticipationType urn:oid:2.16.840.1.113883.5.90 STATIC) (CONF:1198-8851).

Pattern ValueCSM
37. SubstanceAdministration.participant:drugVehicle.participantRole
Definition

Base definition for all types defined in FHIR type system.

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ParticipantRole(DrugVehicle)
Requirements

SHALL contain exactly one [1..1] Drug Vehicle (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.24) (CONF:1198-15547).

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

MAY contain zero or more [0..*] entryRelationship (CONF:1198-8853) 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)
42. 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" (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:1198-8854).

Pattern ValueRSON
43. SubstanceAdministration.entryRelationship:indication.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
44. 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:1198-15537).

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

MAY contain zero or one [0..1] entryRelationship (CONF:1198-8856) 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)
54. 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" (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:1198-8857).

Pattern ValueSUBJ
55. SubstanceAdministration.entryRelationship:instruction.inversionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

SHALL contain exactly one [1..1] @inversionInd="true" True (CONF:1198-8858).

Pattern Valuetrue
56. SubstanceAdministration.entryRelationship:instruction.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
57. SubstanceAdministration.entryRelationship:instruction.observation
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Observation
58. SubstanceAdministration.entryRelationship:instruction.regionOfInterest
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest
59. SubstanceAdministration.entryRelationship:instruction.observationMedia
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ObservationMedia
60. SubstanceAdministration.entryRelationship:instruction.substanceAdministration
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration
61. SubstanceAdministration.entryRelationship:instruction.supply
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Supply
62. SubstanceAdministration.entryRelationship:instruction.procedure
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Procedure
63. SubstanceAdministration.entryRelationship:instruction.encounter
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Encounter
64. SubstanceAdministration.entryRelationship:instruction.organizer
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organizer
65. 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:1198-31392).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
66. SubstanceAdministration.entryRelationship:medSupplyOrder
SliceNamemedSupplyOrder
Control0..1
TypeElement
Requirements

MAY contain zero or one [0..1] entryRelationship (CONF:1198-8860) 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)
67. SubstanceAdministration.entryRelationship:medSupplyOrder.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" (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:1198-8861).

Pattern ValueREFR
68. SubstanceAdministration.entryRelationship:medSupplyOrder.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
69. SubstanceAdministration.entryRelationship:medSupplyOrder.observation
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Observation
70. SubstanceAdministration.entryRelationship:medSupplyOrder.regionOfInterest
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest
71. SubstanceAdministration.entryRelationship:medSupplyOrder.observationMedia
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ObservationMedia
72. SubstanceAdministration.entryRelationship:medSupplyOrder.substanceAdministration
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration
73. SubstanceAdministration.entryRelationship:medSupplyOrder.supply
Definition

Base definition for all types defined in FHIR type system.

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Supply(MedicationSupplyOrder)
Requirements

SHALL contain exactly one [1..1] Medication Supply Order (V2) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.17:2014-06-09) (CONF:1198-15539).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
74. SubstanceAdministration.entryRelationship:medSupplyOrder.procedure
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Procedure
75. SubstanceAdministration.entryRelationship:medSupplyOrder.encounter
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Encounter
76. SubstanceAdministration.entryRelationship:medSupplyOrder.organizer
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organizer
77. SubstanceAdministration.entryRelationship:medSupplyOrder.act
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Act
78. SubstanceAdministration.entryRelationship:medDispense
SliceNamemedDispense
Control0..1
TypeElement
Requirements

MAY contain zero or one [0..1] entryRelationship (CONF:1198-8863) 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)
79. SubstanceAdministration.entryRelationship:medDispense.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" (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:1198-8864).

Pattern ValueREFR
80. SubstanceAdministration.entryRelationship:medDispense.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
81. SubstanceAdministration.entryRelationship:medDispense.observation
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Observation
82. SubstanceAdministration.entryRelationship:medDispense.regionOfInterest
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest
83. SubstanceAdministration.entryRelationship:medDispense.observationMedia
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ObservationMedia
84. SubstanceAdministration.entryRelationship:medDispense.substanceAdministration
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration
85. SubstanceAdministration.entryRelationship:medDispense.supply
Definition

Base definition for all types defined in FHIR type system.

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Supply(MedicationDispense)
Requirements

SHALL contain exactly one [1..1] Medication Dispense (V2) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.18:2014-06-09) (CONF:1198-15540).

InvariantsDefined on this element
1098-9333: A supply act **SHALL** contain one product/Medication Information *OR* one product/Immunization Medication Information template (CONF:1098-9333). (: null)
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
86. SubstanceAdministration.entryRelationship:medDispense.procedure
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Procedure
87. SubstanceAdministration.entryRelationship:medDispense.encounter
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Encounter
88. SubstanceAdministration.entryRelationship:medDispense.organizer
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organizer
89. SubstanceAdministration.entryRelationship:medDispense.act
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Act
90. SubstanceAdministration.entryRelationship:reactionObs
SliceNamereactionObs
Control0..1
TypeElement
Requirements

MAY contain zero or one [0..1] entryRelationship (CONF:1198-8866) 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)
91. SubstanceAdministration.entryRelationship:reactionObs.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

SHALL contain exactly one [1..1] @typeCode="CAUS" (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:1198-8867).

Pattern ValueCAUS
92. SubstanceAdministration.entryRelationship:reactionObs.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
93. SubstanceAdministration.entryRelationship:reactionObs.observation
Definition

Base definition for all types defined in FHIR type system.

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

SHALL contain exactly one [1..1] Reaction Observation (V2) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.9:2014-06-09) (CONF:1198-15541).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
94. SubstanceAdministration.entryRelationship:reactionObs.regionOfInterest
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest
95. SubstanceAdministration.entryRelationship:reactionObs.observationMedia
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ObservationMedia
96. SubstanceAdministration.entryRelationship:reactionObs.substanceAdministration
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration
97. SubstanceAdministration.entryRelationship:reactionObs.supply
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Supply
98. SubstanceAdministration.entryRelationship:reactionObs.procedure
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Procedure
99. SubstanceAdministration.entryRelationship:reactionObs.encounter
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Encounter
100. SubstanceAdministration.entryRelationship:reactionObs.organizer
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organizer
101. SubstanceAdministration.entryRelationship:reactionObs.act
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Act
102. SubstanceAdministration.entryRelationship:immunizationRefusal
SliceNameimmunizationRefusal
Control0..1
TypeElement
Requirements

MAY contain zero or one [0..1] entryRelationship (CONF:1198-8988) 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)
103. SubstanceAdministration.entryRelationship:immunizationRefusal.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" (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:1198-8989).

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

Base definition for all types defined in FHIR type system.

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

SHALL contain exactly one [1..1] Immunization Refusal Reason (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.53) (CONF:1198-15542).

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

SHOULD contain zero or more [0..*] entryRelationship (CONF:1198-31510) 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)
115. SubstanceAdministration.entryRelationship:substanceAdmin.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

SHALL contain exactly one [1..1] @typeCode="COMP" Component (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1198-31511).

Pattern ValueCOMP
116. SubstanceAdministration.entryRelationship:substanceAdmin.inversionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

SHALL contain exactly one [1..1] @inversionInd="true" (CONF:1198-31512).

Pattern Valuetrue
117. SubstanceAdministration.entryRelationship:substanceAdmin.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
118. SubstanceAdministration.entryRelationship:substanceAdmin.sequenceNumber
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/INT
Requirements

MAY contain zero or one [0..1] sequenceNumber (CONF:1198-31513).

119. SubstanceAdministration.entryRelationship:substanceAdmin.observation
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Observation
120. SubstanceAdministration.entryRelationship:substanceAdmin.regionOfInterest
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest
121. SubstanceAdministration.entryRelationship:substanceAdmin.observationMedia
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ObservationMedia
122. SubstanceAdministration.entryRelationship:substanceAdmin.substanceAdministration
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration
123. SubstanceAdministration.entryRelationship:substanceAdmin.supply
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Supply
124. SubstanceAdministration.entryRelationship:substanceAdmin.procedure
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Procedure
125. SubstanceAdministration.entryRelationship:substanceAdmin.encounter
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Encounter
126. SubstanceAdministration.entryRelationship:substanceAdmin.organizer
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organizer
127. SubstanceAdministration.entryRelationship:substanceAdmin.act
Definition

Base definition for all types defined in FHIR type system.

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

SHALL contain exactly one [1..1] Substance Administered Act (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.118) (CONF:1198-31514).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
128. 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
129. SubstanceAdministration.precondition:substanceAdmin
SliceNamesubstanceAdmin
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Precondition
Requirements

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

130. SubstanceAdministration.precondition:substanceAdmin.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" (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:1198-8870).

Pattern ValuePRCN
131. SubstanceAdministration.precondition:substanceAdmin.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:1198-15548).

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" (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:1198-8826).

Default ValueSBADM
Fixed ValueSBADM
3. SubstanceAdministration.moodCode
Control1..1
BindingThe codes SHALL be taken from MoodCodeEvnInt
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 MoodCodeEvnInt urn:oid:2.16.840.1.113883.11.20.9.18 STATIC (CONF:1198-8827).

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
Requirements

SHALL contain exactly one [1..1] templateId (CONF:1198-8828) 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.52" (CONF:1198-10498).

Pattern Value2.16.840.1.113883.10.20.22.4.52
12. SubstanceAdministration.templateId:primary.extension
Definition

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

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

SHALL contain exactly one [1..1] @extension="2015-08-01" (CONF:1198-32528).

Pattern Value2015-08-01
13. SubstanceAdministration.id
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Requirements

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

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
Requirements

MAY contain zero or one [0..1] code (CONF:1198-8830).

15. SubstanceAdministration.negationInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

SHALL contain exactly one [1..1] @negationInd (CONF:1198-8985).

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:1198-8833).

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
BindingThe codes SHALL be taken from ActStatus
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

This statusCode SHALL contain exactly one [1..1] @code, which SHALL be selected from ValueSet ActStatus urn:oid:2.16.840.1.113883.1.11.15933 DYNAMIC (CONF:1198-32359).

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:1198-8834).

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:1198-8838).

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:1198-8839).

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:1198-32960).

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

MAY contain zero or one [0..1] approachSiteCode, where the code SHALL be selected from ValueSet Body Site Value Set urn:oid:2.16.840.1.113883.3.88.12.3221.8.9 DYNAMIC (CONF:1198-8840).

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

SHOULD contain zero or one [0..1] doseQuantity (CONF:1198-8841).

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:1198-8842).

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 AdministrationUnitDoseForm
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
Requirements

MAY contain zero or one [0..1] administrationUnitCode, which SHALL be selected from ValueSet AdministrationUnitDoseForm urn:oid:2.16.840.1.113762.1.4.1021.30 DYNAMIC (CONF:1198-8846).

56. SubstanceAdministration.consumable
Control1..1
TypeElement
Requirements

SHALL contain exactly one [1..1] consumable (CONF:1198-8847).

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:1198-15546).

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..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Performer2
Requirements

SHOULD contain zero or one [0..1] performer (CONF:1198-8849).

70. SubstanceAdministration.author
Definition

Base definition for all types defined in FHIR type system.

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

SHOULD contain zero or more [0..*] Author Participation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.119) (CONF:1198-31151).

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
SlicingThis element introduces a set of slices on SubstanceAdministration.participant. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ typeCode
  • value @ typeCode,
79. SubstanceAdministration.participant:drugVehicle
SliceNamedrugVehicle
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Participant2
Requirements

MAY contain zero or more [0..*] participant (CONF:1198-8850) such that it

80. SubstanceAdministration.participant:drugVehicle.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.
81. SubstanceAdministration.participant:drugVehicle.typeCode
Control1..1
BindingThe codes SHALL be taken from ParticipationType
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

SHALL contain exactly one [1..1] @typeCode="CSM" (CodeSystem: HL7ParticipationType urn:oid:2.16.840.1.113883.5.90 STATIC) (CONF:1198-8851).

Pattern ValueCSM
82. SubstanceAdministration.participant:drugVehicle.contextControlCode
Control0..1
BindingThe codes SHALL be taken from ContextControl
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueOP
83. SubstanceAdministration.participant:drugVehicle.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
84. SubstanceAdministration.participant:drugVehicle.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
85. SubstanceAdministration.participant:drugVehicle.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
86. SubstanceAdministration.participant:drugVehicle.sdtcFunctionCode
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
XML RepresentationIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name functionCode.
87. SubstanceAdministration.participant:drugVehicle.time
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-TS
88. SubstanceAdministration.participant:drugVehicle.awarenessCode
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
89. SubstanceAdministration.participant:drugVehicle.participantRole
Definition

Base definition for all types defined in FHIR type system.

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ParticipantRole(DrugVehicle)
Requirements

SHALL contain exactly one [1..1] Drug Vehicle (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.24) (CONF:1198-15547).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
90. 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 @ act
  • profile @ act,
  • profile @ act,
91. 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
92. 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
93. SubstanceAdministration.entryRelationship.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
94. SubstanceAdministration.entryRelationship.inversionInd
Control0..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
95. SubstanceAdministration.entryRelationship.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
96. SubstanceAdministration.entryRelationship.sequenceNumber
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/INT
97. SubstanceAdministration.entryRelationship.negationInd
Control0..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
98. SubstanceAdministration.entryRelationship.seperatableInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
99. SubstanceAdministration.entryRelationship.observation
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Observation
100. SubstanceAdministration.entryRelationship.regionOfInterest
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest
101. SubstanceAdministration.entryRelationship.observationMedia
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ObservationMedia
102. SubstanceAdministration.entryRelationship.substanceAdministration
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration
103. SubstanceAdministration.entryRelationship.supply
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Supply
104. SubstanceAdministration.entryRelationship.procedure
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Procedure
105. SubstanceAdministration.entryRelationship.encounter
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Encounter
106. SubstanceAdministration.entryRelationship.organizer
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organizer
107. SubstanceAdministration.entryRelationship.act
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Act
108. SubstanceAdministration.entryRelationship:indication
SliceNameindication
Control0..*
TypeElement
Requirements

MAY contain zero or more [0..*] entryRelationship (CONF:1198-8853) 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)
109. 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
110. 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
111. 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" (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:1198-8854).

Pattern ValueRSON
112. SubstanceAdministration.entryRelationship:indication.inversionInd
Control0..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
113. SubstanceAdministration.entryRelationship:indication.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
114. SubstanceAdministration.entryRelationship:indication.sequenceNumber
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/INT
115. SubstanceAdministration.entryRelationship:indication.negationInd
Control0..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
116. SubstanceAdministration.entryRelationship:indication.seperatableInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
117. 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:1198-15537).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
118. SubstanceAdministration.entryRelationship:indication.regionOfInterest
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest
119. SubstanceAdministration.entryRelationship:indication.observationMedia
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ObservationMedia
120. SubstanceAdministration.entryRelationship:indication.substanceAdministration
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration
121. SubstanceAdministration.entryRelationship:indication.supply
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Supply
122. SubstanceAdministration.entryRelationship:indication.procedure
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Procedure
123. SubstanceAdministration.entryRelationship:indication.encounter
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Encounter
124. SubstanceAdministration.entryRelationship:indication.organizer
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organizer
125. SubstanceAdministration.entryRelationship:indication.act
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Act
126. SubstanceAdministration.entryRelationship:instruction
SliceNameinstruction
Control0..1
TypeElement
Requirements

MAY contain zero or one [0..1] entryRelationship (CONF:1198-8856) 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)
127. 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
128. 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
129. 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" (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:1198-8857).

Pattern ValueSUBJ
130. SubstanceAdministration.entryRelationship:instruction.inversionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

SHALL contain exactly one [1..1] @inversionInd="true" True (CONF:1198-8858).

Pattern Valuetrue
131. SubstanceAdministration.entryRelationship:instruction.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
132. SubstanceAdministration.entryRelationship:instruction.sequenceNumber
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/INT
133. SubstanceAdministration.entryRelationship:instruction.negationInd
Control0..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
134. SubstanceAdministration.entryRelationship:instruction.seperatableInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
135. SubstanceAdministration.entryRelationship:instruction.observation
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Observation
136. SubstanceAdministration.entryRelationship:instruction.regionOfInterest
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest
137. SubstanceAdministration.entryRelationship:instruction.observationMedia
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ObservationMedia
138. SubstanceAdministration.entryRelationship:instruction.substanceAdministration
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration
139. SubstanceAdministration.entryRelationship:instruction.supply
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Supply
140. SubstanceAdministration.entryRelationship:instruction.procedure
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Procedure
141. SubstanceAdministration.entryRelationship:instruction.encounter
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Encounter
142. SubstanceAdministration.entryRelationship:instruction.organizer
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organizer
143. 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:1198-31392).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
144. SubstanceAdministration.entryRelationship:medSupplyOrder
SliceNamemedSupplyOrder
Control0..1
TypeElement
Requirements

MAY contain zero or one [0..1] entryRelationship (CONF:1198-8860) 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)
145. SubstanceAdministration.entryRelationship:medSupplyOrder.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
146. SubstanceAdministration.entryRelationship:medSupplyOrder.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
147. SubstanceAdministration.entryRelationship:medSupplyOrder.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" (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:1198-8861).

Pattern ValueREFR
148. SubstanceAdministration.entryRelationship:medSupplyOrder.inversionInd
Control0..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
149. SubstanceAdministration.entryRelationship:medSupplyOrder.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
150. SubstanceAdministration.entryRelationship:medSupplyOrder.sequenceNumber
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/INT
151. SubstanceAdministration.entryRelationship:medSupplyOrder.negationInd
Control0..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
152. SubstanceAdministration.entryRelationship:medSupplyOrder.seperatableInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
153. SubstanceAdministration.entryRelationship:medSupplyOrder.observation
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Observation
154. SubstanceAdministration.entryRelationship:medSupplyOrder.regionOfInterest
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest
155. SubstanceAdministration.entryRelationship:medSupplyOrder.observationMedia
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ObservationMedia
156. SubstanceAdministration.entryRelationship:medSupplyOrder.substanceAdministration
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration
157. SubstanceAdministration.entryRelationship:medSupplyOrder.supply
Definition

Base definition for all types defined in FHIR type system.

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Supply(MedicationSupplyOrder)
Requirements

SHALL contain exactly one [1..1] Medication Supply Order (V2) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.17:2014-06-09) (CONF:1198-15539).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
158. SubstanceAdministration.entryRelationship:medSupplyOrder.procedure
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Procedure
159. SubstanceAdministration.entryRelationship:medSupplyOrder.encounter
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Encounter
160. SubstanceAdministration.entryRelationship:medSupplyOrder.organizer
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organizer
161. SubstanceAdministration.entryRelationship:medSupplyOrder.act
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Act
162. SubstanceAdministration.entryRelationship:medDispense
SliceNamemedDispense
Control0..1
TypeElement
Requirements

MAY contain zero or one [0..1] entryRelationship (CONF:1198-8863) 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)
163. SubstanceAdministration.entryRelationship:medDispense.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
164. SubstanceAdministration.entryRelationship:medDispense.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
165. SubstanceAdministration.entryRelationship:medDispense.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" (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:1198-8864).

Pattern ValueREFR
166. SubstanceAdministration.entryRelationship:medDispense.inversionInd
Control0..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
167. SubstanceAdministration.entryRelationship:medDispense.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
168. SubstanceAdministration.entryRelationship:medDispense.sequenceNumber
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/INT
169. SubstanceAdministration.entryRelationship:medDispense.negationInd
Control0..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
170. SubstanceAdministration.entryRelationship:medDispense.seperatableInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
171. SubstanceAdministration.entryRelationship:medDispense.observation
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Observation
172. SubstanceAdministration.entryRelationship:medDispense.regionOfInterest
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest
173. SubstanceAdministration.entryRelationship:medDispense.observationMedia
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ObservationMedia
174. SubstanceAdministration.entryRelationship:medDispense.substanceAdministration
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration
175. SubstanceAdministration.entryRelationship:medDispense.supply
Definition

Base definition for all types defined in FHIR type system.

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Supply(MedicationDispense)
Requirements

SHALL contain exactly one [1..1] Medication Dispense (V2) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.18:2014-06-09) (CONF:1198-15540).

InvariantsDefined on this element
1098-9333: A supply act **SHALL** contain one product/Medication Information *OR* one product/Immunization Medication Information template (CONF:1098-9333). (: )
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
176. SubstanceAdministration.entryRelationship:medDispense.procedure
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Procedure
177. SubstanceAdministration.entryRelationship:medDispense.encounter
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Encounter
178. SubstanceAdministration.entryRelationship:medDispense.organizer
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organizer
179. SubstanceAdministration.entryRelationship:medDispense.act
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Act
180. SubstanceAdministration.entryRelationship:reactionObs
SliceNamereactionObs
Control0..1
TypeElement
Requirements

MAY contain zero or one [0..1] entryRelationship (CONF:1198-8866) 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)
181. SubstanceAdministration.entryRelationship:reactionObs.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
182. SubstanceAdministration.entryRelationship:reactionObs.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
183. SubstanceAdministration.entryRelationship:reactionObs.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

SHALL contain exactly one [1..1] @typeCode="CAUS" (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:1198-8867).

Pattern ValueCAUS
184. SubstanceAdministration.entryRelationship:reactionObs.inversionInd
Control0..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
185. SubstanceAdministration.entryRelationship:reactionObs.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
186. SubstanceAdministration.entryRelationship:reactionObs.sequenceNumber
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/INT
187. SubstanceAdministration.entryRelationship:reactionObs.negationInd
Control0..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
188. SubstanceAdministration.entryRelationship:reactionObs.seperatableInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
189. SubstanceAdministration.entryRelationship:reactionObs.observation
Definition

Base definition for all types defined in FHIR type system.

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

SHALL contain exactly one [1..1] Reaction Observation (V2) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.9:2014-06-09) (CONF:1198-15541).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
190. SubstanceAdministration.entryRelationship:reactionObs.regionOfInterest
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest
191. SubstanceAdministration.entryRelationship:reactionObs.observationMedia
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ObservationMedia
192. SubstanceAdministration.entryRelationship:reactionObs.substanceAdministration
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration
193. SubstanceAdministration.entryRelationship:reactionObs.supply
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Supply
194. SubstanceAdministration.entryRelationship:reactionObs.procedure
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Procedure
195. SubstanceAdministration.entryRelationship:reactionObs.encounter
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Encounter
196. SubstanceAdministration.entryRelationship:reactionObs.organizer
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organizer
197. SubstanceAdministration.entryRelationship:reactionObs.act
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Act
198. SubstanceAdministration.entryRelationship:immunizationRefusal
SliceNameimmunizationRefusal
Control0..1
TypeElement
Requirements

MAY contain zero or one [0..1] entryRelationship (CONF:1198-8988) 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)
199. SubstanceAdministration.entryRelationship:immunizationRefusal.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
200. SubstanceAdministration.entryRelationship:immunizationRefusal.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
201. SubstanceAdministration.entryRelationship:immunizationRefusal.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" (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:1198-8989).

Pattern ValueRSON
202. SubstanceAdministration.entryRelationship:immunizationRefusal.inversionInd
Control0..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
203. SubstanceAdministration.entryRelationship:immunizationRefusal.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
204. SubstanceAdministration.entryRelationship:immunizationRefusal.sequenceNumber
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/INT
205. SubstanceAdministration.entryRelationship:immunizationRefusal.negationInd
Control0..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
206. SubstanceAdministration.entryRelationship:immunizationRefusal.seperatableInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
207. SubstanceAdministration.entryRelationship:immunizationRefusal.observation
Definition

Base definition for all types defined in FHIR type system.

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

SHALL contain exactly one [1..1] Immunization Refusal Reason (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.53) (CONF:1198-15542).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
208. SubstanceAdministration.entryRelationship:immunizationRefusal.regionOfInterest
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest
209. SubstanceAdministration.entryRelationship:immunizationRefusal.observationMedia
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ObservationMedia
210. SubstanceAdministration.entryRelationship:immunizationRefusal.substanceAdministration
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration
211. SubstanceAdministration.entryRelationship:immunizationRefusal.supply
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Supply
212. SubstanceAdministration.entryRelationship:immunizationRefusal.procedure
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Procedure
213. SubstanceAdministration.entryRelationship:immunizationRefusal.encounter
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Encounter
214. SubstanceAdministration.entryRelationship:immunizationRefusal.organizer
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organizer
215. SubstanceAdministration.entryRelationship:immunizationRefusal.act
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Act
216. SubstanceAdministration.entryRelationship:substanceAdmin
SliceNamesubstanceAdmin
Control0..*
TypeElement
Requirements

SHOULD contain zero or more [0..*] entryRelationship (CONF:1198-31510) 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)
217. SubstanceAdministration.entryRelationship:substanceAdmin.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
218. SubstanceAdministration.entryRelationship:substanceAdmin.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
219. SubstanceAdministration.entryRelationship:substanceAdmin.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

SHALL contain exactly one [1..1] @typeCode="COMP" Component (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1198-31511).

Pattern ValueCOMP
220. SubstanceAdministration.entryRelationship:substanceAdmin.inversionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

SHALL contain exactly one [1..1] @inversionInd="true" (CONF:1198-31512).

Pattern Valuetrue
221. SubstanceAdministration.entryRelationship:substanceAdmin.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
222. SubstanceAdministration.entryRelationship:substanceAdmin.sequenceNumber
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/INT
Requirements

MAY contain zero or one [0..1] sequenceNumber (CONF:1198-31513).

223. SubstanceAdministration.entryRelationship:substanceAdmin.negationInd
Control0..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
224. SubstanceAdministration.entryRelationship:substanceAdmin.seperatableInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
225. SubstanceAdministration.entryRelationship:substanceAdmin.observation
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Observation
226. SubstanceAdministration.entryRelationship:substanceAdmin.regionOfInterest
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest
227. SubstanceAdministration.entryRelationship:substanceAdmin.observationMedia
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ObservationMedia
228. SubstanceAdministration.entryRelationship:substanceAdmin.substanceAdministration
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration
229. SubstanceAdministration.entryRelationship:substanceAdmin.supply
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Supply
230. SubstanceAdministration.entryRelationship:substanceAdmin.procedure
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Procedure
231. SubstanceAdministration.entryRelationship:substanceAdmin.encounter
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Encounter
232. SubstanceAdministration.entryRelationship:substanceAdmin.organizer
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organizer
233. SubstanceAdministration.entryRelationship:substanceAdmin.act
Definition

Base definition for all types defined in FHIR type system.

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

SHALL contain exactly one [1..1] Substance Administered Act (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.118) (CONF:1198-31514).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
234. 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()))
235. 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
236. 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
237. SubstanceAdministration.reference.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
238. SubstanceAdministration.reference.seperatableInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
239. SubstanceAdministration.reference.externalAct
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalAct
240. SubstanceAdministration.reference.externalObservation
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalObservation
241. SubstanceAdministration.reference.externalProcedure
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalProcedure
242. SubstanceAdministration.reference.externalDocument
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalDocument
243. 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
244. SubstanceAdministration.precondition:substanceAdmin
SliceNamesubstanceAdmin
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Precondition
Requirements

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

245. SubstanceAdministration.precondition:substanceAdmin.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.
246. SubstanceAdministration.precondition:substanceAdmin.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" (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:1198-8870).

Pattern ValuePRCN
247. SubstanceAdministration.precondition:substanceAdmin.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
248. SubstanceAdministration.precondition:substanceAdmin.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
249. SubstanceAdministration.precondition:substanceAdmin.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
250. SubstanceAdministration.precondition:substanceAdmin.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:1198-15548).

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