Consolidated CDA Release 2.1 StructureDefinition Publication, published by Health Level Seven. This is not an authorized publication; it is the continuous build for version 2.1). This version is based on the current content of https://github.com/HL7/CDA-ccda-2.1-sd/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/PolicyActivity | Version: 2.1 | |||
Draft as of 2023-09-29 | Computable Name: PolicyActivity | |||
Other Identifiers: id: urn:hl7ii:2.16.840.1.113883.10.20.22.4.61:2023-05-01 |
A policy activity represents the policy or program providing the coverage. The person for whom payment is being provided (i.e., the patient) is the covered party. The subscriber of the policy or program is represented as a participant that is the holder of the coverage. The payer is represented as the performer of the policy activity.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from CDAR2.Act
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Act | CDAR2.Act | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, @classCode, @moodCode, realmCode, typeId, templateId, id, code, @negationInd, text, statusCode, effectiveTime, priorityCode, languageCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition | ||
classCode | 1..1 | cs | Fixed Value: ACT | |
moodCode | 1..1 | cs | Fixed Value: EVN | |
Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
templateId:templateId1 | 1..1 | II | templateId | |
root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.61 | |
extension | 1..1 | st | Required Pattern: 2023-05-01 | |
id | 1..* | II | ||
code | 1..1 | CD | ||
codeSystem | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.6.255.1336 | |
Slices for translation | 1..* | CD | Slice: Unordered, Open by value:code | |
translation:translation1 | 1..* | CD | translation | |
code | 0..1 | cs | Binding: Payer (preferred) | |
statusCode | 1..1 | CS | ||
code | 1..1 | cs | Fixed Value: completed | |
Slices for performer | 1..* | Performer2 | Slice: Unordered, Open by value:templateId, value:assignedEntity, value:typeCode | |
performer:performer1 | 1..1 | Performer2 | performer | |
typeCode | 1..1 | cs | ||
templateId | 1..1 | II | ||
root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.87 | |
extension | 0..0 | |||
assignedEntity | 1..1 | AssignedEntity | ||
id | 1..* | II | ||
code | 0..1 | CE | ||
code | 1..1 | cs | Binding: Financially Responsible Party Type Value Set (preferred) | |
addr | 0..1 | USRealmAddressADUSFIELDED | Base for all types and resources | |
telecom | 0..* | TEL | ||
representedOrganization | 0..1 | Organization | ||
name | 0..1 | ON | ||
performer:performer2 | 0..* | Performer2 | performer | |
typeCode | 1..1 | cs | ||
templateId | 1..1 | II | ||
root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.88 | |
extension | 0..0 | |||
time | 0..1 | IVL_TS | ||
assignedEntity | C | 1..1 | AssignedEntity | 4537-8967: **SHOULD** include assignedEntity/assignedPerson/name AND/OR assignedEntity/representedOrganization/name (CONF:4537-8967). |
code | 1..1 | CE | ||
code | 1..1 | cs | Required Pattern: GUAR | |
codeSystem | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.5.110 | |
addr | 0..1 | USRealmAddressADUSFIELDED | Base for all types and resources | |
telecom | 0..* | TEL | ||
Slices for participant | 1..* | Participant2 | Slice: Unordered, Open by value:templateId, value:participantRole, value:typeCode | |
participant:participant1 | 1..1 | Participant2 | participant | |
typeCode | 1..1 | cs | Fixed Value: COV | |
templateId | 1..1 | II | ||
root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.89 | |
extension | 0..0 | |||
time | 0..1 | IVL_TS | ||
low | 0..1 | IVXB_TS | ||
high | 0..1 | IVXB_TS | ||
participantRole | 1..1 | ParticipantRole | ||
id | C | 1..* | II | 4537-8984: This id is a unique identifier for the covered party member. Implementers **SHOULD** use the same GUID for each instance of a member identifier from the same health plan (CONF:4537-8984). |
code | 1..1 | CE | ||
code | 0..1 | cs | Binding: Coverage Role Type Value Set (preferred) | |
addr | 0..1 | USRealmAddressADUSFIELDED | Base for all types and resources | |
playingEntity | 0..1 | PlayingEntity | ||
name | 1..1 | PN | ||
sdtcBirthTime | C | 1..1 | TS | sdtc:birthTime 4537-31345: The prefix sdtc: **SHALL** be bound to the namespace “urn:hl7-org:sdtc”. The use of the namespace provides a necessary extension to CDA R2 for the use of the birthTime element (CONF:4537-31345). |
participant:participant2 | C | 0..1 | Participant2 | participant 4537-17139: When the Subscriber is the patient, the participant element describing the subscriber **SHALL NOT** be present. This information will be recorded instead in the data elements used to record member information (CONF:4537-17139). |
typeCode | 1..1 | cs | Fixed Value: HLD | |
templateId | 1..1 | II | ||
root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.90 | |
extension | 0..0 | |||
time | 0..1 | IVL_TS | ||
participantRole | 1..1 | ParticipantRole | ||
id | C | 1..* | II | 4537-10120: This id is a unique identifier for the subscriber of the coverage (CONF:4537-10120). |
addr | 0..1 | USRealmAddressADUSFIELDED | Base for all types and resources | |
Slices for entryRelationship | 0..* | EntryRelationship | Slice: Unordered, Open by value:typeCode | |
entryRelationship:entryRelationship1 | C | 0..* | EntryRelationship | entryRelationship 4537-8942: The target of a policy activity with act/entryRelationship/@typeCode="REFR" **SHALL** be an authorization activity (templateId 2.16.840.1.113883.10.20.1.19) *OR* an act, with act[@classCode="ACT"] and act[@moodCode="DEF"], representing a description of the coverage plan (CONF:4537-8942). 4537-8943: A description of the coverage plan **SHALL** contain one or more act/id, to represent the plan identifier, and an act/text with the name of the plan (CONF:4537-8943). |
typeCode | 1..1 | cs | Fixed Value: REFR | |
Documentation for this format |
Path | Conformance | ValueSet |
Act.code.translation:translation1.code | preferred | Payer |
Act.performer:performer1.assignedEntity.code.code | preferred | Financially Responsible Party Type Value Set |
Act.participant:participant1.participantRole.code.code | preferred | Coverage Role Type Value Set |
Id | Grade | Path(s) | Details | Requirements |
4537-8942 | warning | Act.entryRelationship:entryRelationship1 | The target of a policy activity with act/entryRelationship/@typeCode="REFR" **SHALL** be an authorization activity (templateId 2.16.840.1.113883.10.20.1.19) *OR* an act, with act[@classCode="ACT"] and act[@moodCode="DEF"], representing a description of the coverage plan (CONF:4537-8942). : | |
4537-8943 | warning | Act.entryRelationship:entryRelationship1 | A description of the coverage plan **SHALL** contain one or more act/id, to represent the plan identifier, and an act/text with the name of the plan (CONF:4537-8943). : | |
4537-8967 | warning | Act.performer:performer2.assignedEntity | **SHOULD** include assignedEntity/assignedPerson/name AND/OR assignedEntity/representedOrganization/name (CONF:4537-8967). : | |
4537-8984 | warning | Act.participant:participant1.participantRole.id | This id is a unique identifier for the covered party member. Implementers **SHOULD** use the same GUID for each instance of a member identifier from the same health plan (CONF:4537-8984). : | |
4537-10120 | warning | Act.participant:participant2.participantRole.id | This id is a unique identifier for the subscriber of the coverage (CONF:4537-10120). : | |
4537-17139 | warning | Act.participant:participant2 | When the Subscriber is the patient, the participant element describing the subscriber **SHALL NOT** be present. This information will be recorded instead in the data elements used to record member information (CONF:4537-17139). : | |
4537-31345 | error | Act.participant:participant1.participantRole.playingEntity.sdtcBirthTime | The prefix sdtc: **SHALL** be bound to the namespace “urn:hl7-org:sdtc”. The use of the namespace provides a necessary extension to CDA R2 for the use of the birthTime element (CONF:4537-31345). : |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Act | 1..1 | CDAR2.Act | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, @classCode, @moodCode, realmCode, typeId, templateId, id, code, @negationInd, text, statusCode, effectiveTime, priorityCode, languageCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition Base for all types and resources | |
@classCode | 1..1 | cs | Fixed Value: ACT | |
@moodCode | 1..1 | cs | Fixed Value: EVN | |
Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
templateId:templateId1 | 1..1 | II | templateId | |
@root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.61 | |
@extension | 1..1 | st | Required Pattern: 2023-05-01 | |
id | 1..* | II | ||
code | 1..1 | CD | Binding: v3 Code System ActCode (extensible) | |
@codeSystem | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.6.255.1336 | |
Slices for translation | 1..* | CD | Slice: Unordered, Open by value:code | |
translation:translation1 | 1..* | CD | translation | |
@code | 0..1 | cs | Binding: Payer (preferred) | |
statusCode | 1..1 | CS | Binding: ActStatus (required) | |
@code | 1..1 | cs | Fixed Value: completed | |
Slices for performer | 1..* | Performer2 | Slice: Unordered, Open by value:templateId, value:assignedEntity, value:typeCode | |
performer:performer1 | 1..1 | Performer2 | performer | |
@typeCode | 1..1 | cs | Binding: ParticipationPhysicalPerformer (required) Fixed Value: PRF | |
templateId | 1..1 | II | ||
@root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.87 | |
assignedEntity | 1..1 | AssignedEntity | ||
id | 1..* | II | ||
code | 0..1 | CE | Binding: v3 Code System RoleCode (extensible) | |
@code | 1..1 | cs | Binding: Financially Responsible Party Type Value Set (preferred) | |
addr | C | 0..1 | USRealmAddressADUSFIELDED | Base for all types and resources |
telecom | 0..* | TEL | ||
representedOrganization | 0..1 | Organization | ||
name | 0..1 | ON | ||
performer:performer2 | 0..* | Performer2 | performer | |
@typeCode | 1..1 | cs | Binding: ParticipationPhysicalPerformer (required) Fixed Value: PRF | |
templateId | 1..1 | II | ||
@root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.88 | |
time | 0..1 | IVL_TS | ||
assignedEntity | C | 1..1 | AssignedEntity | 4537-8967: **SHOULD** include assignedEntity/assignedPerson/name AND/OR assignedEntity/representedOrganization/name (CONF:4537-8967). |
id | 1..* | II | ||
code | 1..1 | CE | Binding: v3 Code System RoleCode (extensible) | |
@code | 1..1 | cs | Required Pattern: GUAR | |
@codeSystem | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.5.110 | |
addr | C | 0..1 | USRealmAddressADUSFIELDED | Base for all types and resources |
telecom | 0..* | TEL | ||
Slices for participant | 1..* | Participant2 | Slice: Unordered, Open by value:templateId, value:participantRole, value:typeCode | |
participant:participant1 | 1..1 | Participant2 | participant | |
@typeCode | 1..1 | cs | Binding: ParticipationType (required) Fixed Value: COV | |
templateId | 1..1 | II | ||
@root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.89 | |
time | 0..1 | IVL_TS | ||
low | 0..1 | IVXB_TS | ||
high | 0..1 | IVXB_TS | ||
participantRole | 1..1 | ParticipantRole | ||
@classCode | 1..1 | cs | Binding: RoleClassRoot (required) | |
id | C | 1..* | II | 4537-8984: This id is a unique identifier for the covered party member. Implementers **SHOULD** use the same GUID for each instance of a member identifier from the same health plan (CONF:4537-8984). |
code | 1..1 | CE | Binding: v3 Code System RoleCode (extensible) | |
@code | 0..1 | cs | Binding: Coverage Role Type Value Set (preferred) | |
addr | C | 0..1 | USRealmAddressADUSFIELDED | Base for all types and resources |
playingEntity | 0..1 | PlayingEntity | ||
@classCode | 1..1 | cs | Binding: EntityClassRoot (required) | |
name | 1..1 | PN | ||
sdtcBirthTime | C | 1..1 | TS | XML Namespace: urn:hl7-org:sdtc sdtc:birthTime XML: birthTime (urn:hl7-org:sdtc) 4537-31345: The prefix sdtc: **SHALL** be bound to the namespace “urn:hl7-org:sdtc”. The use of the namespace provides a necessary extension to CDA R2 for the use of the birthTime element (CONF:4537-31345). |
participant:participant2 | C | 0..1 | Participant2 | participant 4537-17139: When the Subscriber is the patient, the participant element describing the subscriber **SHALL NOT** be present. This information will be recorded instead in the data elements used to record member information (CONF:4537-17139). |
@typeCode | 1..1 | cs | Binding: ParticipationType (required) Fixed Value: HLD | |
templateId | 1..1 | II | ||
@root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.90 | |
time | 0..1 | IVL_TS | ||
participantRole | 1..1 | ParticipantRole | ||
@classCode | 1..1 | cs | Binding: RoleClassRoot (required) | |
id | C | 1..* | II | 4537-10120: This id is a unique identifier for the subscriber of the coverage (CONF:4537-10120). |
addr | C | 0..1 | USRealmAddressADUSFIELDED | Base for all types and resources |
Slices for entryRelationship | 0..* | EntryRelationship | Slice: Unordered, Open by value:typeCode | |
entryRelationship:entryRelationship1 | C | 0..* | EntryRelationship | entryRelationship 4537-8942: The target of a policy activity with act/entryRelationship/@typeCode="REFR" **SHALL** be an authorization activity (templateId 2.16.840.1.113883.10.20.1.19) *OR* an act, with act[@classCode="ACT"] and act[@moodCode="DEF"], representing a description of the coverage plan (CONF:4537-8942). 4537-8943: A description of the coverage plan **SHALL** contain one or more act/id, to represent the plan identifier, and an act/text with the name of the plan (CONF:4537-8943). |
@typeCode | 1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: REFR | |
Documentation for this format |
Path | Conformance | ValueSet / Code |
Act.code | extensible | ActCode |
Act.code.translation:translation1.code | preferred | Payer |
Act.statusCode | required | ActStatus |
Act.performer:performer1.typeCode | required | Fixed Value: PRF |
Act.performer:performer1.assignedEntity.code | extensible | RoleCode |
Act.performer:performer1.assignedEntity.code.code | preferred | Financially Responsible Party Type Value Set |
Act.performer:performer2.typeCode | required | Fixed Value: PRF |
Act.performer:performer2.assignedEntity.code | extensible | RoleCode |
Act.participant:participant1.typeCode | required | Fixed Value: COV |
Act.participant:participant1.participantRole.classCode | required | RoleClassRoot |
Act.participant:participant1.participantRole.code | extensible | RoleCode |
Act.participant:participant1.participantRole.code.code | preferred | Coverage Role Type Value Set |
Act.participant:participant1.participantRole.playingEntity.classCode | required | EntityClassRoot |
Act.participant:participant2.typeCode | required | Fixed Value: HLD |
Act.participant:participant2.participantRole.classCode | required | RoleClassRoot |
Act.entryRelationship:entryRelationship1.typeCode | required | Fixed Value: REFR |
Id | Grade | Path(s) | Details | Requirements |
4537-8942 | warning | Act.entryRelationship:entryRelationship1 | The target of a policy activity with act/entryRelationship/@typeCode="REFR" **SHALL** be an authorization activity (templateId 2.16.840.1.113883.10.20.1.19) *OR* an act, with act[@classCode="ACT"] and act[@moodCode="DEF"], representing a description of the coverage plan (CONF:4537-8942). : | |
4537-8943 | warning | Act.entryRelationship:entryRelationship1 | A description of the coverage plan **SHALL** contain one or more act/id, to represent the plan identifier, and an act/text with the name of the plan (CONF:4537-8943). : | |
4537-8967 | warning | Act.performer:performer2.assignedEntity | **SHOULD** include assignedEntity/assignedPerson/name AND/OR assignedEntity/representedOrganization/name (CONF:4537-8967). : | |
4537-8984 | warning | Act.participant:participant1.participantRole.id | This id is a unique identifier for the covered party member. Implementers **SHOULD** use the same GUID for each instance of a member identifier from the same health plan (CONF:4537-8984). : | |
4537-10120 | warning | Act.participant:participant2.participantRole.id | This id is a unique identifier for the subscriber of the coverage (CONF:4537-10120). : | |
4537-17139 | warning | Act.participant:participant2 | When the Subscriber is the patient, the participant element describing the subscriber **SHALL NOT** be present. This information will be recorded instead in the data elements used to record member information (CONF:4537-17139). : | |
4537-31345 | error | Act.participant:participant1.participantRole.playingEntity.sdtcBirthTime | The prefix sdtc: **SHALL** be bound to the namespace “urn:hl7-org:sdtc”. The use of the namespace provides a necessary extension to CDA R2 for the use of the birthTime element (CONF:4537-31345). : | |
81-7296 | error | Act.performer:performer1.assignedEntity.addr, Act.performer:performer2.assignedEntity.addr, Act.participant:participant1.participantRole.addr, Act.participant:participant2.participantRole.addr | **SHALL NOT** have mixed content except for white space (CONF:81-7296). : | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Act | 1..1 | CDAR2.Act | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, @classCode, @moodCode, realmCode, typeId, templateId, id, code, @negationInd, text, statusCode, effectiveTime, priorityCode, languageCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition Base for all types and resources | |
@nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
@classCode | 1..1 | cs | Fixed Value: ACT | |
@moodCode | 1..1 | cs | Fixed Value: EVN | |
realmCode | 0..* | CS | ||
typeId | 0..1 | II | ||
Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
templateId:templateId1 | 1..1 | II | templateId | |
@nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
@assigningAuthorityName | 0..1 | st | ||
@displayable | 0..1 | bl | ||
@root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.61 | |
@extension | 1..1 | st | Required Pattern: 2023-05-01 | |
id | 1..* | II | ||
code | 1..1 | CD | Binding: v3 Code System ActCode (extensible) | |
@nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
@code | 0..1 | cs | ||
@codeSystem | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.6.255.1336 | |
@codeSystemName | 0..1 | st | ||
@codeSystemVersion | 0..1 | st | ||
@displayName | 0..1 | st | ||
@sdtcValueSet | 0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc) | |
@sdtcValueSetVersion | 0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc) | |
originalText | 0..1 | ED | ||
qualifier | 0..* | CR | ||
Slices for translation | 1..* | CD | Slice: Unordered, Open by value:code | |
translation:translation1 | 1..* | CD | translation | |
@nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
@code | 0..1 | cs | Binding: Payer (preferred) | |
@codeSystem | 0..1 | oid, uuid, ruid | ||
@codeSystemName | 0..1 | st | ||
@codeSystemVersion | 0..1 | st | ||
@displayName | 0..1 | st | ||
@sdtcValueSet | 0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc) | |
@sdtcValueSetVersion | 0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc) | |
originalText | 0..1 | ED | ||
qualifier | 0..* | CR | ||
translation | 0..* | CD | ||
@negationInd | 0..1 | bl | ||
text | 0..1 | ED | ||
statusCode | 1..1 | CS | Binding: ActStatus (required) | |
@nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
@code | 1..1 | cs | Fixed Value: completed | |
@sdtcValueSet | 0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc) | |
@sdtcValueSetVersion | 0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc) | |
effectiveTime | 0..1 | IVL_TS | ||
priorityCode | 0..1 | CE | Binding: ActPriority (extensible) | |
languageCode | 0..1 | CS | Binding: HumanLanguage (required) | |
subject | 0..1 | Subject | ||
specimen | 0..* | Specimen | ||
Slices for performer | 1..* | Performer2 | Slice: Unordered, Open by value:templateId, value:assignedEntity, value:typeCode | |
performer:performer1 | 1..1 | Performer2 | performer | |
@nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
@typeCode | 1..1 | cs | Binding: ParticipationPhysicalPerformer (required) Fixed Value: PRF | |
realmCode | 0..* | CS | ||
typeId | 0..1 | II | ||
templateId | 1..1 | II | ||
@nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
@assigningAuthorityName | 0..1 | st | ||
@displayable | 0..1 | bl | ||
@root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.87 | |
sdtcFunctionCode | 0..1 | CE | XML Namespace: urn:hl7-org:sdtc XML: functionCode (urn:hl7-org:sdtc) | |
time | 0..1 | IVL_TS | ||
modeCode | 0..1 | CE | ||
assignedEntity | 1..1 | AssignedEntity | ||
@classCode | 0..1 | cs | Binding: RoleClassAssignedEntity (required) Fixed Value: ASSIGNED | |
templateId | 0..* | II | ||
id | 1..* | II | ||
sdtcIdentifiedBy | 0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |
code | 0..1 | CE | Binding: v3 Code System RoleCode (extensible) | |
@nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
@code | 1..1 | cs | Binding: Financially Responsible Party Type Value Set (preferred) | |
@codeSystem | 0..1 | oid, uuid, ruid | ||
@codeSystemName | 0..1 | st | ||
@codeSystemVersion | 0..1 | st | ||
@displayName | 0..1 | st | ||
@sdtcValueSet | 0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc) | |
@sdtcValueSetVersion | 0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc) | |
originalText | 0..1 | ED | ||
translation | 0..* | CD | ||
addr | C | 0..1 | USRealmAddressADUSFIELDED | Base for all types and resources |
telecom | 0..* | TEL | ||
assignedPerson | 0..1 | Person | ||
representedOrganization | 0..1 | Organization | ||
@nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
@classCode | 0..1 | cs | Binding: EntityClassOrganization (required) Fixed Value: ORG | |
@determinerCode | 0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
realmCode | 0..* | CS | ||
typeId | 0..1 | II | ||
templateId | 0..* | II | ||
id | 0..* | II | ||
name | 0..1 | ON | ||
telecom | 0..* | TEL | ||
addr | 0..* | AD | ||
standardIndustryClassCode | 0..1 | CE | Binding: OrganizationIndustryClassNAICS (extensible) | |
asOrganizationPartOf | 0..1 | OrganizationPartOf | ||
performer:performer2 | 0..* | Performer2 | performer | |
@nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
@typeCode | 1..1 | cs | Binding: ParticipationPhysicalPerformer (required) Fixed Value: PRF | |
realmCode | 0..* | CS | ||
typeId | 0..1 | II | ||
templateId | 1..1 | II | ||
@nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
@assigningAuthorityName | 0..1 | st | ||
@displayable | 0..1 | bl | ||
@root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.88 | |
sdtcFunctionCode | 0..1 | CE | XML Namespace: urn:hl7-org:sdtc XML: functionCode (urn:hl7-org:sdtc) | |
time | 0..1 | IVL_TS | ||
modeCode | 0..1 | CE | ||
assignedEntity | C | 1..1 | AssignedEntity | 4537-8967: **SHOULD** include assignedEntity/assignedPerson/name AND/OR assignedEntity/representedOrganization/name (CONF:4537-8967). |
@classCode | 0..1 | cs | Binding: RoleClassAssignedEntity (required) Fixed Value: ASSIGNED | |
templateId | 0..* | II | ||
id | 1..* | II | ||
sdtcIdentifiedBy | 0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |
code | 1..1 | CE | Binding: v3 Code System RoleCode (extensible) | |
@nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
@code | 1..1 | cs | Required Pattern: GUAR | |
@codeSystem | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.5.110 | |
@codeSystemName | 0..1 | st | ||
@codeSystemVersion | 0..1 | st | ||
@displayName | 0..1 | st | ||
@sdtcValueSet | 0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc) | |
@sdtcValueSetVersion | 0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc) | |
originalText | 0..1 | ED | ||
translation | 0..* | CD | ||
addr | C | 0..1 | USRealmAddressADUSFIELDED | Base for all types and resources |
telecom | 0..* | TEL | ||
assignedPerson | 0..1 | Person | ||
representedOrganization | 0..1 | Organization | ||
author | 0..* | Author | ||
informant | 0..* | Informant | ||
Slices for participant | 1..* | Participant2 | Slice: Unordered, Open by value:templateId, value:participantRole, value:typeCode | |
participant:participant1 | 1..1 | Participant2 | participant | |
@nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
@typeCode | 1..1 | cs | Binding: ParticipationType (required) Fixed Value: COV | |
@contextControlCode | 0..1 | cs | Binding: ContextControl (required) Fixed Value: OP | |
realmCode | 0..* | CS | ||
typeId | 0..1 | II | ||
templateId | 1..1 | II | ||
@nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
@assigningAuthorityName | 0..1 | st | ||
@displayable | 0..1 | bl | ||
@root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.89 | |
sdtcFunctionCode | 0..1 | CE | XML Namespace: urn:hl7-org:sdtc XML: functionCode (urn:hl7-org:sdtc) | |
time | 0..1 | IVL_TS | ||
@nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
@value | 0..1 | ts | Date Format: YYYYMMDDHHMMSS.UUUU[+|-ZZzz] | |
@operator | 0..1 | cs | Binding: SetOperator (required) | |
low | 0..1 | IVXB_TS | ||
center | 0..1 | TS | ||
width | 0..1 | PQ | ||
high | 0..1 | IVXB_TS | ||
awarenessCode | 0..1 | CE | ||
participantRole | 1..1 | ParticipantRole | ||
@classCode | 1..1 | cs | Binding: RoleClassRoot (required) | |
templateId | 0..* | II | ||
id | C | 1..* | II | 4537-8984: This id is a unique identifier for the covered party member. Implementers **SHOULD** use the same GUID for each instance of a member identifier from the same health plan (CONF:4537-8984). |
sdtcIdentifiedBy | 0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |
code | 1..1 | CE | Binding: v3 Code System RoleCode (extensible) | |
@nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
@code | 0..1 | cs | Binding: Coverage Role Type Value Set (preferred) | |
@codeSystem | 0..1 | oid, uuid, ruid | ||
@codeSystemName | 0..1 | st | ||
@codeSystemVersion | 0..1 | st | ||
@displayName | 0..1 | st | ||
@sdtcValueSet | 0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc) | |
@sdtcValueSetVersion | 0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc) | |
originalText | 0..1 | ED | ||
translation | 0..* | CD | ||
addr | C | 0..1 | USRealmAddressADUSFIELDED | Base for all types and resources |
telecom | 0..* | TEL | ||
playingDevice | 0..1 | Device | ||
playingEntity | 0..1 | PlayingEntity | ||
@classCode | 1..1 | cs | Binding: EntityClassRoot (required) | |
@determinerCode | 0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
templateId | 0..* | II | ||
code | 0..1 | CE | Binding: EntityCode (extensible) | |
quantity | 0..* | PQ | ||
name | 1..1 | PN | ||
sdtcBirthTime | C | 1..1 | TS | XML Namespace: urn:hl7-org:sdtc sdtc:birthTime XML: birthTime (urn:hl7-org:sdtc) 4537-31345: The prefix sdtc: **SHALL** be bound to the namespace “urn:hl7-org:sdtc”. The use of the namespace provides a necessary extension to CDA R2 for the use of the birthTime element (CONF:4537-31345). |
desc | 0..1 | ED | ||
scopingEntity | 0..1 | Entity | ||
participant:participant2 | C | 0..1 | Participant2 | participant 4537-17139: When the Subscriber is the patient, the participant element describing the subscriber **SHALL NOT** be present. This information will be recorded instead in the data elements used to record member information (CONF:4537-17139). |
@nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
@typeCode | 1..1 | cs | Binding: ParticipationType (required) Fixed Value: HLD | |
@contextControlCode | 0..1 | cs | Binding: ContextControl (required) Fixed Value: OP | |
realmCode | 0..* | CS | ||
typeId | 0..1 | II | ||
templateId | 1..1 | II | ||
@nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
@assigningAuthorityName | 0..1 | st | ||
@displayable | 0..1 | bl | ||
@root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.90 | |
sdtcFunctionCode | 0..1 | CE | XML Namespace: urn:hl7-org:sdtc XML: functionCode (urn:hl7-org:sdtc) | |
time | 0..1 | IVL_TS | ||
awarenessCode | 0..1 | CE | ||
participantRole | 1..1 | ParticipantRole | ||
@classCode | 1..1 | cs | Binding: RoleClassRoot (required) | |
templateId | 0..* | II | ||
id | C | 1..* | II | 4537-10120: This id is a unique identifier for the subscriber of the coverage (CONF:4537-10120). |
sdtcIdentifiedBy | 0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |
code | 0..1 | CE | Binding: v3 Code System RoleCode (extensible) | |
addr | C | 0..1 | USRealmAddressADUSFIELDED | Base for all types and resources |
telecom | 0..* | TEL | ||
playingDevice | 0..1 | Device | ||
playingEntity | 0..1 | PlayingEntity | ||
scopingEntity | 0..1 | Entity | ||
Slices for entryRelationship | 0..* | EntryRelationship | Slice: Unordered, Open by value:typeCode | |
entryRelationship:entryRelationship1 | C | 0..* | EntryRelationship | entryRelationship 4537-8942: The target of a policy activity with act/entryRelationship/@typeCode="REFR" **SHALL** be an authorization activity (templateId 2.16.840.1.113883.10.20.1.19) *OR* an act, with act[@classCode="ACT"] and act[@moodCode="DEF"], representing a description of the coverage plan (CONF:4537-8942). 4537-8943: A description of the coverage plan **SHALL** contain one or more act/id, to represent the plan identifier, and an act/text with the name of the plan (CONF:4537-8943). |
@nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
realmCode | 0..* | CS | ||
typeId | 0..1 | II | ||
templateId | 0..* | II | ||
@typeCode | 1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: REFR | |
@inversionInd | 0..1 | bl | ||
@contextConductionInd | 0..1 | bl | ||
@negationInd | 0..1 | bl | ||
sequenceNumber | 0..1 | INT | ||
seperatableInd | 0..1 | BL | ||
act | 0..1 | Act | ||
encounter | 0..1 | Encounter | ||
observation | 0..1 | Observation | ||
observationMedia | 0..1 | ObservationMedia | ||
organizer | 0..1 | Organizer | ||
procedure | 0..1 | Procedure | ||
regionOfInterest | 0..1 | RegionOfInterest | ||
substanceAdministration | 0..1 | SubstanceAdministration | ||
supply | 0..1 | Supply | ||
reference | 0..* | Reference | ||
precondition | 0..* | Precondition | ||
Documentation for this format |
Path | Conformance | ValueSet / Code |
Act.nullFlavor | required | NullFlavor |
Act.templateId:templateId1.nullFlavor | required | NullFlavor |
Act.code | extensible | ActCode |
Act.code.nullFlavor | required | NullFlavor |
Act.code.translation:translation1.nullFlavor | required | NullFlavor |
Act.code.translation:translation1.code | preferred | Payer |
Act.statusCode | required | ActStatus |
Act.statusCode.nullFlavor | required | NullFlavor |
Act.priorityCode | extensible | ActPriority |
Act.languageCode | required | HumanLanguage (a valid code from http://terminology.hl7.org/CodeSystem/ietf3066 ) |
Act.performer:performer1.nullFlavor | required | NullFlavor |
Act.performer:performer1.typeCode | required | Fixed Value: PRF |
Act.performer:performer1.templateId.nullFlavor | required | NullFlavor |
Act.performer:performer1.assignedEntity.classCode | required | Fixed Value: ASSIGNED |
Act.performer:performer1.assignedEntity.code | extensible | RoleCode |
Act.performer:performer1.assignedEntity.code.nullFlavor | required | NullFlavor |
Act.performer:performer1.assignedEntity.code.code | preferred | Financially Responsible Party Type Value Set |
Act.performer:performer1.assignedEntity.representedOrganization.nullFlavor | required | NullFlavor |
Act.performer:performer1.assignedEntity.representedOrganization.classCode | required | Fixed Value: ORG |
Act.performer:performer1.assignedEntity.representedOrganization.determinerCode | required | Fixed Value: INSTANCE |
Act.performer:performer1.assignedEntity.representedOrganization.standardIndustryClassCode | extensible | OrganizationIndustryClassNAICS |
Act.performer:performer2.nullFlavor | required | NullFlavor |
Act.performer:performer2.typeCode | required | Fixed Value: PRF |
Act.performer:performer2.templateId.nullFlavor | required | NullFlavor |
Act.performer:performer2.assignedEntity.classCode | required | Fixed Value: ASSIGNED |
Act.performer:performer2.assignedEntity.code | extensible | RoleCode |
Act.performer:performer2.assignedEntity.code.nullFlavor | required | NullFlavor |
Act.participant:participant1.nullFlavor | required | NullFlavor |
Act.participant:participant1.typeCode | required | Fixed Value: COV |
Act.participant:participant1.contextControlCode | required | Fixed Value: OP |
Act.participant:participant1.templateId.nullFlavor | required | NullFlavor |
Act.participant:participant1.time.nullFlavor | required | NullFlavor |
Act.participant:participant1.time.operator | required | SetOperator |
Act.participant:participant1.participantRole.classCode | required | RoleClassRoot |
Act.participant:participant1.participantRole.code | extensible | RoleCode |
Act.participant:participant1.participantRole.code.nullFlavor | required | NullFlavor |
Act.participant:participant1.participantRole.code.code | preferred | Coverage Role Type Value Set |
Act.participant:participant1.participantRole.playingEntity.classCode | required | EntityClassRoot |
Act.participant:participant1.participantRole.playingEntity.determinerCode | required | Fixed Value: INSTANCE |
Act.participant:participant1.participantRole.playingEntity.code | extensible | EntityCode |
Act.participant:participant2.nullFlavor | required | NullFlavor |
Act.participant:participant2.typeCode | required | Fixed Value: HLD |
Act.participant:participant2.contextControlCode | required | Fixed Value: OP |
Act.participant:participant2.templateId.nullFlavor | required | NullFlavor |
Act.participant:participant2.participantRole.classCode | required | RoleClassRoot |
Act.participant:participant2.participantRole.code | extensible | RoleCode |
Act.entryRelationship:entryRelationship1.nullFlavor | required | NullFlavor |
Act.entryRelationship:entryRelationship1.typeCode | required | Fixed Value: REFR |
Id | Grade | Path(s) | Details | Requirements |
4537-8942 | warning | Act.entryRelationship:entryRelationship1 | The target of a policy activity with act/entryRelationship/@typeCode="REFR" **SHALL** be an authorization activity (templateId 2.16.840.1.113883.10.20.1.19) *OR* an act, with act[@classCode="ACT"] and act[@moodCode="DEF"], representing a description of the coverage plan (CONF:4537-8942). : | |
4537-8943 | warning | Act.entryRelationship:entryRelationship1 | A description of the coverage plan **SHALL** contain one or more act/id, to represent the plan identifier, and an act/text with the name of the plan (CONF:4537-8943). : | |
4537-8967 | warning | Act.performer:performer2.assignedEntity | **SHOULD** include assignedEntity/assignedPerson/name AND/OR assignedEntity/representedOrganization/name (CONF:4537-8967). : | |
4537-8984 | warning | Act.participant:participant1.participantRole.id | This id is a unique identifier for the covered party member. Implementers **SHOULD** use the same GUID for each instance of a member identifier from the same health plan (CONF:4537-8984). : | |
4537-10120 | warning | Act.participant:participant2.participantRole.id | This id is a unique identifier for the subscriber of the coverage (CONF:4537-10120). : | |
4537-17139 | warning | Act.participant:participant2 | When the Subscriber is the patient, the participant element describing the subscriber **SHALL NOT** be present. This information will be recorded instead in the data elements used to record member information (CONF:4537-17139). : | |
4537-31345 | error | Act.participant:participant1.participantRole.playingEntity.sdtcBirthTime | The prefix sdtc: **SHALL** be bound to the namespace “urn:hl7-org:sdtc”. The use of the namespace provides a necessary extension to CDA R2 for the use of the birthTime element (CONF:4537-31345). : | |
81-7296 | error | Act.performer:performer1.assignedEntity.addr, Act.performer:performer2.assignedEntity.addr, Act.participant:participant1.participantRole.addr, Act.participant:participant2.participantRole.addr | **SHALL NOT** have mixed content except for white space (CONF:81-7296). : | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
This structure is derived from CDAR2.Act
Summary
Mandatory: 22 elements (13 nested mandatory elements)
Fixed Value: 6 elements
Prohibited: 4 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from CDAR2.Act
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Act | CDAR2.Act | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, @classCode, @moodCode, realmCode, typeId, templateId, id, code, @negationInd, text, statusCode, effectiveTime, priorityCode, languageCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition | ||
classCode | 1..1 | cs | Fixed Value: ACT | |
moodCode | 1..1 | cs | Fixed Value: EVN | |
Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
templateId:templateId1 | 1..1 | II | templateId | |
root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.61 | |
extension | 1..1 | st | Required Pattern: 2023-05-01 | |
id | 1..* | II | ||
code | 1..1 | CD | ||
codeSystem | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.6.255.1336 | |
Slices for translation | 1..* | CD | Slice: Unordered, Open by value:code | |
translation:translation1 | 1..* | CD | translation | |
code | 0..1 | cs | Binding: Payer (preferred) | |
statusCode | 1..1 | CS | ||
code | 1..1 | cs | Fixed Value: completed | |
Slices for performer | 1..* | Performer2 | Slice: Unordered, Open by value:templateId, value:assignedEntity, value:typeCode | |
performer:performer1 | 1..1 | Performer2 | performer | |
typeCode | 1..1 | cs | ||
templateId | 1..1 | II | ||
root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.87 | |
extension | 0..0 | |||
assignedEntity | 1..1 | AssignedEntity | ||
id | 1..* | II | ||
code | 0..1 | CE | ||
code | 1..1 | cs | Binding: Financially Responsible Party Type Value Set (preferred) | |
addr | 0..1 | USRealmAddressADUSFIELDED | Base for all types and resources | |
telecom | 0..* | TEL | ||
representedOrganization | 0..1 | Organization | ||
name | 0..1 | ON | ||
performer:performer2 | 0..* | Performer2 | performer | |
typeCode | 1..1 | cs | ||
templateId | 1..1 | II | ||
root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.88 | |
extension | 0..0 | |||
time | 0..1 | IVL_TS | ||
assignedEntity | C | 1..1 | AssignedEntity | 4537-8967: **SHOULD** include assignedEntity/assignedPerson/name AND/OR assignedEntity/representedOrganization/name (CONF:4537-8967). |
code | 1..1 | CE | ||
code | 1..1 | cs | Required Pattern: GUAR | |
codeSystem | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.5.110 | |
addr | 0..1 | USRealmAddressADUSFIELDED | Base for all types and resources | |
telecom | 0..* | TEL | ||
Slices for participant | 1..* | Participant2 | Slice: Unordered, Open by value:templateId, value:participantRole, value:typeCode | |
participant:participant1 | 1..1 | Participant2 | participant | |
typeCode | 1..1 | cs | Fixed Value: COV | |
templateId | 1..1 | II | ||
root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.89 | |
extension | 0..0 | |||
time | 0..1 | IVL_TS | ||
low | 0..1 | IVXB_TS | ||
high | 0..1 | IVXB_TS | ||
participantRole | 1..1 | ParticipantRole | ||
id | C | 1..* | II | 4537-8984: This id is a unique identifier for the covered party member. Implementers **SHOULD** use the same GUID for each instance of a member identifier from the same health plan (CONF:4537-8984). |
code | 1..1 | CE | ||
code | 0..1 | cs | Binding: Coverage Role Type Value Set (preferred) | |
addr | 0..1 | USRealmAddressADUSFIELDED | Base for all types and resources | |
playingEntity | 0..1 | PlayingEntity | ||
name | 1..1 | PN | ||
sdtcBirthTime | C | 1..1 | TS | sdtc:birthTime 4537-31345: The prefix sdtc: **SHALL** be bound to the namespace “urn:hl7-org:sdtc”. The use of the namespace provides a necessary extension to CDA R2 for the use of the birthTime element (CONF:4537-31345). |
participant:participant2 | C | 0..1 | Participant2 | participant 4537-17139: When the Subscriber is the patient, the participant element describing the subscriber **SHALL NOT** be present. This information will be recorded instead in the data elements used to record member information (CONF:4537-17139). |
typeCode | 1..1 | cs | Fixed Value: HLD | |
templateId | 1..1 | II | ||
root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.90 | |
extension | 0..0 | |||
time | 0..1 | IVL_TS | ||
participantRole | 1..1 | ParticipantRole | ||
id | C | 1..* | II | 4537-10120: This id is a unique identifier for the subscriber of the coverage (CONF:4537-10120). |
addr | 0..1 | USRealmAddressADUSFIELDED | Base for all types and resources | |
Slices for entryRelationship | 0..* | EntryRelationship | Slice: Unordered, Open by value:typeCode | |
entryRelationship:entryRelationship1 | C | 0..* | EntryRelationship | entryRelationship 4537-8942: The target of a policy activity with act/entryRelationship/@typeCode="REFR" **SHALL** be an authorization activity (templateId 2.16.840.1.113883.10.20.1.19) *OR* an act, with act[@classCode="ACT"] and act[@moodCode="DEF"], representing a description of the coverage plan (CONF:4537-8942). 4537-8943: A description of the coverage plan **SHALL** contain one or more act/id, to represent the plan identifier, and an act/text with the name of the plan (CONF:4537-8943). |
typeCode | 1..1 | cs | Fixed Value: REFR | |
Documentation for this format |
Path | Conformance | ValueSet |
Act.code.translation:translation1.code | preferred | Payer |
Act.performer:performer1.assignedEntity.code.code | preferred | Financially Responsible Party Type Value Set |
Act.participant:participant1.participantRole.code.code | preferred | Coverage Role Type Value Set |
Id | Grade | Path(s) | Details | Requirements |
4537-8942 | warning | Act.entryRelationship:entryRelationship1 | The target of a policy activity with act/entryRelationship/@typeCode="REFR" **SHALL** be an authorization activity (templateId 2.16.840.1.113883.10.20.1.19) *OR* an act, with act[@classCode="ACT"] and act[@moodCode="DEF"], representing a description of the coverage plan (CONF:4537-8942). : | |
4537-8943 | warning | Act.entryRelationship:entryRelationship1 | A description of the coverage plan **SHALL** contain one or more act/id, to represent the plan identifier, and an act/text with the name of the plan (CONF:4537-8943). : | |
4537-8967 | warning | Act.performer:performer2.assignedEntity | **SHOULD** include assignedEntity/assignedPerson/name AND/OR assignedEntity/representedOrganization/name (CONF:4537-8967). : | |
4537-8984 | warning | Act.participant:participant1.participantRole.id | This id is a unique identifier for the covered party member. Implementers **SHOULD** use the same GUID for each instance of a member identifier from the same health plan (CONF:4537-8984). : | |
4537-10120 | warning | Act.participant:participant2.participantRole.id | This id is a unique identifier for the subscriber of the coverage (CONF:4537-10120). : | |
4537-17139 | warning | Act.participant:participant2 | When the Subscriber is the patient, the participant element describing the subscriber **SHALL NOT** be present. This information will be recorded instead in the data elements used to record member information (CONF:4537-17139). : | |
4537-31345 | error | Act.participant:participant1.participantRole.playingEntity.sdtcBirthTime | The prefix sdtc: **SHALL** be bound to the namespace “urn:hl7-org:sdtc”. The use of the namespace provides a necessary extension to CDA R2 for the use of the birthTime element (CONF:4537-31345). : |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Act | 1..1 | CDAR2.Act | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, @classCode, @moodCode, realmCode, typeId, templateId, id, code, @negationInd, text, statusCode, effectiveTime, priorityCode, languageCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition Base for all types and resources | |
@classCode | 1..1 | cs | Fixed Value: ACT | |
@moodCode | 1..1 | cs | Fixed Value: EVN | |
Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
templateId:templateId1 | 1..1 | II | templateId | |
@root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.61 | |
@extension | 1..1 | st | Required Pattern: 2023-05-01 | |
id | 1..* | II | ||
code | 1..1 | CD | Binding: v3 Code System ActCode (extensible) | |
@codeSystem | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.6.255.1336 | |
Slices for translation | 1..* | CD | Slice: Unordered, Open by value:code | |
translation:translation1 | 1..* | CD | translation | |
@code | 0..1 | cs | Binding: Payer (preferred) | |
statusCode | 1..1 | CS | Binding: ActStatus (required) | |
@code | 1..1 | cs | Fixed Value: completed | |
Slices for performer | 1..* | Performer2 | Slice: Unordered, Open by value:templateId, value:assignedEntity, value:typeCode | |
performer:performer1 | 1..1 | Performer2 | performer | |
@typeCode | 1..1 | cs | Binding: ParticipationPhysicalPerformer (required) Fixed Value: PRF | |
templateId | 1..1 | II | ||
@root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.87 | |
assignedEntity | 1..1 | AssignedEntity | ||
id | 1..* | II | ||
code | 0..1 | CE | Binding: v3 Code System RoleCode (extensible) | |
@code | 1..1 | cs | Binding: Financially Responsible Party Type Value Set (preferred) | |
addr | C | 0..1 | USRealmAddressADUSFIELDED | Base for all types and resources |
telecom | 0..* | TEL | ||
representedOrganization | 0..1 | Organization | ||
name | 0..1 | ON | ||
performer:performer2 | 0..* | Performer2 | performer | |
@typeCode | 1..1 | cs | Binding: ParticipationPhysicalPerformer (required) Fixed Value: PRF | |
templateId | 1..1 | II | ||
@root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.88 | |
time | 0..1 | IVL_TS | ||
assignedEntity | C | 1..1 | AssignedEntity | 4537-8967: **SHOULD** include assignedEntity/assignedPerson/name AND/OR assignedEntity/representedOrganization/name (CONF:4537-8967). |
id | 1..* | II | ||
code | 1..1 | CE | Binding: v3 Code System RoleCode (extensible) | |
@code | 1..1 | cs | Required Pattern: GUAR | |
@codeSystem | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.5.110 | |
addr | C | 0..1 | USRealmAddressADUSFIELDED | Base for all types and resources |
telecom | 0..* | TEL | ||
Slices for participant | 1..* | Participant2 | Slice: Unordered, Open by value:templateId, value:participantRole, value:typeCode | |
participant:participant1 | 1..1 | Participant2 | participant | |
@typeCode | 1..1 | cs | Binding: ParticipationType (required) Fixed Value: COV | |
templateId | 1..1 | II | ||
@root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.89 | |
time | 0..1 | IVL_TS | ||
low | 0..1 | IVXB_TS | ||
high | 0..1 | IVXB_TS | ||
participantRole | 1..1 | ParticipantRole | ||
@classCode | 1..1 | cs | Binding: RoleClassRoot (required) | |
id | C | 1..* | II | 4537-8984: This id is a unique identifier for the covered party member. Implementers **SHOULD** use the same GUID for each instance of a member identifier from the same health plan (CONF:4537-8984). |
code | 1..1 | CE | Binding: v3 Code System RoleCode (extensible) | |
@code | 0..1 | cs | Binding: Coverage Role Type Value Set (preferred) | |
addr | C | 0..1 | USRealmAddressADUSFIELDED | Base for all types and resources |
playingEntity | 0..1 | PlayingEntity | ||
@classCode | 1..1 | cs | Binding: EntityClassRoot (required) | |
name | 1..1 | PN | ||
sdtcBirthTime | C | 1..1 | TS | XML Namespace: urn:hl7-org:sdtc sdtc:birthTime XML: birthTime (urn:hl7-org:sdtc) 4537-31345: The prefix sdtc: **SHALL** be bound to the namespace “urn:hl7-org:sdtc”. The use of the namespace provides a necessary extension to CDA R2 for the use of the birthTime element (CONF:4537-31345). |
participant:participant2 | C | 0..1 | Participant2 | participant 4537-17139: When the Subscriber is the patient, the participant element describing the subscriber **SHALL NOT** be present. This information will be recorded instead in the data elements used to record member information (CONF:4537-17139). |
@typeCode | 1..1 | cs | Binding: ParticipationType (required) Fixed Value: HLD | |
templateId | 1..1 | II | ||
@root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.90 | |
time | 0..1 | IVL_TS | ||
participantRole | 1..1 | ParticipantRole | ||
@classCode | 1..1 | cs | Binding: RoleClassRoot (required) | |
id | C | 1..* | II | 4537-10120: This id is a unique identifier for the subscriber of the coverage (CONF:4537-10120). |
addr | C | 0..1 | USRealmAddressADUSFIELDED | Base for all types and resources |
Slices for entryRelationship | 0..* | EntryRelationship | Slice: Unordered, Open by value:typeCode | |
entryRelationship:entryRelationship1 | C | 0..* | EntryRelationship | entryRelationship 4537-8942: The target of a policy activity with act/entryRelationship/@typeCode="REFR" **SHALL** be an authorization activity (templateId 2.16.840.1.113883.10.20.1.19) *OR* an act, with act[@classCode="ACT"] and act[@moodCode="DEF"], representing a description of the coverage plan (CONF:4537-8942). 4537-8943: A description of the coverage plan **SHALL** contain one or more act/id, to represent the plan identifier, and an act/text with the name of the plan (CONF:4537-8943). |
@typeCode | 1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: REFR | |
Documentation for this format |
Path | Conformance | ValueSet / Code |
Act.code | extensible | ActCode |
Act.code.translation:translation1.code | preferred | Payer |
Act.statusCode | required | ActStatus |
Act.performer:performer1.typeCode | required | Fixed Value: PRF |
Act.performer:performer1.assignedEntity.code | extensible | RoleCode |
Act.performer:performer1.assignedEntity.code.code | preferred | Financially Responsible Party Type Value Set |
Act.performer:performer2.typeCode | required | Fixed Value: PRF |
Act.performer:performer2.assignedEntity.code | extensible | RoleCode |
Act.participant:participant1.typeCode | required | Fixed Value: COV |
Act.participant:participant1.participantRole.classCode | required | RoleClassRoot |
Act.participant:participant1.participantRole.code | extensible | RoleCode |
Act.participant:participant1.participantRole.code.code | preferred | Coverage Role Type Value Set |
Act.participant:participant1.participantRole.playingEntity.classCode | required | EntityClassRoot |
Act.participant:participant2.typeCode | required | Fixed Value: HLD |
Act.participant:participant2.participantRole.classCode | required | RoleClassRoot |
Act.entryRelationship:entryRelationship1.typeCode | required | Fixed Value: REFR |
Id | Grade | Path(s) | Details | Requirements |
4537-8942 | warning | Act.entryRelationship:entryRelationship1 | The target of a policy activity with act/entryRelationship/@typeCode="REFR" **SHALL** be an authorization activity (templateId 2.16.840.1.113883.10.20.1.19) *OR* an act, with act[@classCode="ACT"] and act[@moodCode="DEF"], representing a description of the coverage plan (CONF:4537-8942). : | |
4537-8943 | warning | Act.entryRelationship:entryRelationship1 | A description of the coverage plan **SHALL** contain one or more act/id, to represent the plan identifier, and an act/text with the name of the plan (CONF:4537-8943). : | |
4537-8967 | warning | Act.performer:performer2.assignedEntity | **SHOULD** include assignedEntity/assignedPerson/name AND/OR assignedEntity/representedOrganization/name (CONF:4537-8967). : | |
4537-8984 | warning | Act.participant:participant1.participantRole.id | This id is a unique identifier for the covered party member. Implementers **SHOULD** use the same GUID for each instance of a member identifier from the same health plan (CONF:4537-8984). : | |
4537-10120 | warning | Act.participant:participant2.participantRole.id | This id is a unique identifier for the subscriber of the coverage (CONF:4537-10120). : | |
4537-17139 | warning | Act.participant:participant2 | When the Subscriber is the patient, the participant element describing the subscriber **SHALL NOT** be present. This information will be recorded instead in the data elements used to record member information (CONF:4537-17139). : | |
4537-31345 | error | Act.participant:participant1.participantRole.playingEntity.sdtcBirthTime | The prefix sdtc: **SHALL** be bound to the namespace “urn:hl7-org:sdtc”. The use of the namespace provides a necessary extension to CDA R2 for the use of the birthTime element (CONF:4537-31345). : | |
81-7296 | error | Act.performer:performer1.assignedEntity.addr, Act.performer:performer2.assignedEntity.addr, Act.participant:participant1.participantRole.addr, Act.participant:participant2.participantRole.addr | **SHALL NOT** have mixed content except for white space (CONF:81-7296). : | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Act | 1..1 | CDAR2.Act | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, @classCode, @moodCode, realmCode, typeId, templateId, id, code, @negationInd, text, statusCode, effectiveTime, priorityCode, languageCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition Base for all types and resources | |
@nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
@classCode | 1..1 | cs | Fixed Value: ACT | |
@moodCode | 1..1 | cs | Fixed Value: EVN | |
realmCode | 0..* | CS | ||
typeId | 0..1 | II | ||
Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
templateId:templateId1 | 1..1 | II | templateId | |
@nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
@assigningAuthorityName | 0..1 | st | ||
@displayable | 0..1 | bl | ||
@root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.61 | |
@extension | 1..1 | st | Required Pattern: 2023-05-01 | |
id | 1..* | II | ||
code | 1..1 | CD | Binding: v3 Code System ActCode (extensible) | |
@nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
@code | 0..1 | cs | ||
@codeSystem | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.6.255.1336 | |
@codeSystemName | 0..1 | st | ||
@codeSystemVersion | 0..1 | st | ||
@displayName | 0..1 | st | ||
@sdtcValueSet | 0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc) | |
@sdtcValueSetVersion | 0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc) | |
originalText | 0..1 | ED | ||
qualifier | 0..* | CR | ||
Slices for translation | 1..* | CD | Slice: Unordered, Open by value:code | |
translation:translation1 | 1..* | CD | translation | |
@nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
@code | 0..1 | cs | Binding: Payer (preferred) | |
@codeSystem | 0..1 | oid, uuid, ruid | ||
@codeSystemName | 0..1 | st | ||
@codeSystemVersion | 0..1 | st | ||
@displayName | 0..1 | st | ||
@sdtcValueSet | 0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc) | |
@sdtcValueSetVersion | 0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc) | |
originalText | 0..1 | ED | ||
qualifier | 0..* | CR | ||
translation | 0..* | CD | ||
@negationInd | 0..1 | bl | ||
text | 0..1 | ED | ||
statusCode | 1..1 | CS | Binding: ActStatus (required) | |
@nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
@code | 1..1 | cs | Fixed Value: completed | |
@sdtcValueSet | 0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc) | |
@sdtcValueSetVersion | 0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc) | |
effectiveTime | 0..1 | IVL_TS | ||
priorityCode | 0..1 | CE | Binding: ActPriority (extensible) | |
languageCode | 0..1 | CS | Binding: HumanLanguage (required) | |
subject | 0..1 | Subject | ||
specimen | 0..* | Specimen | ||
Slices for performer | 1..* | Performer2 | Slice: Unordered, Open by value:templateId, value:assignedEntity, value:typeCode | |
performer:performer1 | 1..1 | Performer2 | performer | |
@nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
@typeCode | 1..1 | cs | Binding: ParticipationPhysicalPerformer (required) Fixed Value: PRF | |
realmCode | 0..* | CS | ||
typeId | 0..1 | II | ||
templateId | 1..1 | II | ||
@nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
@assigningAuthorityName | 0..1 | st | ||
@displayable | 0..1 | bl | ||
@root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.87 | |
sdtcFunctionCode | 0..1 | CE | XML Namespace: urn:hl7-org:sdtc XML: functionCode (urn:hl7-org:sdtc) | |
time | 0..1 | IVL_TS | ||
modeCode | 0..1 | CE | ||
assignedEntity | 1..1 | AssignedEntity | ||
@classCode | 0..1 | cs | Binding: RoleClassAssignedEntity (required) Fixed Value: ASSIGNED | |
templateId | 0..* | II | ||
id | 1..* | II | ||
sdtcIdentifiedBy | 0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |
code | 0..1 | CE | Binding: v3 Code System RoleCode (extensible) | |
@nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
@code | 1..1 | cs | Binding: Financially Responsible Party Type Value Set (preferred) | |
@codeSystem | 0..1 | oid, uuid, ruid | ||
@codeSystemName | 0..1 | st | ||
@codeSystemVersion | 0..1 | st | ||
@displayName | 0..1 | st | ||
@sdtcValueSet | 0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc) | |
@sdtcValueSetVersion | 0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc) | |
originalText | 0..1 | ED | ||
translation | 0..* | CD | ||
addr | C | 0..1 | USRealmAddressADUSFIELDED | Base for all types and resources |
telecom | 0..* | TEL | ||
assignedPerson | 0..1 | Person | ||
representedOrganization | 0..1 | Organization | ||
@nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
@classCode | 0..1 | cs | Binding: EntityClassOrganization (required) Fixed Value: ORG | |
@determinerCode | 0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
realmCode | 0..* | CS | ||
typeId | 0..1 | II | ||
templateId | 0..* | II | ||
id | 0..* | II | ||
name | 0..1 | ON | ||
telecom | 0..* | TEL | ||
addr | 0..* | AD | ||
standardIndustryClassCode | 0..1 | CE | Binding: OrganizationIndustryClassNAICS (extensible) | |
asOrganizationPartOf | 0..1 | OrganizationPartOf | ||
performer:performer2 | 0..* | Performer2 | performer | |
@nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
@typeCode | 1..1 | cs | Binding: ParticipationPhysicalPerformer (required) Fixed Value: PRF | |
realmCode | 0..* | CS | ||
typeId | 0..1 | II | ||
templateId | 1..1 | II | ||
@nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
@assigningAuthorityName | 0..1 | st | ||
@displayable | 0..1 | bl | ||
@root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.88 | |
sdtcFunctionCode | 0..1 | CE | XML Namespace: urn:hl7-org:sdtc XML: functionCode (urn:hl7-org:sdtc) | |
time | 0..1 | IVL_TS | ||
modeCode | 0..1 | CE | ||
assignedEntity | C | 1..1 | AssignedEntity | 4537-8967: **SHOULD** include assignedEntity/assignedPerson/name AND/OR assignedEntity/representedOrganization/name (CONF:4537-8967). |
@classCode | 0..1 | cs | Binding: RoleClassAssignedEntity (required) Fixed Value: ASSIGNED | |
templateId | 0..* | II | ||
id | 1..* | II | ||
sdtcIdentifiedBy | 0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |
code | 1..1 | CE | Binding: v3 Code System RoleCode (extensible) | |
@nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
@code | 1..1 | cs | Required Pattern: GUAR | |
@codeSystem | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.5.110 | |
@codeSystemName | 0..1 | st | ||
@codeSystemVersion | 0..1 | st | ||
@displayName | 0..1 | st | ||
@sdtcValueSet | 0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc) | |
@sdtcValueSetVersion | 0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc) | |
originalText | 0..1 | ED | ||
translation | 0..* | CD | ||
addr | C | 0..1 | USRealmAddressADUSFIELDED | Base for all types and resources |
telecom | 0..* | TEL | ||
assignedPerson | 0..1 | Person | ||
representedOrganization | 0..1 | Organization | ||
author | 0..* | Author | ||
informant | 0..* | Informant | ||
Slices for participant | 1..* | Participant2 | Slice: Unordered, Open by value:templateId, value:participantRole, value:typeCode | |
participant:participant1 | 1..1 | Participant2 | participant | |
@nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
@typeCode | 1..1 | cs | Binding: ParticipationType (required) Fixed Value: COV | |
@contextControlCode | 0..1 | cs | Binding: ContextControl (required) Fixed Value: OP | |
realmCode | 0..* | CS | ||
typeId | 0..1 | II | ||
templateId | 1..1 | II | ||
@nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
@assigningAuthorityName | 0..1 | st | ||
@displayable | 0..1 | bl | ||
@root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.89 | |
sdtcFunctionCode | 0..1 | CE | XML Namespace: urn:hl7-org:sdtc XML: functionCode (urn:hl7-org:sdtc) | |
time | 0..1 | IVL_TS | ||
@nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
@value | 0..1 | ts | Date Format: YYYYMMDDHHMMSS.UUUU[+|-ZZzz] | |
@operator | 0..1 | cs | Binding: SetOperator (required) | |
low | 0..1 | IVXB_TS | ||
center | 0..1 | TS | ||
width | 0..1 | PQ | ||
high | 0..1 | IVXB_TS | ||
awarenessCode | 0..1 | CE | ||
participantRole | 1..1 | ParticipantRole | ||
@classCode | 1..1 | cs | Binding: RoleClassRoot (required) | |
templateId | 0..* | II | ||
id | C | 1..* | II | 4537-8984: This id is a unique identifier for the covered party member. Implementers **SHOULD** use the same GUID for each instance of a member identifier from the same health plan (CONF:4537-8984). |
sdtcIdentifiedBy | 0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |
code | 1..1 | CE | Binding: v3 Code System RoleCode (extensible) | |
@nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
@code | 0..1 | cs | Binding: Coverage Role Type Value Set (preferred) | |
@codeSystem | 0..1 | oid, uuid, ruid | ||
@codeSystemName | 0..1 | st | ||
@codeSystemVersion | 0..1 | st | ||
@displayName | 0..1 | st | ||
@sdtcValueSet | 0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc) | |
@sdtcValueSetVersion | 0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc) | |
originalText | 0..1 | ED | ||
translation | 0..* | CD | ||
addr | C | 0..1 | USRealmAddressADUSFIELDED | Base for all types and resources |
telecom | 0..* | TEL | ||
playingDevice | 0..1 | Device | ||
playingEntity | 0..1 | PlayingEntity | ||
@classCode | 1..1 | cs | Binding: EntityClassRoot (required) | |
@determinerCode | 0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
templateId | 0..* | II | ||
code | 0..1 | CE | Binding: EntityCode (extensible) | |
quantity | 0..* | PQ | ||
name | 1..1 | PN | ||
sdtcBirthTime | C | 1..1 | TS | XML Namespace: urn:hl7-org:sdtc sdtc:birthTime XML: birthTime (urn:hl7-org:sdtc) 4537-31345: The prefix sdtc: **SHALL** be bound to the namespace “urn:hl7-org:sdtc”. The use of the namespace provides a necessary extension to CDA R2 for the use of the birthTime element (CONF:4537-31345). |
desc | 0..1 | ED | ||
scopingEntity | 0..1 | Entity | ||
participant:participant2 | C | 0..1 | Participant2 | participant 4537-17139: When the Subscriber is the patient, the participant element describing the subscriber **SHALL NOT** be present. This information will be recorded instead in the data elements used to record member information (CONF:4537-17139). |
@nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
@typeCode | 1..1 | cs | Binding: ParticipationType (required) Fixed Value: HLD | |
@contextControlCode | 0..1 | cs | Binding: ContextControl (required) Fixed Value: OP | |
realmCode | 0..* | CS | ||
typeId | 0..1 | II | ||
templateId | 1..1 | II | ||
@nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
@assigningAuthorityName | 0..1 | st | ||
@displayable | 0..1 | bl | ||
@root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.90 | |
sdtcFunctionCode | 0..1 | CE | XML Namespace: urn:hl7-org:sdtc XML: functionCode (urn:hl7-org:sdtc) | |
time | 0..1 | IVL_TS | ||
awarenessCode | 0..1 | CE | ||
participantRole | 1..1 | ParticipantRole | ||
@classCode | 1..1 | cs | Binding: RoleClassRoot (required) | |
templateId | 0..* | II | ||
id | C | 1..* | II | 4537-10120: This id is a unique identifier for the subscriber of the coverage (CONF:4537-10120). |
sdtcIdentifiedBy | 0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |
code | 0..1 | CE | Binding: v3 Code System RoleCode (extensible) | |
addr | C | 0..1 | USRealmAddressADUSFIELDED | Base for all types and resources |
telecom | 0..* | TEL | ||
playingDevice | 0..1 | Device | ||
playingEntity | 0..1 | PlayingEntity | ||
scopingEntity | 0..1 | Entity | ||
Slices for entryRelationship | 0..* | EntryRelationship | Slice: Unordered, Open by value:typeCode | |
entryRelationship:entryRelationship1 | C | 0..* | EntryRelationship | entryRelationship 4537-8942: The target of a policy activity with act/entryRelationship/@typeCode="REFR" **SHALL** be an authorization activity (templateId 2.16.840.1.113883.10.20.1.19) *OR* an act, with act[@classCode="ACT"] and act[@moodCode="DEF"], representing a description of the coverage plan (CONF:4537-8942). 4537-8943: A description of the coverage plan **SHALL** contain one or more act/id, to represent the plan identifier, and an act/text with the name of the plan (CONF:4537-8943). |
@nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
realmCode | 0..* | CS | ||
typeId | 0..1 | II | ||
templateId | 0..* | II | ||
@typeCode | 1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: REFR | |
@inversionInd | 0..1 | bl | ||
@contextConductionInd | 0..1 | bl | ||
@negationInd | 0..1 | bl | ||
sequenceNumber | 0..1 | INT | ||
seperatableInd | 0..1 | BL | ||
act | 0..1 | Act | ||
encounter | 0..1 | Encounter | ||
observation | 0..1 | Observation | ||
observationMedia | 0..1 | ObservationMedia | ||
organizer | 0..1 | Organizer | ||
procedure | 0..1 | Procedure | ||
regionOfInterest | 0..1 | RegionOfInterest | ||
substanceAdministration | 0..1 | SubstanceAdministration | ||
supply | 0..1 | Supply | ||
reference | 0..* | Reference | ||
precondition | 0..* | Precondition | ||
Documentation for this format |
Path | Conformance | ValueSet / Code |
Act.nullFlavor | required | NullFlavor |
Act.templateId:templateId1.nullFlavor | required | NullFlavor |
Act.code | extensible | ActCode |
Act.code.nullFlavor | required | NullFlavor |
Act.code.translation:translation1.nullFlavor | required | NullFlavor |
Act.code.translation:translation1.code | preferred | Payer |
Act.statusCode | required | ActStatus |
Act.statusCode.nullFlavor | required | NullFlavor |
Act.priorityCode | extensible | ActPriority |
Act.languageCode | required | HumanLanguage (a valid code from http://terminology.hl7.org/CodeSystem/ietf3066 ) |
Act.performer:performer1.nullFlavor | required | NullFlavor |
Act.performer:performer1.typeCode | required | Fixed Value: PRF |
Act.performer:performer1.templateId.nullFlavor | required | NullFlavor |
Act.performer:performer1.assignedEntity.classCode | required | Fixed Value: ASSIGNED |
Act.performer:performer1.assignedEntity.code | extensible | RoleCode |
Act.performer:performer1.assignedEntity.code.nullFlavor | required | NullFlavor |
Act.performer:performer1.assignedEntity.code.code | preferred | Financially Responsible Party Type Value Set |
Act.performer:performer1.assignedEntity.representedOrganization.nullFlavor | required | NullFlavor |
Act.performer:performer1.assignedEntity.representedOrganization.classCode | required | Fixed Value: ORG |
Act.performer:performer1.assignedEntity.representedOrganization.determinerCode | required | Fixed Value: INSTANCE |
Act.performer:performer1.assignedEntity.representedOrganization.standardIndustryClassCode | extensible | OrganizationIndustryClassNAICS |
Act.performer:performer2.nullFlavor | required | NullFlavor |
Act.performer:performer2.typeCode | required | Fixed Value: PRF |
Act.performer:performer2.templateId.nullFlavor | required | NullFlavor |
Act.performer:performer2.assignedEntity.classCode | required | Fixed Value: ASSIGNED |
Act.performer:performer2.assignedEntity.code | extensible | RoleCode |
Act.performer:performer2.assignedEntity.code.nullFlavor | required | NullFlavor |
Act.participant:participant1.nullFlavor | required | NullFlavor |
Act.participant:participant1.typeCode | required | Fixed Value: COV |
Act.participant:participant1.contextControlCode | required | Fixed Value: OP |
Act.participant:participant1.templateId.nullFlavor | required | NullFlavor |
Act.participant:participant1.time.nullFlavor | required | NullFlavor |
Act.participant:participant1.time.operator | required | SetOperator |
Act.participant:participant1.participantRole.classCode | required | RoleClassRoot |
Act.participant:participant1.participantRole.code | extensible | RoleCode |
Act.participant:participant1.participantRole.code.nullFlavor | required | NullFlavor |
Act.participant:participant1.participantRole.code.code | preferred | Coverage Role Type Value Set |
Act.participant:participant1.participantRole.playingEntity.classCode | required | EntityClassRoot |
Act.participant:participant1.participantRole.playingEntity.determinerCode | required | Fixed Value: INSTANCE |
Act.participant:participant1.participantRole.playingEntity.code | extensible | EntityCode |
Act.participant:participant2.nullFlavor | required | NullFlavor |
Act.participant:participant2.typeCode | required | Fixed Value: HLD |
Act.participant:participant2.contextControlCode | required | Fixed Value: OP |
Act.participant:participant2.templateId.nullFlavor | required | NullFlavor |
Act.participant:participant2.participantRole.classCode | required | RoleClassRoot |
Act.participant:participant2.participantRole.code | extensible | RoleCode |
Act.entryRelationship:entryRelationship1.nullFlavor | required | NullFlavor |
Act.entryRelationship:entryRelationship1.typeCode | required | Fixed Value: REFR |
Id | Grade | Path(s) | Details | Requirements |
4537-8942 | warning | Act.entryRelationship:entryRelationship1 | The target of a policy activity with act/entryRelationship/@typeCode="REFR" **SHALL** be an authorization activity (templateId 2.16.840.1.113883.10.20.1.19) *OR* an act, with act[@classCode="ACT"] and act[@moodCode="DEF"], representing a description of the coverage plan (CONF:4537-8942). : | |
4537-8943 | warning | Act.entryRelationship:entryRelationship1 | A description of the coverage plan **SHALL** contain one or more act/id, to represent the plan identifier, and an act/text with the name of the plan (CONF:4537-8943). : | |
4537-8967 | warning | Act.performer:performer2.assignedEntity | **SHOULD** include assignedEntity/assignedPerson/name AND/OR assignedEntity/representedOrganization/name (CONF:4537-8967). : | |
4537-8984 | warning | Act.participant:participant1.participantRole.id | This id is a unique identifier for the covered party member. Implementers **SHOULD** use the same GUID for each instance of a member identifier from the same health plan (CONF:4537-8984). : | |
4537-10120 | warning | Act.participant:participant2.participantRole.id | This id is a unique identifier for the subscriber of the coverage (CONF:4537-10120). : | |
4537-17139 | warning | Act.participant:participant2 | When the Subscriber is the patient, the participant element describing the subscriber **SHALL NOT** be present. This information will be recorded instead in the data elements used to record member information (CONF:4537-17139). : | |
4537-31345 | error | Act.participant:participant1.participantRole.playingEntity.sdtcBirthTime | The prefix sdtc: **SHALL** be bound to the namespace “urn:hl7-org:sdtc”. The use of the namespace provides a necessary extension to CDA R2 for the use of the birthTime element (CONF:4537-31345). : | |
81-7296 | error | Act.performer:performer1.assignedEntity.addr, Act.performer:performer2.assignedEntity.addr, Act.participant:participant1.participantRole.addr, Act.participant:participant2.participantRole.addr | **SHALL NOT** have mixed content except for white space (CONF:81-7296). : | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
This structure is derived from CDAR2.Act
Summary
Mandatory: 22 elements (13 nested mandatory elements)
Fixed Value: 6 elements
Prohibited: 4 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices: