Consolidated CDA Release 2.2
2.2 - CI Build
Unknown state code 'US'
Consolidated CDA Release 2.2
2.2 - CI Build
Unknown state code 'US'
Consolidated CDA Release 2.2 - Local Development build (v2.2). See the Directory of published versions
| Active as of 2023-05-30 |
Definitions for the 2.16.840.1.113883.10.20.22.4.16 resource profile.
Guidance on how to interpret the contents of this table can be found here.
| 1. SubstanceAdministration |
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. |
| Control | 10..1* |
| 2. SubstanceAdministration.classCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ActClass |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | SBADM |
| Fixed Value | SBADM |
| 3. SubstanceAdministration.moodCode | |
| Control | 1..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 4. SubstanceAdministration.consumable | |
| Control | 1..1 |
| Type | Element |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 5. SubstanceAdministration.consumable.typeCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ParticipationTargetDirect |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | CSM |
| Fixed Value | CSM |
| 6. SubstanceAdministration.consumable.manufacturedProduct | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ManufacturedProduct |
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. |
| Control | 1..1 |
| 2. SubstanceAdministration.classCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ActClass |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | SBADM |
| Fixed Value | SBADM |
| 3. SubstanceAdministration.moodCode | |
| Control | 1..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 4. SubstanceAdministration.realmCode | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CS |
| 5. SubstanceAdministration.typeId | |
| Control | 0..1 |
| Type | http://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 |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| 7. SubstanceAdministration.id | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| 8. SubstanceAdministration.code | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from ActSubstanceAdministrationCode; other codes may be used where these codes are not suitable |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CD |
| 9. SubstanceAdministration.negationInd | |
| Control | 0..1 |
| Type | boolean |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 10. SubstanceAdministration.text | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ED |
| 11. SubstanceAdministration.statusCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from ActStatus |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CS |
| 12. SubstanceAdministration.effectiveTime | |
| Control | 0..* |
| Type | Choice 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 Type | http://hl7.org/fhir/cda/StructureDefinition/SXCM-TS |
| XML Representation | The type of this property is determined using the xsi:type attribute. |
| 13. SubstanceAdministration.priorityCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from ActPriority; other codes may be used where these codes are not suitable |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| 14. SubstanceAdministration.repeatNumber | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/IVL-INT |
| 15. SubstanceAdministration.routeCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from RouteOfAdministration; other codes may be used where these codes are not suitable |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| 16. SubstanceAdministration.approachSiteCode | |
| Control | 0..* |
| Binding | The codes SHALL be taken from v3 Code System ActSite; other codes may be used where these codes are not suitable |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CD |
| 17. SubstanceAdministration.doseQuantity | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/IVL-PQ |
| 18. SubstanceAdministration.rateQuantity | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/IVL-PQ |
| 19. SubstanceAdministration.maxDoseQuantity | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/RTO-PQ-PQ |
| 20. SubstanceAdministration.administrationUnitCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from AdministrableDrugForm; other codes may be used where these codes are not suitable |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| 21. SubstanceAdministration.consumable | |
| Control | 1..1 |
| Type | Element |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 22. 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. |
| Control | 0..1 |
| Type | id |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 23. 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. |
| Control | 0..* |
| Type | Extension |
| Summary | false |
| Alternate Names | extensions, 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. |
| Invariants | Defined 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()) |
| Slicing | This element introduces a set of slices on SubstanceAdministration.consumable.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 24. SubstanceAdministration.consumable.typeCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ParticipationTargetDirect |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | CSM |
| Fixed Value | CSM |
| 25. SubstanceAdministration.consumable.manufacturedProduct | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ManufacturedProduct |
| 26. SubstanceAdministration.subject | |
| Control | 0..1 |
| Type | Element |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 27. 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. |
| Control | 0..1 |
| Type | id |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 28. 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. |
| Control | 0..* |
| Type | Extension |
| Summary | false |
| Alternate Names | extensions, 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. |
| Invariants | Defined 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()) |
| Slicing | This element introduces a set of slices on SubstanceAdministration.subject.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 29. SubstanceAdministration.subject.typeCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ParticipationTargetSubject |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | SBJ |
| Fixed Value | SBJ |
| 30. SubstanceAdministration.subject.contextControlCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ContextControl |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | OP |
| Fixed Value | OP |
| 31. SubstanceAdministration.subject.awarenessCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from TargetAwareness; other codes may be used where these codes are not suitable |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| 32. SubstanceAdministration.subject.relatedSubject | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/RelatedSubject |
| 33. SubstanceAdministration.specimen | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Specimen |
| 34. SubstanceAdministration.performer | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Performer2 |
| 35. SubstanceAdministration.author | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Author |
| 36. SubstanceAdministration.informant | |
| Control | 0..* |
| Type | Element |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 37. 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. |
| Control | 0..1 |
| Type | id |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 38. 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. |
| Control | 0..* |
| Type | Extension |
| Summary | false |
| Alternate Names | extensions, 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. |
| Invariants | Defined 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()) |
| Slicing | This element introduces a set of slices on SubstanceAdministration.informant.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 39. SubstanceAdministration.informant.typeCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ParticipationInformationGenerator |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | INF |
| Fixed Value | INF |
| 40. SubstanceAdministration.informant.contextControlCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ContextControl |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | OP |
| Fixed Value | OP |
| 41. SubstanceAdministration.informant.assignedEntity | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/AssignedEntity |
| 42. SubstanceAdministration.informant.relatedEntity | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/RelatedEntity |
| 43. SubstanceAdministration.participant | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Participant2 |
| 44. SubstanceAdministration.entryRelationship | |
| Control | 0..* |
| Type | Element |
| Invariants | Defined 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) |
| 45. 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. |
| Control | 0..1 |
| Type | id |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 46. 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. |
| Control | 0..* |
| Type | Extension |
| Summary | false |
| Alternate Names | extensions, 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. |
| Invariants | Defined 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()) |
| Slicing | This element introduces a set of slices on SubstanceAdministration.entryRelationship.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 47. SubstanceAdministration.entryRelationship.typeCode | |
| Control | 1..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 48. SubstanceAdministration.entryRelationship.inversionInd | |
| Control | 0..1 |
| Type | boolean |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 49. SubstanceAdministration.entryRelationship.contextConductionInd | |
| Control | 1..1 |
| Type | boolean |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | true |
| 50. SubstanceAdministration.entryRelationship.sequenceNumber | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/INT |
| 51. SubstanceAdministration.entryRelationship.negationInd | |
| Control | 0..1 |
| Type | boolean |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 52. SubstanceAdministration.entryRelationship.seperatableInd | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/BL |
| 53. SubstanceAdministration.entryRelationship.observation | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Observation |
| 54. SubstanceAdministration.entryRelationship.regionOfInterest | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest |
| 55. SubstanceAdministration.entryRelationship.observationMedia | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ObservationMedia |
| 56. SubstanceAdministration.entryRelationship.substanceAdministration | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration |
| 57. SubstanceAdministration.entryRelationship.supply | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Supply |
| 58. SubstanceAdministration.entryRelationship.procedure | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Procedure |
| 59. SubstanceAdministration.entryRelationship.encounter | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Encounter |
| 60. SubstanceAdministration.entryRelationship.organizer | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Organizer |
| 61. SubstanceAdministration.entryRelationship.act | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Act |
| 62. SubstanceAdministration.reference | |
| Control | 0..* |
| Type | Element |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 63. 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. |
| Control | 0..1 |
| Type | id |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 64. 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. |
| Control | 0..* |
| Type | Extension |
| Summary | false |
| Alternate Names | extensions, 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. |
| Invariants | Defined 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()) |
| Slicing | This element introduces a set of slices on SubstanceAdministration.reference.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 65. SubstanceAdministration.reference.typeCode | |
| Control | 1..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 66. SubstanceAdministration.reference.seperatableInd | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/BL |
| 67. SubstanceAdministration.reference.externalAct | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ExternalAct |
| 68. SubstanceAdministration.reference.externalObservation | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ExternalObservation |
| 69. SubstanceAdministration.reference.externalProcedure | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ExternalProcedure |
| 70. SubstanceAdministration.reference.externalDocument | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ExternalDocument |
| 71. SubstanceAdministration.precondition | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Precondition |
IG © 2019+ Health Level Seven. Package hl7.cda.us.ccdar2dot2#2.2 based on FHIR 4.0.1. Generated 2023-05-30
Links: Table of Contents |
QA Report
| Version History 
|
|
Propose a change