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

Active as of 2023-01-16

Definitions for the 2.16.840.1.113883.10.20.22.4.123 resource profile.

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

1. Act
2. Act.classCode
Requirements

SHALL contain exactly one [1..1] @classCode="ACT" act (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6) (CONF:1098-30823).

Pattern ValueACT
3. Act.moodCode
Requirements

SHALL contain exactly one [1..1] @moodCode="INT" (CONF:1098-28656).

Pattern ValueINT
4. Act.templateId
SlicingThis element introduces a set of slices on Act.templateId. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ root
5. Act.templateId:primary
SliceNameprimary
Control1..1
Requirements

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

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

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

Pattern Value2.16.840.1.113883.10.20.22.4.123
7. Act.id
Control10..*
Requirements

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

8. Act.code
Requirements

SHALL contain exactly one [1..1] code (CONF:1098-28660).

9. Act.code.code
Control1..1
Requirements

This code SHALL contain exactly one [1..1] @code="395170001" medication monitoring (regime/therapy) (CONF:1098-30818).

Pattern Value395170001
10. Act.code.codeSystem
Control1..1
Requirements

This code SHALL contain exactly one [1..1] @codeSystem="2.16.840.1.113883.6.96" (CodeSystem: SNOMED CT urn:oid:2.16.840.1.113883.6.96) (CONF:1098-30819).

Pattern Value2.16.840.1.113883.6.96
11. Act.statusCode
Control10..1
Requirements

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

12. Act.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:1098-32358).

13. Act.effectiveTime
Control10..1
Requirements

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

14. Act.participant
SlicingThis element introduces a set of slices on Act.participant. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ typeCode
15. Act.participant:participant1
SliceNameparticipant1
Control1..*
Requirements

SHALL contain at least one [1..*] participant (CONF:1098-28661) such that it

16. Act.participant:participant1.typeCode
Control1..1
Requirements

SHALL contain exactly one [1..1] @typeCode="RESP" (CONF:1098-28663).

Pattern ValueRESP
17. Act.participant:participant1.participantRole
Control1..1
Requirements

SHALL contain exactly one [1..1] participantRole (CONF:1098-28662).

18. Act.participant:participant1.participantRole.classCode
Control1..1
Requirements

This participantRole SHALL contain exactly one [1..1] @classCode="ASSIGNED" (CONF:1098-28664).

Pattern ValueASSIGNED
19. Act.participant:participant1.participantRole.id
Control1..*
Requirements

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

20. Act.participant:participant1.participantRole.playingEntity
Control1..1
Requirements

This participantRole SHALL contain exactly one [1..1] playingEntity (CONF:1098-28667).

21. Act.participant:participant1.participantRole.playingEntity.classCode
Control1..1
Requirements

This playingEntity SHALL contain exactly one [1..1] @classCode="PSN" (CONF:1098-28668).

Pattern ValuePSN
22. Act.participant:participant1.participantRole.playingEntity.name
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/PN(USRealmPersonNamePNUSFIELDED)
Requirements

This playingEntity SHALL contain exactly one [1..1] US Realm Person Name (PN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1.1) (CONF:1098-28669).

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

1. Act
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. Act.classCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

SHALL contain exactly one [1..1] @classCode="ACT" act (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6) (CONF:1098-30823).

Pattern ValueACT
3. Act.moodCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

SHALL contain exactly one [1..1] @moodCode="INT" (CONF:1098-28656).

Pattern ValueINT
4. Act.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 Act.templateId. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ root
5. Act.templateId:primary
SliceNameprimary
Definition

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

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Requirements

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

6. Act.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.123" (CONF:1098-28658).

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

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

8. Act.code
Control1..1
BindingThe codes SHALL be taken from v3 Code System ActCode; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
Requirements

SHALL contain exactly one [1..1] code (CONF:1098-28660).

9. Act.code.code
Definition

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

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

This code SHALL contain exactly one [1..1] @code="395170001" medication monitoring (regime/therapy) (CONF:1098-30818).

Pattern Value395170001
10. Act.code.codeSystem
Definition

Specifies the code system that defines the code.

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

This code SHALL contain exactly one [1..1] @codeSystem="2.16.840.1.113883.6.96" (CodeSystem: SNOMED CT urn:oid:2.16.840.1.113883.6.96) (CONF:1098-30819).

Pattern Value2.16.840.1.113883.6.96
11. Act.statusCode
Control1..1
BindingThe codes SHALL be taken from ActStatus
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
Requirements

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

12. Act.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:1098-32358).

13. Act.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. Act.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. Act.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. Act.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. Act.statusCode.originalText
Definition

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

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
18. Act.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. Act.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. Act.effectiveTime
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-TS
Requirements

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

21. Act.participant
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Participant2
SlicingThis element introduces a set of slices on Act.participant. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ typeCode
22. Act.participant:participant1
SliceNameparticipant1
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Participant2
Requirements

SHALL contain at least one [1..*] participant (CONF:1098-28661) such that it

23. Act.participant:participant1.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="RESP" (CONF:1098-28663).

Pattern ValueRESP
24. Act.participant:participant1.participantRole
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ParticipantRole
Requirements

SHALL contain exactly one [1..1] participantRole (CONF:1098-28662).

25. Act.participant:participant1.participantRole.classCode
Control1..1
BindingThe codes SHALL be taken from RoleClassRoot
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

This participantRole SHALL contain exactly one [1..1] @classCode="ASSIGNED" (CONF:1098-28664).

Default ValueROL
Pattern ValueASSIGNED
26. Act.participant:participant1.participantRole.id
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Requirements

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

27. Act.participant:participant1.participantRole.playingEntity
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/PlayingEntity
Requirements

This participantRole SHALL contain exactly one [1..1] playingEntity (CONF:1098-28667).

28. Act.participant:participant1.participantRole.playingEntity.classCode
Control1..1
BindingThe codes SHALL be taken from EntityClassRoot
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

This playingEntity SHALL contain exactly one [1..1] @classCode="PSN" (CONF:1098-28668).

Default ValueENT
Pattern ValuePSN
29. Act.participant:participant1.participantRole.playingEntity.determinerCode
Control1..1
BindingThe codes SHALL be taken from EntityDeterminer
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueINSTANCE
Fixed ValueINSTANCE
30. Act.participant:participant1.participantRole.playingEntity.name
Definition

A name for a person. A sequence of name parts, such as given name or family name, prefix, suffix, etc. Examples for person name values are "Jim Bob Walton, Jr.", "Adam Everyman", etc. A person name may be as simple as a character string or may consist of several person name parts, such as, "Jim", "Bob", "Walton", and "Jr.". PN differs from EN because the qualifier type cannot include LS (Legal Status).

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/PN(USRealmPersonNamePNUSFIELDED)
Requirements

This playingEntity SHALL contain exactly one [1..1] US Realm Person Name (PN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1.1) (CONF:1098-28669).

InvariantsDefined on this element
81-9371: The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). (: null)
81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372). (: null)
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. Act
Definition

Base definition for all types defined in FHIR type system.

Control1..1
2. Act.classCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

SHALL contain exactly one [1..1] @classCode="ACT" act (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6) (CONF:1098-30823).

Pattern ValueACT
3. Act.moodCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

SHALL contain exactly one [1..1] @moodCode="INT" (CONF:1098-28656).

Pattern ValueINT
4. Act.realmCode
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
5. Act.typeId
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
6. Act.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 Act.templateId. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ root
7. Act.templateId:primary
SliceNameprimary
Definition

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

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Requirements

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

8. Act.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. Act.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. Act.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. Act.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.123" (CONF:1098-28658).

Pattern Value2.16.840.1.113883.10.20.22.4.123
12. Act.templateId:primary.extension
Definition

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

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
13. Act.id
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Requirements

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

14. Act.code
Control1..1
BindingThe codes SHALL be taken from v3 Code System ActCode; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
Requirements

SHALL contain exactly one [1..1] code (CONF:1098-28660).

15. Act.code.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.
16. Act.code.code
Definition

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

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

This code SHALL contain exactly one [1..1] @code="395170001" medication monitoring (regime/therapy) (CONF:1098-30818).

Pattern Value395170001
17. Act.code.codeSystem
Definition

Specifies the code system that defines the code.

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

This code SHALL contain exactly one [1..1] @codeSystem="2.16.840.1.113883.6.96" (CodeSystem: SNOMED CT urn:oid:2.16.840.1.113883.6.96) (CONF:1098-30819).

Pattern Value2.16.840.1.113883.6.96
18. Act.code.codeSystemName
Definition

The common name of the coding system.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
19. Act.code.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.
20. Act.code.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.
21. Act.code.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.
22. Act.code.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.
23. Act.code.originalText
Definition

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

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
24. Act.code.qualifier
Definition

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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CR
25. Act.code.translation
Definition

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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
XML RepresentationThe type of this property is determined using the xsi:type attribute.
26. Act.negationInd
Control0..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
27. Act.text
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
28. Act.statusCode
Control1..1
BindingThe codes SHALL be taken from ActStatus
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
Requirements

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

29. Act.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.
30. Act.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:1098-32358).

31. Act.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.
32. Act.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.
33. Act.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.
34. Act.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.
35. Act.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.
36. Act.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.
37. Act.statusCode.originalText
Definition

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

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
38. Act.statusCode.qualifier
Definition

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

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/CR
39. Act.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.
40. Act.effectiveTime
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-TS
Requirements

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

41. Act.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
42. Act.languageCode
Control0..1
BindingThe codes SHALL be taken from HumanLanguage
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
43. Act.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()))
44. Act.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
45. Act.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 Act.subject.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
46. Act.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
47. Act.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
48. Act.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
49. Act.subject.relatedSubject
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/RelatedSubject
50. Act.specimen
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Specimen
51. Act.performer
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Performer2
52. Act.author
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Author
53. Act.informant
Control0..*
TypeElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
54. Act.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
55. Act.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 Act.informant.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
56. Act.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
57. Act.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
58. Act.informant.assignedEntity
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/AssignedEntity
59. Act.informant.relatedEntity
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/RelatedEntity
60. Act.participant
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Participant2
SlicingThis element introduces a set of slices on Act.participant. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ typeCode
61. Act.participant:participant1
SliceNameparticipant1
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Participant2
Requirements

SHALL contain at least one [1..*] participant (CONF:1098-28661) such that it

62. Act.participant:participant1.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.
63. Act.participant:participant1.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="RESP" (CONF:1098-28663).

Pattern ValueRESP
64. Act.participant:participant1.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
65. Act.participant:participant1.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
66. Act.participant:participant1.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
67. Act.participant:participant1.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
68. Act.participant:participant1.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.
69. Act.participant:participant1.time
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-TS
70. Act.participant:participant1.awarenessCode
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
71. Act.participant:participant1.participantRole
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ParticipantRole
Requirements

SHALL contain exactly one [1..1] participantRole (CONF:1098-28662).

72. Act.participant:participant1.participantRole.classCode
Control1..1
BindingThe codes SHALL be taken from RoleClassRoot
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

This participantRole SHALL contain exactly one [1..1] @classCode="ASSIGNED" (CONF:1098-28664).

Default ValueROL
Pattern ValueASSIGNED
73. Act.participant:participant1.participantRole.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
74. Act.participant:participant1.participantRole.id
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Requirements

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

75. Act.participant:participant1.participantRole.sdtcIdentifiedBy
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/IdentifiedBy
XML RepresentationIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name identifiedBy.
76. Act.participant:participant1.participantRole.code
Control0..1
BindingThe codes SHALL be taken from v3 Code System RoleCode; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
77. Act.participant:participant1.participantRole.addr
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/AD
78. Act.participant:participant1.participantRole.telecom
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
79. Act.participant:participant1.participantRole.playingDevice
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Device
80. Act.participant:participant1.participantRole.playingEntity
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/PlayingEntity
Requirements

This participantRole SHALL contain exactly one [1..1] playingEntity (CONF:1098-28667).

81. Act.participant:participant1.participantRole.playingEntity.classCode
Control1..1
BindingThe codes SHALL be taken from EntityClassRoot
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

This playingEntity SHALL contain exactly one [1..1] @classCode="PSN" (CONF:1098-28668).

Default ValueENT
Pattern ValuePSN
82. Act.participant:participant1.participantRole.playingEntity.determinerCode
Control1..1
BindingThe codes SHALL be taken from EntityDeterminer
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueINSTANCE
Fixed ValueINSTANCE
83. Act.participant:participant1.participantRole.playingEntity.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
84. Act.participant:participant1.participantRole.playingEntity.code
Control0..1
BindingThe codes SHALL be taken from EntityCode; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
85. Act.participant:participant1.participantRole.playingEntity.quantity
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/PQ
86. Act.participant:participant1.participantRole.playingEntity.name
Definition

A name for a person. A sequence of name parts, such as given name or family name, prefix, suffix, etc. Examples for person name values are "Jim Bob Walton, Jr.", "Adam Everyman", etc. A person name may be as simple as a character string or may consist of several person name parts, such as, "Jim", "Bob", "Walton", and "Jr.". PN differs from EN because the qualifier type cannot include LS (Legal Status).

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/PN(USRealmPersonNamePNUSFIELDED)
Requirements

This playingEntity SHALL contain exactly one [1..1] US Realm Person Name (PN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1.1) (CONF:1098-28669).

InvariantsDefined on this element
81-9371: The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). (: )
81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372). (: )
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
87. Act.participant:participant1.participantRole.playingEntity.desc
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
88. Act.participant:participant1.participantRole.scopingEntity
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Entity
89. Act.entryRelationship
Control0..*
TypeElement
InvariantsDefined on this element
act-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)
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
90. Act.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
91. Act.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 Act.entryRelationship.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
92. Act.entryRelationship.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
93. Act.entryRelationship.inversionInd
Control0..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
94. Act.entryRelationship.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
95. Act.entryRelationship.sequenceNumber
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/INT
96. Act.entryRelationship.negationInd
Control0..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
97. Act.entryRelationship.seperatableInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
98. Act.entryRelationship.observation
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Observation
99. Act.entryRelationship.regionOfInterest
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest
100. Act.entryRelationship.observationMedia
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ObservationMedia
101. Act.entryRelationship.substanceAdministration
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration
102. Act.entryRelationship.supply
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Supply
103. Act.entryRelationship.procedure
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Procedure
104. Act.entryRelationship.encounter
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Encounter
105. Act.entryRelationship.organizer
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organizer
106. Act.entryRelationship.act
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Act
107. Act.reference
Control0..*
TypeElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
108. Act.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
109. Act.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 Act.reference.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
110. Act.reference.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
111. Act.reference.seperatableInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
112. Act.reference.externalAct
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalAct
113. Act.reference.externalObservation
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalObservation
114. Act.reference.externalProcedure
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalProcedure
115. Act.reference.externalDocument
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalDocument
116. Act.precondition
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Precondition