Paramedicine Summary Of Care CDA
0.0.1-current - ci-build
Paramedicine Summary Of Care CDA
0.0.1-current - ci-build
Paramedicine Summary Of Care CDA, published by IHE Patient Care Coordination Technical Committee. This guide is not an authorized publication; it is the continuous build for version 0.0.1-current built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/IHE/PCC.PCSc/ and changes regularly. See the Directory of published versions
| Official URL: https://profiles.ihe.net/PCC/PSCc/StructureDefinition/IHE.PCC.CDA.Payers.Entry | Version: 0.0.1-current | |||
| Draft as of 2025-11-04 | Computable Name: IHE_PCC_CDA_Payers_Entry | |||
The payer entry allows information about the patient's sources of payment to be recorded.
TBD if more
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  Act |
C | 1..1 | Act | XML Namespace: urn:hl7-org:v3 Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) Constraints: should-text-ref-value, should-effectiveTime |
  @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
 realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
 @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
 @extension |
1..1 | st | ||
 Slices for templateId |
2..* | II | Slice: Unordered, Open by value:root, value:extension | |
  templateId:payer-act |
1..1 | II | ||
  @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.1.26 | |
 @extension |
0..1 | st | ||
 templateId:payers-entry |
1..1 | II | ||
 @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Required Pattern: 1.3.6.1.4.1.19376.1.5.3.1.4.18 | |
| @extension |
0..1 | st | ||
| @classCode |
1..1 | cs | Binding: XActClassDocumentEntryAct (2.0.0) (required) Fixed Value: ACT | |
| @moodCode |
1..1 | cs | Binding: XDocumentActMood (2.0.0) (required) Fixed Value: EVN | |
| @negationInd |
0..1 | bl | ||
| id |
1..1 | II | ||
| code |
S | 1..1 | CD | Binding: ActCoverageTypeCode (preferred) |
| text |
0..1 | ED | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @compression |
0..1 | cs | Binding: CDACompressionAlgorithm (required) | |
| @integrityCheck |
0..1 | bin | ||
| @integrityCheckAlgorithm |
0..1 | cs | Binding: IntegrityCheckAlgorithm (2.0.0) (required) | |
| @language |
0..1 | cs | ||
| @mediaType |
0..1 | cs | Binding: MediaType (example) | |
| @representation |
0..1 | cs | Binding: CDABinaryDataEncoding (required) | |
| xmlText |
0..1 | st | Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string. | |
| reference |
C | 0..1 | TEL | Constraints: value-starts-octothorpe |
| thumbnail |
0..1 | ED | ||
| statusCode |
1..1 | CS | Binding: ActStatus (required) | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (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 (example) | |
| languageCode |
0..1 | CS | Binding: AllLanguages (required) | |
| subject |
0..1 | Subject | ||
| specimen |
0..* | Specimen | ||
| Slices for performer |
1..* | Performer2 | Slice: Unordered, Open by value:templateId.root | |
| performer:payer |
1..1 | Performer2 | This performer represents the Payer. | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
 @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| templateId |
0..* | II | ||
| @typeCode |
1..1 | cs | Binding: ParticipationPhysicalPerformer (required) Fixed Value: PRF | |
| 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 | Constraints: should-code, should-representedOrganization |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| templateId |
0..* | II | ||
| @classCode |
S | 1..1 | cs | Binding: RoleClassAssignedEntity (required) Fixed Value: ASSIGNED |
| id |
S | 1..* | II | |
| sdtcIdentifiedBy |
0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |
| code |
0..1 | CE | Binding: CDARoleCode (example) | |
| @code |
1..1 | cs | Binding: Payer Role Codes (extensible) | |
| @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 | 1..1 | AD | Constraints: should-country |
| telecom |
C | 0..* | TEL | Constraints: should-use |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @value |
0..1 | url | ||
 useablePeriod |
0..* | |||
 useablePeriod |
IVL_TS | |||
| useablePeriod |
EIVL_TS | |||
| useablePeriod |
PIVL_TS | |||
| useablePeriod |
SXPR_TS | |||
| @use |
S | 1..* | cs | Binding: TelecommunicationAddressUse (2.0.0) (required) |
| assignedPerson |
0..1 | Person | ||
| representedOrganization |
C | 0..1 | Organization | Constraints: should-name |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| templateId |
0..* | II | ||
| @classCode |
1..1 | cs | Binding: EntityClassOrganization (required) Fixed Value: ORG | |
| @determinerCode |
0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
| id |
0..* | II | ||
| name |
1..1 | ON | ||
| telecom |
0..* | TEL | ||
| addr |
0..* | AD | ||
| standardIndustryClassCode |
0..1 | CE | Binding: OrganizationIndustryClassNAICS (example) | |
| asOrganizationPartOf |
0..1 | OrganizationPartOf | ||
| sdtcPatient |
0..1 | Base | XML Namespace: urn:hl7-org:sdtc XML: patient (urn:hl7-org:sdtc) | |
| id |
1..1 | II | XML Namespace: urn:hl7-org:sdtc XML Namespace: urn:hl7-org:sdtc | |
| performer:guarantor |
C | 0..* | Performer2 | This performer represents the Guarantor. Constraints: should-time |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| templateId |
0..* | II | ||
| @typeCode |
1..1 | cs | Binding: ParticipationPhysicalPerformer (required) Fixed Value: PRF | |
| 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 | Constraints: 4537-8967, should-addr, should-telecom |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| templateId |
0..* | II | ||
| @classCode |
0..1 | cs | Binding: RoleClassAssignedEntity (required) Fixed Value: ASSIGNED | |
| id |
1..* | II | ||
| sdtcIdentifiedBy |
0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |
| code |
1..1 | CE | Binding: CDARoleCode (example) | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (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 | AD | Constraints: should-country |
| telecom |
C | 0..* | TEL | Constraints: should-use |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @value |
0..1 | url | ||
| useablePeriod |
0..* | |||
| useablePeriod |
IVL_TS | |||
| useablePeriod |
EIVL_TS | |||
| useablePeriod |
PIVL_TS | |||
| useablePeriod |
SXPR_TS | |||
| @use |
S | 1..* | cs | Binding: TelecommunicationAddressUse (2.0.0) (required) |
| assignedPerson |
0..1 | Person | ||
| representedOrganization |
0..1 | Organization | ||
| sdtcPatient |
0..1 | Base | XML Namespace: urn:hl7-org:sdtc XML: patient (urn:hl7-org:sdtc) | |
| id |
1..1 | II | XML Namespace: urn:hl7-org:sdtc XML Namespace: urn:hl7-org:sdtc | |
| author |
0..* | Author | ||
| informant |
0..* | Informant | ||
| Slices for participant |
1..* | Participant2 | Slice: Unordered, Open by value:typeCode | |
| participant:member |
C | 1..1 | Participant2 | participant Constraints: should-time |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| templateId |
0..* | II | ||
| @typeCode |
1..1 | cs | Binding: CDAParticipationType (required) Fixed Value: COV | |
| @contextControlCode |
0..1 | cs | Binding: CDAContextControl (required) Fixed Value: OP | |
| sdtcFunctionCode |
0..1 | CE | XML Namespace: urn:hl7-org:sdtc XML: functionCode (urn:hl7-org:sdtc) | |
| time |
C | 0..1 | IVL_TS | This records the policy coverage period or self-pay period. Constraints: should-low, should-high |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @value |
0..1 | ts | Date Format: YYYYMMDDHHMMSS.UUUU[+|-ZZzz] | |
| @operator |
0..1 | cs | Binding: CDASetOperator (required) | |
| low |
0..1 | IVXB_TS | ||
| center |
0..1 | TS | ||
| width |
0..1 | PQ | ||
| high |
0..1 | IVXB_TS | SHOULD contain high | |
| awarenessCode |
0..1 | CE | ||
| participantRole |
C | 1..1 | ParticipantRole | Constraints: should-addr, should-playingEntity |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| templateId |
0..* | II | ||
| @classCode |
0..1 | cs | Binding: CDARoleClassRoot (required) | |
| id |
S | 1..* | II | |
| sdtcIdentifiedBy |
0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |
| code |
SC | 1..1 | CE | Binding: CDARoleCode (example) Constraints: should-code-attr |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @code |
0..1 | cs | Binding: Payer Role Codes (extensible) | |
| @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 |
SC | 1..1 | AD | Constraints: should-country |
| telecom |
C | 0..* | TEL | Constraints: should-use |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @value |
0..1 | url | ||
| useablePeriod |
0..* | |||
| useablePeriod |
IVL_TS | |||
| useablePeriod |
EIVL_TS | |||
| useablePeriod |
PIVL_TS | |||
| useablePeriod |
SXPR_TS | |||
| @use |
S | 1..* | cs | Binding: TelecommunicationAddressUse (2.0.0) (required) |
| playingDevice |
0..1 | Device | ||
| playingEntity |
0..1 | PlayingEntity | This playingEntity records the covered party name and birthTime as represented by the health plan. This could match the information in recordTarget, or be different due to marriage or other reasons. | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| templateId |
0..* | II | ||
| @classCode |
0..1 | cs | Binding: EntityClassRoot (required) | |
| @determinerCode |
0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
| code |
0..1 | CE | Binding: CDAEntityCode (example) | |
| quantity |
0..* | PQ | ||
| name |
1..1 | PN | ||
| sdtcBirthTime |
1..1 | TS | XML Namespace: urn:hl7-org:sdtc sdtc:birthTime XML: birthTime (urn:hl7-org:sdtc) | |
| desc |
0..1 | ED | ||
| scopingEntity |
0..1 | Entity | ||
| participant:subscriber |
0..1 | 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. | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| templateId |
0..* | II | ||
| @typeCode |
1..1 | cs | Binding: CDAParticipationType (required) Fixed Value: HLD | |
| @contextControlCode |
0..1 | cs | Binding: CDAContextControl (required) Fixed Value: OP | |
| 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 |
C | 1..1 | ParticipantRole | Constraints: should-addr |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| templateId |
0..* | II | ||
| @classCode |
0..1 | cs | Binding: CDARoleClassRoot (required) | |
| id |
S | 1..1 | II | |
| sdtcIdentifiedBy |
0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |
| code |
0..1 | CE | Binding: CDARoleCode (example) | |
| addr |
C | 1..1 | AD | Constraints: should-country |
| telecom |
C | 0..* | TEL | Constraints: should-use |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @value |
0..1 | url | ||
| useablePeriod |
0..* | |||
| useablePeriod |
IVL_TS | |||
| useablePeriod |
EIVL_TS | |||
| useablePeriod |
PIVL_TS | |||
| useablePeriod |
SXPR_TS | |||
| @use |
S | 1..* | cs | Binding: TelecommunicationAddressUse (2.0.0) (required) |
| playingDevice |
0..1 | Device | ||
| playingEntity |
0..1 | PlayingEntity | ||
| scopingEntity |
0..1 | Entity | ||
| Slices for entryRelationship |
0..* | EntryRelationship | Slice: Unordered, Open by value:act.moodCode | |
| entryRelationship:plan |
0..* | EntryRelationship | Represents the Coverage Plan | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| 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 |
1..1 | Act | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| templateId |
0..* | II | ||
| @classCode |
1..1 | cs | Binding: XActClassDocumentEntryAct (2.0.0) (required) Fixed Value: ACT | |
| @moodCode |
1..1 | cs | Binding: XDocumentActMood (2.0.0) (required) Fixed Value: DEF | |
| @negationInd |
0..1 | bl | ||
| id |
1..1 | II | Plan identifier | |
| code |
1..1 | CD | Binding: v3 Code System ActCode (example) | |
| text |
1..1 | ED | Name of the plan | |
| statusCode |
0..1 | CS | Binding: ActStatus (required) | |
| effectiveTime |
0..1 | IVL_TS | ||
| priorityCode |
0..1 | CE | Binding: ActPriority (example) | |
| languageCode |
0..1 | CS | Binding: AllLanguages (required) | |
| subject |
0..1 | Subject | ||
| specimen |
0..* | Specimen | ||
| performer |
0..* | Performer2 | ||
| author |
0..* | Author | ||
| informant |
0..* | Informant | ||
| participant |
0..* | Participant2 | ||
| entryRelationship |
0..* | EntryRelationship | ||
| reference |
0..* | Reference | ||
| precondition |
0..* | Precondition | ||
| sdtcPrecondition2 |
0..* | Precondition2 | XML Namespace: urn:hl7-org:sdtc XML: precondition2 (urn:hl7-org:sdtc) | |
| sdtcInFulfillmentOf1 |
0..* | InFulfillmentOf1 | XML Namespace: urn:hl7-org:sdtc XML: inFulfillmentOf1 (urn:hl7-org:sdtc) | |
| 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 | ||
| sdtcPrecondition2 |
0..* | Precondition2 | XML Namespace: urn:hl7-org:sdtc XML: precondition2 (urn:hl7-org:sdtc) | |
| sdtcInFulfillmentOf1 |
0..* | InFulfillmentOf1 | XML Namespace: urn:hl7-org:sdtc XML: inFulfillmentOf1 (urn:hl7-org:sdtc) | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Act.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.templateId:payer-act.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.templateId:payers-entry.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.classCode | Base | required | x_ActClassDocumentEntryAct | 📍2.0.0 | THO v5.2 |
| Act.moodCode | Base | required | x_DocumentActMood | 📍2.0.0 | THO v5.2 |
| Act.code | Base | preferred | ActCoverageTypeCode | 📦3.0.0 | THO v6.5 |
| Act.text.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.text.compression | Base | required | CDACompressionAlgorithm | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.text.integrityCheckAlgorithm | Base | required | IntegrityCheckAlgorithm | 📍2.0.0 | THO v5.2 |
| Act.text.mediaType | Base | example | MediaType | 📦3.0.0 | THO v6.5 |
| Act.text.representation | Base | required | CDABinaryDataEncoding | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.statusCode | Base | required | ActStatus | 📦3.0.0 | THO v6.5 |
| Act.statusCode.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.priorityCode | Base | example | ActPriority | 📦3.0.0 | THO v6.5 |
| Act.languageCode | Base | required | All Languages | 📦5.0.0 | FHIR Std. |
| Act.performer:payer.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.performer:payer.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.performer:payer.​typeCode | Base | required | ParticipationPhysicalPerformer | 📦3.0.0 | THO v6.5 |
| Act.performer:payer.​assignedEntity.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.performer:payer.​assignedEntity.typeId.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.performer:payer.​assignedEntity.classCode | Base | required | RoleClassAssignedEntity | 📦3.0.0 | THO v6.5 |
| Act.performer:payer.​assignedEntity.code | Base | example | CDARoleCode | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.performer:payer.​assignedEntity.code.​code | Base | extensible | Payer Role Codes | 📦0.0.1-current | This IG |
| Act.performer:payer.​assignedEntity.telecom.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.performer:payer.​assignedEntity.telecom.​use | Base | required | TelecommunicationAddressUse | 📍2.0.0 | THO v5.2 |
| Act.performer:payer.​assignedEntity.representedOrganization.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.performer:payer.​assignedEntity.representedOrganization.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.performer:payer.​assignedEntity.representedOrganization.​classCode | Base | required | EntityClassOrganization | 📦3.0.0 | THO v6.5 |
| Act.performer:payer.​assignedEntity.representedOrganization.​determinerCode | Base | required | EntityDeterminer | 📦3.0.0 | THO v6.5 |
| Act.performer:payer.​assignedEntity.representedOrganization.​standardIndustryClassCode | Base | example | OrganizationIndustryClassNAICS | 📦3.0.0 | THO v6.5 |
| Act.performer:guarantor.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.performer:guarantor.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.performer:guarantor.​typeCode | Base | required | ParticipationPhysicalPerformer | 📦3.0.0 | THO v6.5 |
| Act.performer:guarantor.​assignedEntity.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.performer:guarantor.​assignedEntity.typeId.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.performer:guarantor.​assignedEntity.classCode | Base | required | RoleClassAssignedEntity | 📦3.0.0 | THO v6.5 |
| Act.performer:guarantor.​assignedEntity.code | Base | example | CDARoleCode | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.performer:guarantor.​assignedEntity.code.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.performer:guarantor.​assignedEntity.telecom.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.performer:guarantor.​assignedEntity.telecom.​use | Base | required | TelecommunicationAddressUse | 📍2.0.0 | THO v5.2 |
| Act.participant:member.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:member.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:member.​typeCode | Base | required | CDAParticipationType | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:member.​contextControlCode | Base | required | CDAContextControl | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:member.​time.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:member.​time.operator | Base | required | CDASetOperator | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:member.​participantRole.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:member.​participantRole.typeId.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:member.​participantRole.classCode | Base | required | CDARoleClassRoot | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:member.​participantRole.code | Base | example | CDARoleCode | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:member.​participantRole.code.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:member.​participantRole.code.​code | Base | extensible | Payer Role Codes | 📦0.0.1-current | This IG |
| Act.participant:member.​participantRole.telecom.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:member.​participantRole.telecom.​use | Base | required | TelecommunicationAddressUse | 📍2.0.0 | THO v5.2 |
| Act.participant:member.​participantRole.playingEntity.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:member.​participantRole.playingEntity.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:member.​participantRole.playingEntity.​classCode | Base | required | EntityClassRoot | 📦3.0.0 | THO v6.5 |
| Act.participant:member.​participantRole.playingEntity.​determinerCode | Base | required | EntityDeterminer | 📦3.0.0 | THO v6.5 |
| Act.participant:member.​participantRole.playingEntity.​code | Base | example | CDAEntityCode | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:subscriber.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:subscriber.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:subscriber.​typeCode | Base | required | CDAParticipationType | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:subscriber.​contextControlCode | Base | required | CDAContextControl | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:subscriber.​participantRole.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:subscriber.​participantRole.typeId.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:subscriber.​participantRole.classCode | Base | required | CDARoleClassRoot | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:subscriber.​participantRole.code | Base | example | CDARoleCode | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:subscriber.​participantRole.telecom.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:subscriber.​participantRole.telecom.​use | Base | required | TelecommunicationAddressUse | 📍2.0.0 | THO v5.2 |
| Act.entryRelationship:plan.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.entryRelationship:plan.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.entryRelationship:plan.​typeCode | Base | required | x_ActRelationshipEntryRelationship | 📦3.0.0 | THO v6.5 |
| Act.entryRelationship:plan.​act.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.entryRelationship:plan.​act.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.entryRelationship:plan.​act.classCode | Base | required | x_ActClassDocumentEntryAct | 📍2.0.0 | THO v5.2 |
| Act.entryRelationship:plan.​act.moodCode | Base | required | x_DocumentActMood | 📍2.0.0 | THO v5.2 |
| Act.entryRelationship:plan.​act.code | Base | example | v3 Code System ActCode | 📦3.0.0 | THO v6.5 |
| Act.entryRelationship:plan.​act.statusCode | Base | required | ActStatus | 📦3.0.0 | THO v6.5 |
| Act.entryRelationship:plan.​act.priorityCode | Base | example | ActPriority | 📦3.0.0 | THO v6.5 |
| Act.entryRelationship:plan.​act.languageCode | Base | required | All Languages | 📦5.0.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 4537-8967 | warning | Act.performer:guarantor.assignedEntity | **SHOULD** include assignedEntity/assignedPerson/name AND/OR assignedEntity/representedOrganization/name (CONF:4537-8967). |
assignedPerson.name.exists() or representedOrganization.name.exists()
|
| II-1 | error | Act.typeId, Act.performer:payer.typeId, Act.performer:payer.assignedEntity.typeId, Act.performer:payer.assignedEntity.representedOrganization.typeId, Act.performer:guarantor.typeId, Act.performer:guarantor.assignedEntity.typeId, Act.participant:member.typeId, Act.participant:member.participantRole.typeId, Act.participant:member.participantRole.playingEntity.typeId, Act.participant:subscriber.typeId, Act.participant:subscriber.participantRole.typeId, Act.entryRelationship:plan.typeId, Act.entryRelationship:plan.act.typeId | An II instance must have either a root or an nullFlavor. |
root.exists() or nullFlavor.exists()
|
| should-addr | warning | Act.performer:guarantor.assignedEntity, Act.participant:member.participantRole, Act.participant:subscriber.participantRole | SHOULD contain addr |
addr.exists()
|
| should-code | warning | Act.performer:payer.assignedEntity | SHOULD contain code |
code.exists()
|
| should-code-attr | warning | Act.participant:member.participantRole.code | SHOULD contain @code |
code.exists()
|
| should-country | warning | Act.performer:payer.assignedEntity.addr, Act.performer:guarantor.assignedEntity.addr, Act.participant:member.participantRole.addr, Act.participant:subscriber.participantRole.addr | SHOULD contain country |
|
| should-effectiveTime | warning | Act | SHOULD contain effectiveTime |
effectiveTime.exists()
|
| should-high | warning | Act.participant:member.time | SHOULD contain high |
high.exists()
|
| should-low | warning | Act.participant:member.time | SHOULD contain low |
low.exists()
|
| should-name | warning | Act.performer:payer.assignedEntity.representedOrganization | SHOULD contain name |
name.exists()
|
| should-playingEntity | warning | Act.participant:member.participantRole | SHOULD contain playingEntity |
playingEntity.exists()
|
| should-representedOrganization | warning | Act.performer:payer.assignedEntity | SHOULD contain representedOrganization |
representedOrganization.exists()
|
| should-telecom | warning | Act.performer:guarantor.assignedEntity | SHOULD contain telecom |
telecom.exists()
|
| should-text-ref-value | warning | Act | SHOULD contain text/reference/@value |
text.reference.value.exists()
|
| should-time | warning | Act.performer:guarantor, Act.participant:member | SHOULD contain time |
time.exists()
|
| should-use | warning | Act.performer:payer.assignedEntity.telecom, Act.performer:guarantor.assignedEntity.telecom, Act.participant:member.participantRole.telecom, Act.participant:subscriber.participantRole.telecom | SHOULD contain @use |
nullFlavor.exists() or use.exists()
|
| value-starts-octothorpe | error | Act.text.reference | If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative |
value.exists() implies value.startsWith('#')
|
This structure is derived from Act
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Act |
C | 1..1 | Act | XML Namespace: urn:hl7-org:v3 Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) Constraints: should-text-ref-value, should-effectiveTime |
| Slices for templateId |
2..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:payer-act |
1..1 | II | ||
| @root |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.1.26 | |
| templateId:payers-entry |
1..1 | II | ||
| @root |
1..1 | oid, uuid, ruid | Required Pattern: 1.3.6.1.4.1.19376.1.5.3.1.4.18 | |
| @classCode |
1..1 | cs | Fixed Value: ACT | |
| @moodCode |
1..1 | cs | Fixed Value: EVN | |
| id |
1..1 | II | ||
| code |
S | 1..1 | CD | Binding: ActCoverageTypeCode (preferred) |
| text |
||||
| reference |
C | 0..1 | TEL | Constraints: value-starts-octothorpe |
| statusCode |
1..1 | CS | ||
| @code |
1..1 | cs | Fixed Value: completed | |
| Slices for performer |
1..* | Performer2 | Slice: Unordered, Open by value:templateId.root | |
| performer:payer |
1..1 | Performer2 | This performer represents the Payer. | |
| @typeCode |
1..1 | cs | ||
| assignedEntity |
C | 1..1 | AssignedEntity | Constraints: should-code, should-representedOrganization |
| @classCode |
S | 1..1 | cs | |
| id |
S | 1..* | II | |
| code |
0..1 | CE | ||
| @nullFlavor |
0..0 | |||
| @code |
1..1 | cs | Binding: Payer Role Codes (extensible) | |
| addr |
C | 1..1 | AD | Constraints: should-country |
| telecom |
C | 0..* | TEL | Constraints: should-use |
| @use |
S | 1..* | cs | |
| representedOrganization |
C | 0..1 | Organization | Constraints: should-name |
| @classCode |
1..1 | cs | ||
| name |
1..1 | ON | ||
| performer:guarantor |
C | 0..* | Performer2 | This performer represents the Guarantor. Constraints: should-time |
| @typeCode |
1..1 | cs | ||
| time |
0..1 | IVL_TS | ||
| assignedEntity |
C | 1..1 | AssignedEntity | Constraints: 4537-8967, should-addr, should-telecom |
| 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 |
C | 0..1 | AD | Constraints: should-country |
| telecom |
C | 0..* | TEL | Constraints: should-use |
| @use |
S | 1..* | cs | |
| Slices for participant |
1..* | Participant2 | Slice: Unordered, Open by value:typeCode | |
| participant:member |
C | 1..1 | Participant2 | participant Constraints: should-time |
| @typeCode |
1..1 | cs | Fixed Value: COV | |
| time |
C | 0..1 | IVL_TS | This records the policy coverage period or self-pay period. Constraints: should-low, should-high |
| low |
0..1 | IVXB_TS | ||
| high |
0..1 | IVXB_TS | SHOULD contain high | |
| participantRole |
C | 1..1 | ParticipantRole | Constraints: should-addr, should-playingEntity |
| id |
S | 1..* | II | |
| code |
SC | 1..1 | CE | Constraints: should-code-attr |
| @code |
0..1 | cs | Binding: Payer Role Codes (extensible) | |
| addr |
SC | 1..1 | AD | Constraints: should-country |
| telecom |
C | 0..* | TEL | Constraints: should-use |
| @use |
S | 1..* | cs | |
| playingEntity |
0..1 | PlayingEntity | This playingEntity records the covered party name and birthTime as represented by the health plan. This could match the information in recordTarget, or be different due to marriage or other reasons. | |
| name |
1..1 | PN | ||
| sdtcBirthTime |
1..1 | TS | sdtc:birthTime | |
| participant:subscriber |
0..1 | 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. | |
| @typeCode |
1..1 | cs | Fixed Value: HLD | |
| time |
0..1 | IVL_TS | ||
| participantRole |
C | 1..1 | ParticipantRole | Constraints: should-addr |
| id |
S | 1..1 | II | |
| addr |
C | 1..1 | AD | Constraints: should-country |
| telecom |
C | 0..* | TEL | Constraints: should-use |
| @use |
S | 1..* | cs | |
| Slices for entryRelationship |
0..* | EntryRelationship | Slice: Unordered, Open by value:act.moodCode | |
| entryRelationship:plan |
0..* | EntryRelationship | Represents the Coverage Plan | |
| @typeCode |
1..1 | cs | Fixed Value: REFR | |
| act |
1..1 | Act | ||
| @classCode |
1..1 | cs | Fixed Value: ACT | |
| @moodCode |
1..1 | cs | Fixed Value: DEF | |
| id |
1..1 | II | Plan identifier | |
| text |
1..1 | ED | Name of the plan | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Act.code | Base | preferred | ActCoverageTypeCode | 📦3.0.0 | THO v6.5 |
| Act.performer:payer.​assignedEntity.code.​code | Base | extensible | Payer Role Codes | 📦0.0.1-current | This IG |
| Act.participant:member.​participantRole.code.​code | Base | extensible | Payer Role Codes | 📦0.0.1-current | This IG |
| Id | Grade | Path(s) | Description | Expression |
| 4537-8967 | warning | Act.performer:guarantor.assignedEntity | **SHOULD** include assignedEntity/assignedPerson/name AND/OR assignedEntity/representedOrganization/name (CONF:4537-8967). |
assignedPerson.name.exists() or representedOrganization.name.exists()
|
| should-addr | warning | Act.performer:guarantor.assignedEntity, Act.participant:member.participantRole, Act.participant:subscriber.participantRole | SHOULD contain addr |
addr.exists()
|
| should-code | warning | Act.performer:payer.assignedEntity | SHOULD contain code |
code.exists()
|
| should-code-attr | warning | Act.participant:member.participantRole.code | SHOULD contain @code |
code.exists()
|
| should-country | warning | Act.performer:payer.assignedEntity.addr, Act.performer:guarantor.assignedEntity.addr, Act.participant:member.participantRole.addr, Act.participant:subscriber.participantRole.addr | SHOULD contain country |
|
| should-effectiveTime | warning | Act | SHOULD contain effectiveTime |
effectiveTime.exists()
|
| should-high | warning | Act.participant:member.time | SHOULD contain high |
high.exists()
|
| should-low | warning | Act.participant:member.time | SHOULD contain low |
low.exists()
|
| should-name | warning | Act.performer:payer.assignedEntity.representedOrganization | SHOULD contain name |
name.exists()
|
| should-playingEntity | warning | Act.participant:member.participantRole | SHOULD contain playingEntity |
playingEntity.exists()
|
| should-representedOrganization | warning | Act.performer:payer.assignedEntity | SHOULD contain representedOrganization |
representedOrganization.exists()
|
| should-telecom | warning | Act.performer:guarantor.assignedEntity | SHOULD contain telecom |
telecom.exists()
|
| should-text-ref-value | warning | Act | SHOULD contain text/reference/@value |
text.reference.value.exists()
|
| should-time | warning | Act.performer:guarantor, Act.participant:member | SHOULD contain time |
time.exists()
|
| should-use | warning | Act.performer:payer.assignedEntity.telecom, Act.performer:guarantor.assignedEntity.telecom, Act.participant:member.participantRole.telecom, Act.participant:subscriber.participantRole.telecom | SHOULD contain @use |
nullFlavor.exists() or use.exists()
|
| value-starts-octothorpe | error | Act.text.reference | If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative |
value.exists() implies value.startsWith('#')
|
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Act |
C | 1..1 | Act | XML Namespace: urn:hl7-org:v3 Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) Constraints: should-text-ref-value, should-effectiveTime |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| Slices for templateId |
2..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:payer-act |
1..1 | II | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.1.26 | |
| @extension |
0..1 | st | ||
| templateId:payers-entry |
1..1 | II | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Required Pattern: 1.3.6.1.4.1.19376.1.5.3.1.4.18 | |
| @extension |
0..1 | st | ||
| @classCode |
1..1 | cs | Binding: XActClassDocumentEntryAct (2.0.0) (required) Fixed Value: ACT | |
| @moodCode |
1..1 | cs | Binding: XDocumentActMood (2.0.0) (required) Fixed Value: EVN | |
| @negationInd |
0..1 | bl | ||
| id |
1..1 | II | ||
| code |
S | 1..1 | CD | Binding: ActCoverageTypeCode (preferred) |
| text |
0..1 | ED | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @compression |
0..1 | cs | Binding: CDACompressionAlgorithm (required) | |
| @integrityCheck |
0..1 | bin | ||
| @integrityCheckAlgorithm |
0..1 | cs | Binding: IntegrityCheckAlgorithm (2.0.0) (required) | |
| @language |
0..1 | cs | ||
| @mediaType |
0..1 | cs | Binding: MediaType (example) | |
| @representation |
0..1 | cs | Binding: CDABinaryDataEncoding (required) | |
| xmlText |
0..1 | st | Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string. | |
| reference |
C | 0..1 | TEL | Constraints: value-starts-octothorpe |
| thumbnail |
0..1 | ED | ||
| statusCode |
1..1 | CS | Binding: ActStatus (required) | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (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 (example) | |
| languageCode |
0..1 | CS | Binding: AllLanguages (required) | |
| subject |
0..1 | Subject | ||
| specimen |
0..* | Specimen | ||
| Slices for performer |
1..* | Performer2 | Slice: Unordered, Open by value:templateId.root | |
| performer:payer |
1..1 | Performer2 | This performer represents the Payer. | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| templateId |
0..* | II | ||
| @typeCode |
1..1 | cs | Binding: ParticipationPhysicalPerformer (required) Fixed Value: PRF | |
| 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 | Constraints: should-code, should-representedOrganization |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| templateId |
0..* | II | ||
| @classCode |
S | 1..1 | cs | Binding: RoleClassAssignedEntity (required) Fixed Value: ASSIGNED |
| id |
S | 1..* | II | |
| sdtcIdentifiedBy |
0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |
| code |
0..1 | CE | Binding: CDARoleCode (example) | |
| @code |
1..1 | cs | Binding: Payer Role Codes (extensible) | |
| @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 | 1..1 | AD | Constraints: should-country |
| telecom |
C | 0..* | TEL | Constraints: should-use |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @value |
0..1 | url | ||
| useablePeriod |
0..* | |||
| useablePeriod |
IVL_TS | |||
| useablePeriod |
EIVL_TS | |||
| useablePeriod |
PIVL_TS | |||
| useablePeriod |
SXPR_TS | |||
| @use |
S | 1..* | cs | Binding: TelecommunicationAddressUse (2.0.0) (required) |
| assignedPerson |
0..1 | Person | ||
| representedOrganization |
C | 0..1 | Organization | Constraints: should-name |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| templateId |
0..* | II | ||
| @classCode |
1..1 | cs | Binding: EntityClassOrganization (required) Fixed Value: ORG | |
| @determinerCode |
0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
| id |
0..* | II | ||
| name |
1..1 | ON | ||
| telecom |
0..* | TEL | ||
| addr |
0..* | AD | ||
| standardIndustryClassCode |
0..1 | CE | Binding: OrganizationIndustryClassNAICS (example) | |
| asOrganizationPartOf |
0..1 | OrganizationPartOf | ||
| sdtcPatient |
0..1 | Base | XML Namespace: urn:hl7-org:sdtc XML: patient (urn:hl7-org:sdtc) | |
| id |
1..1 | II | XML Namespace: urn:hl7-org:sdtc XML Namespace: urn:hl7-org:sdtc | |
| performer:guarantor |
C | 0..* | Performer2 | This performer represents the Guarantor. Constraints: should-time |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| templateId |
0..* | II | ||
| @typeCode |
1..1 | cs | Binding: ParticipationPhysicalPerformer (required) Fixed Value: PRF | |
| 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 | Constraints: 4537-8967, should-addr, should-telecom |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| templateId |
0..* | II | ||
| @classCode |
0..1 | cs | Binding: RoleClassAssignedEntity (required) Fixed Value: ASSIGNED | |
| id |
1..* | II | ||
| sdtcIdentifiedBy |
0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |
| code |
1..1 | CE | Binding: CDARoleCode (example) | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (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 | AD | Constraints: should-country |
| telecom |
C | 0..* | TEL | Constraints: should-use |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @value |
0..1 | url | ||
| useablePeriod |
0..* | |||
| useablePeriod |
IVL_TS | |||
| useablePeriod |
EIVL_TS | |||
| useablePeriod |
PIVL_TS | |||
| useablePeriod |
SXPR_TS | |||
| @use |
S | 1..* | cs | Binding: TelecommunicationAddressUse (2.0.0) (required) |
| assignedPerson |
0..1 | Person | ||
| representedOrganization |
0..1 | Organization | ||
| sdtcPatient |
0..1 | Base | XML Namespace: urn:hl7-org:sdtc XML: patient (urn:hl7-org:sdtc) | |
| id |
1..1 | II | XML Namespace: urn:hl7-org:sdtc XML Namespace: urn:hl7-org:sdtc | |
| author |
0..* | Author | ||
| informant |
0..* | Informant | ||
| Slices for participant |
1..* | Participant2 | Slice: Unordered, Open by value:typeCode | |
| participant:member |
C | 1..1 | Participant2 | participant Constraints: should-time |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| templateId |
0..* | II | ||
| @typeCode |
1..1 | cs | Binding: CDAParticipationType (required) Fixed Value: COV | |
| @contextControlCode |
0..1 | cs | Binding: CDAContextControl (required) Fixed Value: OP | |
| sdtcFunctionCode |
0..1 | CE | XML Namespace: urn:hl7-org:sdtc XML: functionCode (urn:hl7-org:sdtc) | |
| time |
C | 0..1 | IVL_TS | This records the policy coverage period or self-pay period. Constraints: should-low, should-high |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @value |
0..1 | ts | Date Format: YYYYMMDDHHMMSS.UUUU[+|-ZZzz] | |
| @operator |
0..1 | cs | Binding: CDASetOperator (required) | |
| low |
0..1 | IVXB_TS | ||
| center |
0..1 | TS | ||
| width |
0..1 | PQ | ||
| high |
0..1 | IVXB_TS | SHOULD contain high | |
| awarenessCode |
0..1 | CE | ||
| participantRole |
C | 1..1 | ParticipantRole | Constraints: should-addr, should-playingEntity |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| templateId |
0..* | II | ||
| @classCode |
0..1 | cs | Binding: CDARoleClassRoot (required) | |
| id |
S | 1..* | II | |
| sdtcIdentifiedBy |
0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |
| code |
SC | 1..1 | CE | Binding: CDARoleCode (example) Constraints: should-code-attr |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @code |
0..1 | cs | Binding: Payer Role Codes (extensible) | |
| @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 |
SC | 1..1 | AD | Constraints: should-country |
| telecom |
C | 0..* | TEL | Constraints: should-use |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @value |
0..1 | url | ||
| useablePeriod |
0..* | |||
| useablePeriod |
IVL_TS | |||
| useablePeriod |
EIVL_TS | |||
| useablePeriod |
PIVL_TS | |||
| useablePeriod |
SXPR_TS | |||
| @use |
S | 1..* | cs | Binding: TelecommunicationAddressUse (2.0.0) (required) |
| playingDevice |
0..1 | Device | ||
| playingEntity |
0..1 | PlayingEntity | This playingEntity records the covered party name and birthTime as represented by the health plan. This could match the information in recordTarget, or be different due to marriage or other reasons. | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| templateId |
0..* | II | ||
| @classCode |
0..1 | cs | Binding: EntityClassRoot (required) | |
| @determinerCode |
0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
| code |
0..1 | CE | Binding: CDAEntityCode (example) | |
| quantity |
0..* | PQ | ||
| name |
1..1 | PN | ||
| sdtcBirthTime |
1..1 | TS | XML Namespace: urn:hl7-org:sdtc sdtc:birthTime XML: birthTime (urn:hl7-org:sdtc) | |
| desc |
0..1 | ED | ||
| scopingEntity |
0..1 | Entity | ||
| participant:subscriber |
0..1 | 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. | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| templateId |
0..* | II | ||
| @typeCode |
1..1 | cs | Binding: CDAParticipationType (required) Fixed Value: HLD | |
| @contextControlCode |
0..1 | cs | Binding: CDAContextControl (required) Fixed Value: OP | |
| 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 |
C | 1..1 | ParticipantRole | Constraints: should-addr |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| templateId |
0..* | II | ||
| @classCode |
0..1 | cs | Binding: CDARoleClassRoot (required) | |
| id |
S | 1..1 | II | |
| sdtcIdentifiedBy |
0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |
| code |
0..1 | CE | Binding: CDARoleCode (example) | |
| addr |
C | 1..1 | AD | Constraints: should-country |
| telecom |
C | 0..* | TEL | Constraints: should-use |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @value |
0..1 | url | ||
| useablePeriod |
0..* | |||
| useablePeriod |
IVL_TS | |||
| useablePeriod |
EIVL_TS | |||
| useablePeriod |
PIVL_TS | |||
| useablePeriod |
SXPR_TS | |||
| @use |
S | 1..* | cs | Binding: TelecommunicationAddressUse (2.0.0) (required) |
| playingDevice |
0..1 | Device | ||
| playingEntity |
0..1 | PlayingEntity | ||
| scopingEntity |
0..1 | Entity | ||
| Slices for entryRelationship |
0..* | EntryRelationship | Slice: Unordered, Open by value:act.moodCode | |
| entryRelationship:plan |
0..* | EntryRelationship | Represents the Coverage Plan | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| 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 |
1..1 | Act | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| templateId |
0..* | II | ||
| @classCode |
1..1 | cs | Binding: XActClassDocumentEntryAct (2.0.0) (required) Fixed Value: ACT | |
| @moodCode |
1..1 | cs | Binding: XDocumentActMood (2.0.0) (required) Fixed Value: DEF | |
| @negationInd |
0..1 | bl | ||
| id |
1..1 | II | Plan identifier | |
| code |
1..1 | CD | Binding: v3 Code System ActCode (example) | |
| text |
1..1 | ED | Name of the plan | |
| statusCode |
0..1 | CS | Binding: ActStatus (required) | |
| effectiveTime |
0..1 | IVL_TS | ||
| priorityCode |
0..1 | CE | Binding: ActPriority (example) | |
| languageCode |
0..1 | CS | Binding: AllLanguages (required) | |
| subject |
0..1 | Subject | ||
| specimen |
0..* | Specimen | ||
| performer |
0..* | Performer2 | ||
| author |
0..* | Author | ||
| informant |
0..* | Informant | ||
| participant |
0..* | Participant2 | ||
| entryRelationship |
0..* | EntryRelationship | ||
| reference |
0..* | Reference | ||
| precondition |
0..* | Precondition | ||
| sdtcPrecondition2 |
0..* | Precondition2 | XML Namespace: urn:hl7-org:sdtc XML: precondition2 (urn:hl7-org:sdtc) | |
| sdtcInFulfillmentOf1 |
0..* | InFulfillmentOf1 | XML Namespace: urn:hl7-org:sdtc XML: inFulfillmentOf1 (urn:hl7-org:sdtc) | |
| 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 | ||
| sdtcPrecondition2 |
0..* | Precondition2 | XML Namespace: urn:hl7-org:sdtc XML: precondition2 (urn:hl7-org:sdtc) | |
| sdtcInFulfillmentOf1 |
0..* | InFulfillmentOf1 | XML Namespace: urn:hl7-org:sdtc XML: inFulfillmentOf1 (urn:hl7-org:sdtc) | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Act.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.templateId:payer-act.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.templateId:payers-entry.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.classCode | Base | required | x_ActClassDocumentEntryAct | 📍2.0.0 | THO v5.2 |
| Act.moodCode | Base | required | x_DocumentActMood | 📍2.0.0 | THO v5.2 |
| Act.code | Base | preferred | ActCoverageTypeCode | 📦3.0.0 | THO v6.5 |
| Act.text.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.text.compression | Base | required | CDACompressionAlgorithm | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.text.integrityCheckAlgorithm | Base | required | IntegrityCheckAlgorithm | 📍2.0.0 | THO v5.2 |
| Act.text.mediaType | Base | example | MediaType | 📦3.0.0 | THO v6.5 |
| Act.text.representation | Base | required | CDABinaryDataEncoding | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.statusCode | Base | required | ActStatus | 📦3.0.0 | THO v6.5 |
| Act.statusCode.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.priorityCode | Base | example | ActPriority | 📦3.0.0 | THO v6.5 |
| Act.languageCode | Base | required | All Languages | 📦5.0.0 | FHIR Std. |
| Act.performer:payer.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.performer:payer.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.performer:payer.​typeCode | Base | required | ParticipationPhysicalPerformer | 📦3.0.0 | THO v6.5 |
| Act.performer:payer.​assignedEntity.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.performer:payer.​assignedEntity.typeId.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.performer:payer.​assignedEntity.classCode | Base | required | RoleClassAssignedEntity | 📦3.0.0 | THO v6.5 |
| Act.performer:payer.​assignedEntity.code | Base | example | CDARoleCode | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.performer:payer.​assignedEntity.code.​code | Base | extensible | Payer Role Codes | 📦0.0.1-current | This IG |
| Act.performer:payer.​assignedEntity.telecom.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.performer:payer.​assignedEntity.telecom.​use | Base | required | TelecommunicationAddressUse | 📍2.0.0 | THO v5.2 |
| Act.performer:payer.​assignedEntity.representedOrganization.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.performer:payer.​assignedEntity.representedOrganization.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.performer:payer.​assignedEntity.representedOrganization.​classCode | Base | required | EntityClassOrganization | 📦3.0.0 | THO v6.5 |
| Act.performer:payer.​assignedEntity.representedOrganization.​determinerCode | Base | required | EntityDeterminer | 📦3.0.0 | THO v6.5 |
| Act.performer:payer.​assignedEntity.representedOrganization.​standardIndustryClassCode | Base | example | OrganizationIndustryClassNAICS | 📦3.0.0 | THO v6.5 |
| Act.performer:guarantor.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.performer:guarantor.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.performer:guarantor.​typeCode | Base | required | ParticipationPhysicalPerformer | 📦3.0.0 | THO v6.5 |
| Act.performer:guarantor.​assignedEntity.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.performer:guarantor.​assignedEntity.typeId.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.performer:guarantor.​assignedEntity.classCode | Base | required | RoleClassAssignedEntity | 📦3.0.0 | THO v6.5 |
| Act.performer:guarantor.​assignedEntity.code | Base | example | CDARoleCode | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.performer:guarantor.​assignedEntity.code.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.performer:guarantor.​assignedEntity.telecom.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.performer:guarantor.​assignedEntity.telecom.​use | Base | required | TelecommunicationAddressUse | 📍2.0.0 | THO v5.2 |
| Act.participant:member.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:member.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:member.​typeCode | Base | required | CDAParticipationType | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:member.​contextControlCode | Base | required | CDAContextControl | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:member.​time.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:member.​time.operator | Base | required | CDASetOperator | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:member.​participantRole.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:member.​participantRole.typeId.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:member.​participantRole.classCode | Base | required | CDARoleClassRoot | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:member.​participantRole.code | Base | example | CDARoleCode | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:member.​participantRole.code.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:member.​participantRole.code.​code | Base | extensible | Payer Role Codes | 📦0.0.1-current | This IG |
| Act.participant:member.​participantRole.telecom.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:member.​participantRole.telecom.​use | Base | required | TelecommunicationAddressUse | 📍2.0.0 | THO v5.2 |
| Act.participant:member.​participantRole.playingEntity.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:member.​participantRole.playingEntity.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:member.​participantRole.playingEntity.​classCode | Base | required | EntityClassRoot | 📦3.0.0 | THO v6.5 |
| Act.participant:member.​participantRole.playingEntity.​determinerCode | Base | required | EntityDeterminer | 📦3.0.0 | THO v6.5 |
| Act.participant:member.​participantRole.playingEntity.​code | Base | example | CDAEntityCode | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:subscriber.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:subscriber.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:subscriber.​typeCode | Base | required | CDAParticipationType | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:subscriber.​contextControlCode | Base | required | CDAContextControl | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:subscriber.​participantRole.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:subscriber.​participantRole.typeId.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:subscriber.​participantRole.classCode | Base | required | CDARoleClassRoot | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:subscriber.​participantRole.code | Base | example | CDARoleCode | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:subscriber.​participantRole.telecom.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:subscriber.​participantRole.telecom.​use | Base | required | TelecommunicationAddressUse | 📍2.0.0 | THO v5.2 |
| Act.entryRelationship:plan.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.entryRelationship:plan.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.entryRelationship:plan.​typeCode | Base | required | x_ActRelationshipEntryRelationship | 📦3.0.0 | THO v6.5 |
| Act.entryRelationship:plan.​act.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.entryRelationship:plan.​act.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.entryRelationship:plan.​act.classCode | Base | required | x_ActClassDocumentEntryAct | 📍2.0.0 | THO v5.2 |
| Act.entryRelationship:plan.​act.moodCode | Base | required | x_DocumentActMood | 📍2.0.0 | THO v5.2 |
| Act.entryRelationship:plan.​act.code | Base | example | v3 Code System ActCode | 📦3.0.0 | THO v6.5 |
| Act.entryRelationship:plan.​act.statusCode | Base | required | ActStatus | 📦3.0.0 | THO v6.5 |
| Act.entryRelationship:plan.​act.priorityCode | Base | example | ActPriority | 📦3.0.0 | THO v6.5 |
| Act.entryRelationship:plan.​act.languageCode | Base | required | All Languages | 📦5.0.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 4537-8967 | warning | Act.performer:guarantor.assignedEntity | **SHOULD** include assignedEntity/assignedPerson/name AND/OR assignedEntity/representedOrganization/name (CONF:4537-8967). |
assignedPerson.name.exists() or representedOrganization.name.exists()
|
| II-1 | error | Act.typeId, Act.performer:payer.typeId, Act.performer:payer.assignedEntity.typeId, Act.performer:payer.assignedEntity.representedOrganization.typeId, Act.performer:guarantor.typeId, Act.performer:guarantor.assignedEntity.typeId, Act.participant:member.typeId, Act.participant:member.participantRole.typeId, Act.participant:member.participantRole.playingEntity.typeId, Act.participant:subscriber.typeId, Act.participant:subscriber.participantRole.typeId, Act.entryRelationship:plan.typeId, Act.entryRelationship:plan.act.typeId | An II instance must have either a root or an nullFlavor. |
root.exists() or nullFlavor.exists()
|
| should-addr | warning | Act.performer:guarantor.assignedEntity, Act.participant:member.participantRole, Act.participant:subscriber.participantRole | SHOULD contain addr |
addr.exists()
|
| should-code | warning | Act.performer:payer.assignedEntity | SHOULD contain code |
code.exists()
|
| should-code-attr | warning | Act.participant:member.participantRole.code | SHOULD contain @code |
code.exists()
|
| should-country | warning | Act.performer:payer.assignedEntity.addr, Act.performer:guarantor.assignedEntity.addr, Act.participant:member.participantRole.addr, Act.participant:subscriber.participantRole.addr | SHOULD contain country |
|
| should-effectiveTime | warning | Act | SHOULD contain effectiveTime |
effectiveTime.exists()
|
| should-high | warning | Act.participant:member.time | SHOULD contain high |
high.exists()
|
| should-low | warning | Act.participant:member.time | SHOULD contain low |
low.exists()
|
| should-name | warning | Act.performer:payer.assignedEntity.representedOrganization | SHOULD contain name |
name.exists()
|
| should-playingEntity | warning | Act.participant:member.participantRole | SHOULD contain playingEntity |
playingEntity.exists()
|
| should-representedOrganization | warning | Act.performer:payer.assignedEntity | SHOULD contain representedOrganization |
representedOrganization.exists()
|
| should-telecom | warning | Act.performer:guarantor.assignedEntity | SHOULD contain telecom |
telecom.exists()
|
| should-text-ref-value | warning | Act | SHOULD contain text/reference/@value |
text.reference.value.exists()
|
| should-time | warning | Act.performer:guarantor, Act.participant:member | SHOULD contain time |
time.exists()
|
| should-use | warning | Act.performer:payer.assignedEntity.telecom, Act.performer:guarantor.assignedEntity.telecom, Act.participant:member.participantRole.telecom, Act.participant:subscriber.participantRole.telecom | SHOULD contain @use |
nullFlavor.exists() or use.exists()
|
| value-starts-octothorpe | error | Act.text.reference | If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative |
value.exists() implies value.startsWith('#')
|
This structure is derived from Act
Summary
Mandatory: 17 elements(18 nested mandatory elements)
Must-Support: 11 elements
Fixed: 8 elements
Prohibited: 1 element
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Act |
C | 1..1 | Act | XML Namespace: urn:hl7-org:v3 Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) Constraints: should-text-ref-value, should-effectiveTime |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| Slices for templateId |
2..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:payer-act |
1..1 | II | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.1.26 | |
| @extension |
0..1 | st | ||
| templateId:payers-entry |
1..1 | II | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Required Pattern: 1.3.6.1.4.1.19376.1.5.3.1.4.18 | |
| @extension |
0..1 | st | ||
| @classCode |
1..1 | cs | Binding: XActClassDocumentEntryAct (2.0.0) (required) Fixed Value: ACT | |
| @moodCode |
1..1 | cs | Binding: XDocumentActMood (2.0.0) (required) Fixed Value: EVN | |
| @negationInd |
0..1 | bl | ||
| id |
1..1 | II | ||
| code |
S | 1..1 | CD | Binding: ActCoverageTypeCode (preferred) |
| text |
0..1 | ED | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @compression |
0..1 | cs | Binding: CDACompressionAlgorithm (required) | |
| @integrityCheck |
0..1 | bin | ||
| @integrityCheckAlgorithm |
0..1 | cs | Binding: IntegrityCheckAlgorithm (2.0.0) (required) | |
| @language |
0..1 | cs | ||
| @mediaType |
0..1 | cs | Binding: MediaType (example) | |
| @representation |
0..1 | cs | Binding: CDABinaryDataEncoding (required) | |
| xmlText |
0..1 | st | Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string. | |
| reference |
C | 0..1 | TEL | Constraints: value-starts-octothorpe |
| thumbnail |
0..1 | ED | ||
| statusCode |
1..1 | CS | Binding: ActStatus (required) | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (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 (example) | |
| languageCode |
0..1 | CS | Binding: AllLanguages (required) | |
| subject |
0..1 | Subject | ||
| specimen |
0..* | Specimen | ||
| Slices for performer |
1..* | Performer2 | Slice: Unordered, Open by value:templateId.root | |
| performer:payer |
1..1 | Performer2 | This performer represents the Payer. | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| templateId |
0..* | II | ||
| @typeCode |
1..1 | cs | Binding: ParticipationPhysicalPerformer (required) Fixed Value: PRF | |
| 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 | Constraints: should-code, should-representedOrganization |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| templateId |
0..* | II | ||
| @classCode |
S | 1..1 | cs | Binding: RoleClassAssignedEntity (required) Fixed Value: ASSIGNED |
| id |
S | 1..* | II | |
| sdtcIdentifiedBy |
0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |
| code |
0..1 | CE | Binding: CDARoleCode (example) | |
| @code |
1..1 | cs | Binding: Payer Role Codes (extensible) | |
| @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 | 1..1 | AD | Constraints: should-country |
| telecom |
C | 0..* | TEL | Constraints: should-use |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @value |
0..1 | url | ||
| useablePeriod |
0..* | |||
| useablePeriod |
IVL_TS | |||
| useablePeriod |
EIVL_TS | |||
| useablePeriod |
PIVL_TS | |||
| useablePeriod |
SXPR_TS | |||
| @use |
S | 1..* | cs | Binding: TelecommunicationAddressUse (2.0.0) (required) |
| assignedPerson |
0..1 | Person | ||
| representedOrganization |
C | 0..1 | Organization | Constraints: should-name |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| templateId |
0..* | II | ||
| @classCode |
1..1 | cs | Binding: EntityClassOrganization (required) Fixed Value: ORG | |
| @determinerCode |
0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
| id |
0..* | II | ||
| name |
1..1 | ON | ||
| telecom |
0..* | TEL | ||
| addr |
0..* | AD | ||
| standardIndustryClassCode |
0..1 | CE | Binding: OrganizationIndustryClassNAICS (example) | |
| asOrganizationPartOf |
0..1 | OrganizationPartOf | ||
| sdtcPatient |
0..1 | Base | XML Namespace: urn:hl7-org:sdtc XML: patient (urn:hl7-org:sdtc) | |
| id |
1..1 | II | XML Namespace: urn:hl7-org:sdtc XML Namespace: urn:hl7-org:sdtc | |
| performer:guarantor |
C | 0..* | Performer2 | This performer represents the Guarantor. Constraints: should-time |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| templateId |
0..* | II | ||
| @typeCode |
1..1 | cs | Binding: ParticipationPhysicalPerformer (required) Fixed Value: PRF | |
| 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 | Constraints: 4537-8967, should-addr, should-telecom |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| templateId |
0..* | II | ||
| @classCode |
0..1 | cs | Binding: RoleClassAssignedEntity (required) Fixed Value: ASSIGNED | |
| id |
1..* | II | ||
| sdtcIdentifiedBy |
0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |
| code |
1..1 | CE | Binding: CDARoleCode (example) | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (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 | AD | Constraints: should-country |
| telecom |
C | 0..* | TEL | Constraints: should-use |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @value |
0..1 | url | ||
| useablePeriod |
0..* | |||
| useablePeriod |
IVL_TS | |||
| useablePeriod |
EIVL_TS | |||
| useablePeriod |
PIVL_TS | |||
| useablePeriod |
SXPR_TS | |||
| @use |
S | 1..* | cs | Binding: TelecommunicationAddressUse (2.0.0) (required) |
| assignedPerson |
0..1 | Person | ||
| representedOrganization |
0..1 | Organization | ||
| sdtcPatient |
0..1 | Base | XML Namespace: urn:hl7-org:sdtc XML: patient (urn:hl7-org:sdtc) | |
| id |
1..1 | II | XML Namespace: urn:hl7-org:sdtc XML Namespace: urn:hl7-org:sdtc | |
| author |
0..* | Author | ||
| informant |
0..* | Informant | ||
| Slices for participant |
1..* | Participant2 | Slice: Unordered, Open by value:typeCode | |
| participant:member |
C | 1..1 | Participant2 | participant Constraints: should-time |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| templateId |
0..* | II | ||
| @typeCode |
1..1 | cs | Binding: CDAParticipationType (required) Fixed Value: COV | |
| @contextControlCode |
0..1 | cs | Binding: CDAContextControl (required) Fixed Value: OP | |
| sdtcFunctionCode |
0..1 | CE | XML Namespace: urn:hl7-org:sdtc XML: functionCode (urn:hl7-org:sdtc) | |
| time |
C | 0..1 | IVL_TS | This records the policy coverage period or self-pay period. Constraints: should-low, should-high |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @value |
0..1 | ts | Date Format: YYYYMMDDHHMMSS.UUUU[+|-ZZzz] | |
| @operator |
0..1 | cs | Binding: CDASetOperator (required) | |
| low |
0..1 | IVXB_TS | ||
| center |
0..1 | TS | ||
| width |
0..1 | PQ | ||
| high |
0..1 | IVXB_TS | SHOULD contain high | |
| awarenessCode |
0..1 | CE | ||
| participantRole |
C | 1..1 | ParticipantRole | Constraints: should-addr, should-playingEntity |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| templateId |
0..* | II | ||
| @classCode |
0..1 | cs | Binding: CDARoleClassRoot (required) | |
| id |
S | 1..* | II | |
| sdtcIdentifiedBy |
0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |
| code |
SC | 1..1 | CE | Binding: CDARoleCode (example) Constraints: should-code-attr |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @code |
0..1 | cs | Binding: Payer Role Codes (extensible) | |
| @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 |
SC | 1..1 | AD | Constraints: should-country |
| telecom |
C | 0..* | TEL | Constraints: should-use |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @value |
0..1 | url | ||
| useablePeriod |
0..* | |||
| useablePeriod |
IVL_TS | |||
| useablePeriod |
EIVL_TS | |||
| useablePeriod |
PIVL_TS | |||
| useablePeriod |
SXPR_TS | |||
| @use |
S | 1..* | cs | Binding: TelecommunicationAddressUse (2.0.0) (required) |
| playingDevice |
0..1 | Device | ||
| playingEntity |
0..1 | PlayingEntity | This playingEntity records the covered party name and birthTime as represented by the health plan. This could match the information in recordTarget, or be different due to marriage or other reasons. | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| templateId |
0..* | II | ||
| @classCode |
0..1 | cs | Binding: EntityClassRoot (required) | |
| @determinerCode |
0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
| code |
0..1 | CE | Binding: CDAEntityCode (example) | |
| quantity |
0..* | PQ | ||
| name |
1..1 | PN | ||
| sdtcBirthTime |
1..1 | TS | XML Namespace: urn:hl7-org:sdtc sdtc:birthTime XML: birthTime (urn:hl7-org:sdtc) | |
| desc |
0..1 | ED | ||
| scopingEntity |
0..1 | Entity | ||
| participant:subscriber |
0..1 | 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. | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| templateId |
0..* | II | ||
| @typeCode |
1..1 | cs | Binding: CDAParticipationType (required) Fixed Value: HLD | |
| @contextControlCode |
0..1 | cs | Binding: CDAContextControl (required) Fixed Value: OP | |
| 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 |
C | 1..1 | ParticipantRole | Constraints: should-addr |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| templateId |
0..* | II | ||
| @classCode |
0..1 | cs | Binding: CDARoleClassRoot (required) | |
| id |
S | 1..1 | II | |
| sdtcIdentifiedBy |
0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |
| code |
0..1 | CE | Binding: CDARoleCode (example) | |
| addr |
C | 1..1 | AD | Constraints: should-country |
| telecom |
C | 0..* | TEL | Constraints: should-use |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @value |
0..1 | url | ||
| useablePeriod |
0..* | |||
| useablePeriod |
IVL_TS | |||
| useablePeriod |
EIVL_TS | |||
| useablePeriod |
PIVL_TS | |||
| useablePeriod |
SXPR_TS | |||
| @use |
S | 1..* | cs | Binding: TelecommunicationAddressUse (2.0.0) (required) |
| playingDevice |
0..1 | Device | ||
| playingEntity |
0..1 | PlayingEntity | ||
| scopingEntity |
0..1 | Entity | ||
| Slices for entryRelationship |
0..* | EntryRelationship | Slice: Unordered, Open by value:act.moodCode | |
| entryRelationship:plan |
0..* | EntryRelationship | Represents the Coverage Plan | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| 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 |
1..1 | Act | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| templateId |
0..* | II | ||
| @classCode |
1..1 | cs | Binding: XActClassDocumentEntryAct (2.0.0) (required) Fixed Value: ACT | |
| @moodCode |
1..1 | cs | Binding: XDocumentActMood (2.0.0) (required) Fixed Value: DEF | |
| @negationInd |
0..1 | bl | ||
| id |
1..1 | II | Plan identifier | |
| code |
1..1 | CD | Binding: v3 Code System ActCode (example) | |
| text |
1..1 | ED | Name of the plan | |
| statusCode |
0..1 | CS | Binding: ActStatus (required) | |
| effectiveTime |
0..1 | IVL_TS | ||
| priorityCode |
0..1 | CE | Binding: ActPriority (example) | |
| languageCode |
0..1 | CS | Binding: AllLanguages (required) | |
| subject |
0..1 | Subject | ||
| specimen |
0..* | Specimen | ||
| performer |
0..* | Performer2 | ||
| author |
0..* | Author | ||
| informant |
0..* | Informant | ||
| participant |
0..* | Participant2 | ||
| entryRelationship |
0..* | EntryRelationship | ||
| reference |
0..* | Reference | ||
| precondition |
0..* | Precondition | ||
| sdtcPrecondition2 |
0..* | Precondition2 | XML Namespace: urn:hl7-org:sdtc XML: precondition2 (urn:hl7-org:sdtc) | |
| sdtcInFulfillmentOf1 |
0..* | InFulfillmentOf1 | XML Namespace: urn:hl7-org:sdtc XML: inFulfillmentOf1 (urn:hl7-org:sdtc) | |
| 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 | ||
| sdtcPrecondition2 |
0..* | Precondition2 | XML Namespace: urn:hl7-org:sdtc XML: precondition2 (urn:hl7-org:sdtc) | |
| sdtcInFulfillmentOf1 |
0..* | InFulfillmentOf1 | XML Namespace: urn:hl7-org:sdtc XML: inFulfillmentOf1 (urn:hl7-org:sdtc) | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Act.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.templateId:payer-act.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.templateId:payers-entry.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.classCode | Base | required | x_ActClassDocumentEntryAct | 📍2.0.0 | THO v5.2 |
| Act.moodCode | Base | required | x_DocumentActMood | 📍2.0.0 | THO v5.2 |
| Act.code | Base | preferred | ActCoverageTypeCode | 📦3.0.0 | THO v6.5 |
| Act.text.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.text.compression | Base | required | CDACompressionAlgorithm | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.text.integrityCheckAlgorithm | Base | required | IntegrityCheckAlgorithm | 📍2.0.0 | THO v5.2 |
| Act.text.mediaType | Base | example | MediaType | 📦3.0.0 | THO v6.5 |
| Act.text.representation | Base | required | CDABinaryDataEncoding | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.statusCode | Base | required | ActStatus | 📦3.0.0 | THO v6.5 |
| Act.statusCode.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.priorityCode | Base | example | ActPriority | 📦3.0.0 | THO v6.5 |
| Act.languageCode | Base | required | All Languages | 📦5.0.0 | FHIR Std. |
| Act.performer:payer.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.performer:payer.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.performer:payer.​typeCode | Base | required | ParticipationPhysicalPerformer | 📦3.0.0 | THO v6.5 |
| Act.performer:payer.​assignedEntity.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.performer:payer.​assignedEntity.typeId.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.performer:payer.​assignedEntity.classCode | Base | required | RoleClassAssignedEntity | 📦3.0.0 | THO v6.5 |
| Act.performer:payer.​assignedEntity.code | Base | example | CDARoleCode | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.performer:payer.​assignedEntity.code.​code | Base | extensible | Payer Role Codes | 📦0.0.1-current | This IG |
| Act.performer:payer.​assignedEntity.telecom.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.performer:payer.​assignedEntity.telecom.​use | Base | required | TelecommunicationAddressUse | 📍2.0.0 | THO v5.2 |
| Act.performer:payer.​assignedEntity.representedOrganization.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.performer:payer.​assignedEntity.representedOrganization.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.performer:payer.​assignedEntity.representedOrganization.​classCode | Base | required | EntityClassOrganization | 📦3.0.0 | THO v6.5 |
| Act.performer:payer.​assignedEntity.representedOrganization.​determinerCode | Base | required | EntityDeterminer | 📦3.0.0 | THO v6.5 |
| Act.performer:payer.​assignedEntity.representedOrganization.​standardIndustryClassCode | Base | example | OrganizationIndustryClassNAICS | 📦3.0.0 | THO v6.5 |
| Act.performer:guarantor.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.performer:guarantor.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.performer:guarantor.​typeCode | Base | required | ParticipationPhysicalPerformer | 📦3.0.0 | THO v6.5 |
| Act.performer:guarantor.​assignedEntity.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.performer:guarantor.​assignedEntity.typeId.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.performer:guarantor.​assignedEntity.classCode | Base | required | RoleClassAssignedEntity | 📦3.0.0 | THO v6.5 |
| Act.performer:guarantor.​assignedEntity.code | Base | example | CDARoleCode | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.performer:guarantor.​assignedEntity.code.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.performer:guarantor.​assignedEntity.telecom.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.performer:guarantor.​assignedEntity.telecom.​use | Base | required | TelecommunicationAddressUse | 📍2.0.0 | THO v5.2 |
| Act.participant:member.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:member.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:member.​typeCode | Base | required | CDAParticipationType | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:member.​contextControlCode | Base | required | CDAContextControl | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:member.​time.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:member.​time.operator | Base | required | CDASetOperator | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:member.​participantRole.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:member.​participantRole.typeId.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:member.​participantRole.classCode | Base | required | CDARoleClassRoot | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:member.​participantRole.code | Base | example | CDARoleCode | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:member.​participantRole.code.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:member.​participantRole.code.​code | Base | extensible | Payer Role Codes | 📦0.0.1-current | This IG |
| Act.participant:member.​participantRole.telecom.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:member.​participantRole.telecom.​use | Base | required | TelecommunicationAddressUse | 📍2.0.0 | THO v5.2 |
| Act.participant:member.​participantRole.playingEntity.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:member.​participantRole.playingEntity.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:member.​participantRole.playingEntity.​classCode | Base | required | EntityClassRoot | 📦3.0.0 | THO v6.5 |
| Act.participant:member.​participantRole.playingEntity.​determinerCode | Base | required | EntityDeterminer | 📦3.0.0 | THO v6.5 |
| Act.participant:member.​participantRole.playingEntity.​code | Base | example | CDAEntityCode | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:subscriber.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:subscriber.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:subscriber.​typeCode | Base | required | CDAParticipationType | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:subscriber.​contextControlCode | Base | required | CDAContextControl | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:subscriber.​participantRole.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:subscriber.​participantRole.typeId.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:subscriber.​participantRole.classCode | Base | required | CDARoleClassRoot | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:subscriber.​participantRole.code | Base | example | CDARoleCode | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:subscriber.​participantRole.telecom.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:subscriber.​participantRole.telecom.​use | Base | required | TelecommunicationAddressUse | 📍2.0.0 | THO v5.2 |
| Act.entryRelationship:plan.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.entryRelationship:plan.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.entryRelationship:plan.​typeCode | Base | required | x_ActRelationshipEntryRelationship | 📦3.0.0 | THO v6.5 |
| Act.entryRelationship:plan.​act.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.entryRelationship:plan.​act.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.entryRelationship:plan.​act.classCode | Base | required | x_ActClassDocumentEntryAct | 📍2.0.0 | THO v5.2 |
| Act.entryRelationship:plan.​act.moodCode | Base | required | x_DocumentActMood | 📍2.0.0 | THO v5.2 |
| Act.entryRelationship:plan.​act.code | Base | example | v3 Code System ActCode | 📦3.0.0 | THO v6.5 |
| Act.entryRelationship:plan.​act.statusCode | Base | required | ActStatus | 📦3.0.0 | THO v6.5 |
| Act.entryRelationship:plan.​act.priorityCode | Base | example | ActPriority | 📦3.0.0 | THO v6.5 |
| Act.entryRelationship:plan.​act.languageCode | Base | required | All Languages | 📦5.0.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 4537-8967 | warning | Act.performer:guarantor.assignedEntity | **SHOULD** include assignedEntity/assignedPerson/name AND/OR assignedEntity/representedOrganization/name (CONF:4537-8967). |
assignedPerson.name.exists() or representedOrganization.name.exists()
|
| II-1 | error | Act.typeId, Act.performer:payer.typeId, Act.performer:payer.assignedEntity.typeId, Act.performer:payer.assignedEntity.representedOrganization.typeId, Act.performer:guarantor.typeId, Act.performer:guarantor.assignedEntity.typeId, Act.participant:member.typeId, Act.participant:member.participantRole.typeId, Act.participant:member.participantRole.playingEntity.typeId, Act.participant:subscriber.typeId, Act.participant:subscriber.participantRole.typeId, Act.entryRelationship:plan.typeId, Act.entryRelationship:plan.act.typeId | An II instance must have either a root or an nullFlavor. |
root.exists() or nullFlavor.exists()
|
| should-addr | warning | Act.performer:guarantor.assignedEntity, Act.participant:member.participantRole, Act.participant:subscriber.participantRole | SHOULD contain addr |
addr.exists()
|
| should-code | warning | Act.performer:payer.assignedEntity | SHOULD contain code |
code.exists()
|
| should-code-attr | warning | Act.participant:member.participantRole.code | SHOULD contain @code |
code.exists()
|
| should-country | warning | Act.performer:payer.assignedEntity.addr, Act.performer:guarantor.assignedEntity.addr, Act.participant:member.participantRole.addr, Act.participant:subscriber.participantRole.addr | SHOULD contain country |
|
| should-effectiveTime | warning | Act | SHOULD contain effectiveTime |
effectiveTime.exists()
|
| should-high | warning | Act.participant:member.time | SHOULD contain high |
high.exists()
|
| should-low | warning | Act.participant:member.time | SHOULD contain low |
low.exists()
|
| should-name | warning | Act.performer:payer.assignedEntity.representedOrganization | SHOULD contain name |
name.exists()
|
| should-playingEntity | warning | Act.participant:member.participantRole | SHOULD contain playingEntity |
playingEntity.exists()
|
| should-representedOrganization | warning | Act.performer:payer.assignedEntity | SHOULD contain representedOrganization |
representedOrganization.exists()
|
| should-telecom | warning | Act.performer:guarantor.assignedEntity | SHOULD contain telecom |
telecom.exists()
|
| should-text-ref-value | warning | Act | SHOULD contain text/reference/@value |
text.reference.value.exists()
|
| should-time | warning | Act.performer:guarantor, Act.participant:member | SHOULD contain time |
time.exists()
|
| should-use | warning | Act.performer:payer.assignedEntity.telecom, Act.performer:guarantor.assignedEntity.telecom, Act.participant:member.participantRole.telecom, Act.participant:subscriber.participantRole.telecom | SHOULD contain @use |
nullFlavor.exists() or use.exists()
|
| value-starts-octothorpe | error | Act.text.reference | If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative |
value.exists() implies value.startsWith('#')
|
Differential View
This structure is derived from Act
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Act |
C | 1..1 | Act | XML Namespace: urn:hl7-org:v3 Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) Constraints: should-text-ref-value, should-effectiveTime |
| Slices for templateId |
2..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:payer-act |
1..1 | II | ||
| @root |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.1.26 | |
| templateId:payers-entry |
1..1 | II | ||
| @root |
1..1 | oid, uuid, ruid | Required Pattern: 1.3.6.1.4.1.19376.1.5.3.1.4.18 | |
| @classCode |
1..1 | cs | Fixed Value: ACT | |
| @moodCode |
1..1 | cs | Fixed Value: EVN | |
| id |
1..1 | II | ||
| code |
S | 1..1 | CD | Binding: ActCoverageTypeCode (preferred) |
| text |
||||
| reference |
C | 0..1 | TEL | Constraints: value-starts-octothorpe |
| statusCode |
1..1 | CS | ||
| @code |
1..1 | cs | Fixed Value: completed | |
| Slices for performer |
1..* | Performer2 | Slice: Unordered, Open by value:templateId.root | |
| performer:payer |
1..1 | Performer2 | This performer represents the Payer. | |
| @typeCode |
1..1 | cs | ||
| assignedEntity |
C | 1..1 | AssignedEntity | Constraints: should-code, should-representedOrganization |
| @classCode |
S | 1..1 | cs | |
| id |
S | 1..* | II | |
| code |
0..1 | CE | ||
| @nullFlavor |
0..0 | |||
| @code |
1..1 | cs | Binding: Payer Role Codes (extensible) | |
| addr |
C | 1..1 | AD | Constraints: should-country |
| telecom |
C | 0..* | TEL | Constraints: should-use |
| @use |
S | 1..* | cs | |
| representedOrganization |
C | 0..1 | Organization | Constraints: should-name |
| @classCode |
1..1 | cs | ||
| name |
1..1 | ON | ||
| performer:guarantor |
C | 0..* | Performer2 | This performer represents the Guarantor. Constraints: should-time |
| @typeCode |
1..1 | cs | ||
| time |
0..1 | IVL_TS | ||
| assignedEntity |
C | 1..1 | AssignedEntity | Constraints: 4537-8967, should-addr, should-telecom |
| 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 |
C | 0..1 | AD | Constraints: should-country |
| telecom |
C | 0..* | TEL | Constraints: should-use |
| @use |
S | 1..* | cs | |
| Slices for participant |
1..* | Participant2 | Slice: Unordered, Open by value:typeCode | |
| participant:member |
C | 1..1 | Participant2 | participant Constraints: should-time |
| @typeCode |
1..1 | cs | Fixed Value: COV | |
| time |
C | 0..1 | IVL_TS | This records the policy coverage period or self-pay period. Constraints: should-low, should-high |
| low |
0..1 | IVXB_TS | ||
| high |
0..1 | IVXB_TS | SHOULD contain high | |
| participantRole |
C | 1..1 | ParticipantRole | Constraints: should-addr, should-playingEntity |
| id |
S | 1..* | II | |
| code |
SC | 1..1 | CE | Constraints: should-code-attr |
| @code |
0..1 | cs | Binding: Payer Role Codes (extensible) | |
| addr |
SC | 1..1 | AD | Constraints: should-country |
| telecom |
C | 0..* | TEL | Constraints: should-use |
| @use |
S | 1..* | cs | |
| playingEntity |
0..1 | PlayingEntity | This playingEntity records the covered party name and birthTime as represented by the health plan. This could match the information in recordTarget, or be different due to marriage or other reasons. | |
| name |
1..1 | PN | ||
| sdtcBirthTime |
1..1 | TS | sdtc:birthTime | |
| participant:subscriber |
0..1 | 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. | |
| @typeCode |
1..1 | cs | Fixed Value: HLD | |
| time |
0..1 | IVL_TS | ||
| participantRole |
C | 1..1 | ParticipantRole | Constraints: should-addr |
| id |
S | 1..1 | II | |
| addr |
C | 1..1 | AD | Constraints: should-country |
| telecom |
C | 0..* | TEL | Constraints: should-use |
| @use |
S | 1..* | cs | |
| Slices for entryRelationship |
0..* | EntryRelationship | Slice: Unordered, Open by value:act.moodCode | |
| entryRelationship:plan |
0..* | EntryRelationship | Represents the Coverage Plan | |
| @typeCode |
1..1 | cs | Fixed Value: REFR | |
| act |
1..1 | Act | ||
| @classCode |
1..1 | cs | Fixed Value: ACT | |
| @moodCode |
1..1 | cs | Fixed Value: DEF | |
| id |
1..1 | II | Plan identifier | |
| text |
1..1 | ED | Name of the plan | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Act.code | Base | preferred | ActCoverageTypeCode | 📦3.0.0 | THO v6.5 |
| Act.performer:payer.​assignedEntity.code.​code | Base | extensible | Payer Role Codes | 📦0.0.1-current | This IG |
| Act.participant:member.​participantRole.code.​code | Base | extensible | Payer Role Codes | 📦0.0.1-current | This IG |
| Id | Grade | Path(s) | Description | Expression |
| 4537-8967 | warning | Act.performer:guarantor.assignedEntity | **SHOULD** include assignedEntity/assignedPerson/name AND/OR assignedEntity/representedOrganization/name (CONF:4537-8967). |
assignedPerson.name.exists() or representedOrganization.name.exists()
|
| should-addr | warning | Act.performer:guarantor.assignedEntity, Act.participant:member.participantRole, Act.participant:subscriber.participantRole | SHOULD contain addr |
addr.exists()
|
| should-code | warning | Act.performer:payer.assignedEntity | SHOULD contain code |
code.exists()
|
| should-code-attr | warning | Act.participant:member.participantRole.code | SHOULD contain @code |
code.exists()
|
| should-country | warning | Act.performer:payer.assignedEntity.addr, Act.performer:guarantor.assignedEntity.addr, Act.participant:member.participantRole.addr, Act.participant:subscriber.participantRole.addr | SHOULD contain country |
|
| should-effectiveTime | warning | Act | SHOULD contain effectiveTime |
effectiveTime.exists()
|
| should-high | warning | Act.participant:member.time | SHOULD contain high |
high.exists()
|
| should-low | warning | Act.participant:member.time | SHOULD contain low |
low.exists()
|
| should-name | warning | Act.performer:payer.assignedEntity.representedOrganization | SHOULD contain name |
name.exists()
|
| should-playingEntity | warning | Act.participant:member.participantRole | SHOULD contain playingEntity |
playingEntity.exists()
|
| should-representedOrganization | warning | Act.performer:payer.assignedEntity | SHOULD contain representedOrganization |
representedOrganization.exists()
|
| should-telecom | warning | Act.performer:guarantor.assignedEntity | SHOULD contain telecom |
telecom.exists()
|
| should-text-ref-value | warning | Act | SHOULD contain text/reference/@value |
text.reference.value.exists()
|
| should-time | warning | Act.performer:guarantor, Act.participant:member | SHOULD contain time |
time.exists()
|
| should-use | warning | Act.performer:payer.assignedEntity.telecom, Act.performer:guarantor.assignedEntity.telecom, Act.participant:member.participantRole.telecom, Act.participant:subscriber.participantRole.telecom | SHOULD contain @use |
nullFlavor.exists() or use.exists()
|
| value-starts-octothorpe | error | Act.text.reference | If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative |
value.exists() implies value.startsWith('#')
|
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Act |
C | 1..1 | Act | XML Namespace: urn:hl7-org:v3 Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) Constraints: should-text-ref-value, should-effectiveTime |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| Slices for templateId |
2..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:payer-act |
1..1 | II | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.1.26 | |
| @extension |
0..1 | st | ||
| templateId:payers-entry |
1..1 | II | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Required Pattern: 1.3.6.1.4.1.19376.1.5.3.1.4.18 | |
| @extension |
0..1 | st | ||
| @classCode |
1..1 | cs | Binding: XActClassDocumentEntryAct (2.0.0) (required) Fixed Value: ACT | |
| @moodCode |
1..1 | cs | Binding: XDocumentActMood (2.0.0) (required) Fixed Value: EVN | |
| @negationInd |
0..1 | bl | ||
| id |
1..1 | II | ||
| code |
S | 1..1 | CD | Binding: ActCoverageTypeCode (preferred) |
| text |
0..1 | ED | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @compression |
0..1 | cs | Binding: CDACompressionAlgorithm (required) | |
| @integrityCheck |
0..1 | bin | ||
| @integrityCheckAlgorithm |
0..1 | cs | Binding: IntegrityCheckAlgorithm (2.0.0) (required) | |
| @language |
0..1 | cs | ||
| @mediaType |
0..1 | cs | Binding: MediaType (example) | |
| @representation |
0..1 | cs | Binding: CDABinaryDataEncoding (required) | |
| xmlText |
0..1 | st | Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string. | |
| reference |
C | 0..1 | TEL | Constraints: value-starts-octothorpe |
| thumbnail |
0..1 | ED | ||
| statusCode |
1..1 | CS | Binding: ActStatus (required) | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (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 (example) | |
| languageCode |
0..1 | CS | Binding: AllLanguages (required) | |
| subject |
0..1 | Subject | ||
| specimen |
0..* | Specimen | ||
| Slices for performer |
1..* | Performer2 | Slice: Unordered, Open by value:templateId.root | |
| performer:payer |
1..1 | Performer2 | This performer represents the Payer. | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| templateId |
0..* | II | ||
| @typeCode |
1..1 | cs | Binding: ParticipationPhysicalPerformer (required) Fixed Value: PRF | |
| 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 | Constraints: should-code, should-representedOrganization |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| templateId |
0..* | II | ||
| @classCode |
S | 1..1 | cs | Binding: RoleClassAssignedEntity (required) Fixed Value: ASSIGNED |
| id |
S | 1..* | II | |
| sdtcIdentifiedBy |
0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |
| code |
0..1 | CE | Binding: CDARoleCode (example) | |
| @code |
1..1 | cs | Binding: Payer Role Codes (extensible) | |
| @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 | 1..1 | AD | Constraints: should-country |
| telecom |
C | 0..* | TEL | Constraints: should-use |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @value |
0..1 | url | ||
| useablePeriod |
0..* | |||
| useablePeriod |
IVL_TS | |||
| useablePeriod |
EIVL_TS | |||
| useablePeriod |
PIVL_TS | |||
| useablePeriod |
SXPR_TS | |||
| @use |
S | 1..* | cs | Binding: TelecommunicationAddressUse (2.0.0) (required) |
| assignedPerson |
0..1 | Person | ||
| representedOrganization |
C | 0..1 | Organization | Constraints: should-name |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| templateId |
0..* | II | ||
| @classCode |
1..1 | cs | Binding: EntityClassOrganization (required) Fixed Value: ORG | |
| @determinerCode |
0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
| id |
0..* | II | ||
| name |
1..1 | ON | ||
| telecom |
0..* | TEL | ||
| addr |
0..* | AD | ||
| standardIndustryClassCode |
0..1 | CE | Binding: OrganizationIndustryClassNAICS (example) | |
| asOrganizationPartOf |
0..1 | OrganizationPartOf | ||
| sdtcPatient |
0..1 | Base | XML Namespace: urn:hl7-org:sdtc XML: patient (urn:hl7-org:sdtc) | |
| id |
1..1 | II | XML Namespace: urn:hl7-org:sdtc XML Namespace: urn:hl7-org:sdtc | |
| performer:guarantor |
C | 0..* | Performer2 | This performer represents the Guarantor. Constraints: should-time |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| templateId |
0..* | II | ||
| @typeCode |
1..1 | cs | Binding: ParticipationPhysicalPerformer (required) Fixed Value: PRF | |
| 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 | Constraints: 4537-8967, should-addr, should-telecom |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| templateId |
0..* | II | ||
| @classCode |
0..1 | cs | Binding: RoleClassAssignedEntity (required) Fixed Value: ASSIGNED | |
| id |
1..* | II | ||
| sdtcIdentifiedBy |
0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |
| code |
1..1 | CE | Binding: CDARoleCode (example) | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (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 | AD | Constraints: should-country |
| telecom |
C | 0..* | TEL | Constraints: should-use |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @value |
0..1 | url | ||
| useablePeriod |
0..* | |||
| useablePeriod |
IVL_TS | |||
| useablePeriod |
EIVL_TS | |||
| useablePeriod |
PIVL_TS | |||
| useablePeriod |
SXPR_TS | |||
| @use |
S | 1..* | cs | Binding: TelecommunicationAddressUse (2.0.0) (required) |
| assignedPerson |
0..1 | Person | ||
| representedOrganization |
0..1 | Organization | ||
| sdtcPatient |
0..1 | Base | XML Namespace: urn:hl7-org:sdtc XML: patient (urn:hl7-org:sdtc) | |
| id |
1..1 | II | XML Namespace: urn:hl7-org:sdtc XML Namespace: urn:hl7-org:sdtc | |
| author |
0..* | Author | ||
| informant |
0..* | Informant | ||
| Slices for participant |
1..* | Participant2 | Slice: Unordered, Open by value:typeCode | |
| participant:member |
C | 1..1 | Participant2 | participant Constraints: should-time |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| templateId |
0..* | II | ||
| @typeCode |
1..1 | cs | Binding: CDAParticipationType (required) Fixed Value: COV | |
| @contextControlCode |
0..1 | cs | Binding: CDAContextControl (required) Fixed Value: OP | |
| sdtcFunctionCode |
0..1 | CE | XML Namespace: urn:hl7-org:sdtc XML: functionCode (urn:hl7-org:sdtc) | |
| time |
C | 0..1 | IVL_TS | This records the policy coverage period or self-pay period. Constraints: should-low, should-high |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @value |
0..1 | ts | Date Format: YYYYMMDDHHMMSS.UUUU[+|-ZZzz] | |
| @operator |
0..1 | cs | Binding: CDASetOperator (required) | |
| low |
0..1 | IVXB_TS | ||
| center |
0..1 | TS | ||
| width |
0..1 | PQ | ||
| high |
0..1 | IVXB_TS | SHOULD contain high | |
| awarenessCode |
0..1 | CE | ||
| participantRole |
C | 1..1 | ParticipantRole | Constraints: should-addr, should-playingEntity |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| templateId |
0..* | II | ||
| @classCode |
0..1 | cs | Binding: CDARoleClassRoot (required) | |
| id |
S | 1..* | II | |
| sdtcIdentifiedBy |
0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |
| code |
SC | 1..1 | CE | Binding: CDARoleCode (example) Constraints: should-code-attr |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @code |
0..1 | cs | Binding: Payer Role Codes (extensible) | |
| @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 |
SC | 1..1 | AD | Constraints: should-country |
| telecom |
C | 0..* | TEL | Constraints: should-use |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @value |
0..1 | url | ||
| useablePeriod |
0..* | |||
| useablePeriod |
IVL_TS | |||
| useablePeriod |
EIVL_TS | |||
| useablePeriod |
PIVL_TS | |||
| useablePeriod |
SXPR_TS | |||
| @use |
S | 1..* | cs | Binding: TelecommunicationAddressUse (2.0.0) (required) |
| playingDevice |
0..1 | Device | ||
| playingEntity |
0..1 | PlayingEntity | This playingEntity records the covered party name and birthTime as represented by the health plan. This could match the information in recordTarget, or be different due to marriage or other reasons. | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| templateId |
0..* | II | ||
| @classCode |
0..1 | cs | Binding: EntityClassRoot (required) | |
| @determinerCode |
0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
| code |
0..1 | CE | Binding: CDAEntityCode (example) | |
| quantity |
0..* | PQ | ||
| name |
1..1 | PN | ||
| sdtcBirthTime |
1..1 | TS | XML Namespace: urn:hl7-org:sdtc sdtc:birthTime XML: birthTime (urn:hl7-org:sdtc) | |
| desc |
0..1 | ED | ||
| scopingEntity |
0..1 | Entity | ||
| participant:subscriber |
0..1 | 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. | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| templateId |
0..* | II | ||
| @typeCode |
1..1 | cs | Binding: CDAParticipationType (required) Fixed Value: HLD | |
| @contextControlCode |
0..1 | cs | Binding: CDAContextControl (required) Fixed Value: OP | |
| 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 |
C | 1..1 | ParticipantRole | Constraints: should-addr |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| templateId |
0..* | II | ||
| @classCode |
0..1 | cs | Binding: CDARoleClassRoot (required) | |
| id |
S | 1..1 | II | |
| sdtcIdentifiedBy |
0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |
| code |
0..1 | CE | Binding: CDARoleCode (example) | |
| addr |
C | 1..1 | AD | Constraints: should-country |
| telecom |
C | 0..* | TEL | Constraints: should-use |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @value |
0..1 | url | ||
| useablePeriod |
0..* | |||
| useablePeriod |
IVL_TS | |||
| useablePeriod |
EIVL_TS | |||
| useablePeriod |
PIVL_TS | |||
| useablePeriod |
SXPR_TS | |||
| @use |
S | 1..* | cs | Binding: TelecommunicationAddressUse (2.0.0) (required) |
| playingDevice |
0..1 | Device | ||
| playingEntity |
0..1 | PlayingEntity | ||
| scopingEntity |
0..1 | Entity | ||
| Slices for entryRelationship |
0..* | EntryRelationship | Slice: Unordered, Open by value:act.moodCode | |
| entryRelationship:plan |
0..* | EntryRelationship | Represents the Coverage Plan | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| 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 |
1..1 | Act | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| templateId |
0..* | II | ||
| @classCode |
1..1 | cs | Binding: XActClassDocumentEntryAct (2.0.0) (required) Fixed Value: ACT | |
| @moodCode |
1..1 | cs | Binding: XDocumentActMood (2.0.0) (required) Fixed Value: DEF | |
| @negationInd |
0..1 | bl | ||
| id |
1..1 | II | Plan identifier | |
| code |
1..1 | CD | Binding: v3 Code System ActCode (example) | |
| text |
1..1 | ED | Name of the plan | |
| statusCode |
0..1 | CS | Binding: ActStatus (required) | |
| effectiveTime |
0..1 | IVL_TS | ||
| priorityCode |
0..1 | CE | Binding: ActPriority (example) | |
| languageCode |
0..1 | CS | Binding: AllLanguages (required) | |
| subject |
0..1 | Subject | ||
| specimen |
0..* | Specimen | ||
| performer |
0..* | Performer2 | ||
| author |
0..* | Author | ||
| informant |
0..* | Informant | ||
| participant |
0..* | Participant2 | ||
| entryRelationship |
0..* | EntryRelationship | ||
| reference |
0..* | Reference | ||
| precondition |
0..* | Precondition | ||
| sdtcPrecondition2 |
0..* | Precondition2 | XML Namespace: urn:hl7-org:sdtc XML: precondition2 (urn:hl7-org:sdtc) | |
| sdtcInFulfillmentOf1 |
0..* | InFulfillmentOf1 | XML Namespace: urn:hl7-org:sdtc XML: inFulfillmentOf1 (urn:hl7-org:sdtc) | |
| 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 | ||
| sdtcPrecondition2 |
0..* | Precondition2 | XML Namespace: urn:hl7-org:sdtc XML: precondition2 (urn:hl7-org:sdtc) | |
| sdtcInFulfillmentOf1 |
0..* | InFulfillmentOf1 | XML Namespace: urn:hl7-org:sdtc XML: inFulfillmentOf1 (urn:hl7-org:sdtc) | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Act.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.templateId:payer-act.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.templateId:payers-entry.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.classCode | Base | required | x_ActClassDocumentEntryAct | 📍2.0.0 | THO v5.2 |
| Act.moodCode | Base | required | x_DocumentActMood | 📍2.0.0 | THO v5.2 |
| Act.code | Base | preferred | ActCoverageTypeCode | 📦3.0.0 | THO v6.5 |
| Act.text.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.text.compression | Base | required | CDACompressionAlgorithm | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.text.integrityCheckAlgorithm | Base | required | IntegrityCheckAlgorithm | 📍2.0.0 | THO v5.2 |
| Act.text.mediaType | Base | example | MediaType | 📦3.0.0 | THO v6.5 |
| Act.text.representation | Base | required | CDABinaryDataEncoding | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.statusCode | Base | required | ActStatus | 📦3.0.0 | THO v6.5 |
| Act.statusCode.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.priorityCode | Base | example | ActPriority | 📦3.0.0 | THO v6.5 |
| Act.languageCode | Base | required | All Languages | 📦5.0.0 | FHIR Std. |
| Act.performer:payer.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.performer:payer.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.performer:payer.​typeCode | Base | required | ParticipationPhysicalPerformer | 📦3.0.0 | THO v6.5 |
| Act.performer:payer.​assignedEntity.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.performer:payer.​assignedEntity.typeId.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.performer:payer.​assignedEntity.classCode | Base | required | RoleClassAssignedEntity | 📦3.0.0 | THO v6.5 |
| Act.performer:payer.​assignedEntity.code | Base | example | CDARoleCode | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.performer:payer.​assignedEntity.code.​code | Base | extensible | Payer Role Codes | 📦0.0.1-current | This IG |
| Act.performer:payer.​assignedEntity.telecom.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.performer:payer.​assignedEntity.telecom.​use | Base | required | TelecommunicationAddressUse | 📍2.0.0 | THO v5.2 |
| Act.performer:payer.​assignedEntity.representedOrganization.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.performer:payer.​assignedEntity.representedOrganization.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.performer:payer.​assignedEntity.representedOrganization.​classCode | Base | required | EntityClassOrganization | 📦3.0.0 | THO v6.5 |
| Act.performer:payer.​assignedEntity.representedOrganization.​determinerCode | Base | required | EntityDeterminer | 📦3.0.0 | THO v6.5 |
| Act.performer:payer.​assignedEntity.representedOrganization.​standardIndustryClassCode | Base | example | OrganizationIndustryClassNAICS | 📦3.0.0 | THO v6.5 |
| Act.performer:guarantor.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.performer:guarantor.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.performer:guarantor.​typeCode | Base | required | ParticipationPhysicalPerformer | 📦3.0.0 | THO v6.5 |
| Act.performer:guarantor.​assignedEntity.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.performer:guarantor.​assignedEntity.typeId.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.performer:guarantor.​assignedEntity.classCode | Base | required | RoleClassAssignedEntity | 📦3.0.0 | THO v6.5 |
| Act.performer:guarantor.​assignedEntity.code | Base | example | CDARoleCode | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.performer:guarantor.​assignedEntity.code.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.performer:guarantor.​assignedEntity.telecom.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.performer:guarantor.​assignedEntity.telecom.​use | Base | required | TelecommunicationAddressUse | 📍2.0.0 | THO v5.2 |
| Act.participant:member.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:member.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:member.​typeCode | Base | required | CDAParticipationType | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:member.​contextControlCode | Base | required | CDAContextControl | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:member.​time.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:member.​time.operator | Base | required | CDASetOperator | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:member.​participantRole.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:member.​participantRole.typeId.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:member.​participantRole.classCode | Base | required | CDARoleClassRoot | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:member.​participantRole.code | Base | example | CDARoleCode | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:member.​participantRole.code.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:member.​participantRole.code.​code | Base | extensible | Payer Role Codes | 📦0.0.1-current | This IG |
| Act.participant:member.​participantRole.telecom.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:member.​participantRole.telecom.​use | Base | required | TelecommunicationAddressUse | 📍2.0.0 | THO v5.2 |
| Act.participant:member.​participantRole.playingEntity.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:member.​participantRole.playingEntity.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:member.​participantRole.playingEntity.​classCode | Base | required | EntityClassRoot | 📦3.0.0 | THO v6.5 |
| Act.participant:member.​participantRole.playingEntity.​determinerCode | Base | required | EntityDeterminer | 📦3.0.0 | THO v6.5 |
| Act.participant:member.​participantRole.playingEntity.​code | Base | example | CDAEntityCode | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:subscriber.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:subscriber.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:subscriber.​typeCode | Base | required | CDAParticipationType | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:subscriber.​contextControlCode | Base | required | CDAContextControl | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:subscriber.​participantRole.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:subscriber.​participantRole.typeId.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:subscriber.​participantRole.classCode | Base | required | CDARoleClassRoot | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:subscriber.​participantRole.code | Base | example | CDARoleCode | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:subscriber.​participantRole.telecom.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:subscriber.​participantRole.telecom.​use | Base | required | TelecommunicationAddressUse | 📍2.0.0 | THO v5.2 |
| Act.entryRelationship:plan.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.entryRelationship:plan.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.entryRelationship:plan.​typeCode | Base | required | x_ActRelationshipEntryRelationship | 📦3.0.0 | THO v6.5 |
| Act.entryRelationship:plan.​act.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.entryRelationship:plan.​act.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.entryRelationship:plan.​act.classCode | Base | required | x_ActClassDocumentEntryAct | 📍2.0.0 | THO v5.2 |
| Act.entryRelationship:plan.​act.moodCode | Base | required | x_DocumentActMood | 📍2.0.0 | THO v5.2 |
| Act.entryRelationship:plan.​act.code | Base | example | v3 Code System ActCode | 📦3.0.0 | THO v6.5 |
| Act.entryRelationship:plan.​act.statusCode | Base | required | ActStatus | 📦3.0.0 | THO v6.5 |
| Act.entryRelationship:plan.​act.priorityCode | Base | example | ActPriority | 📦3.0.0 | THO v6.5 |
| Act.entryRelationship:plan.​act.languageCode | Base | required | All Languages | 📦5.0.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 4537-8967 | warning | Act.performer:guarantor.assignedEntity | **SHOULD** include assignedEntity/assignedPerson/name AND/OR assignedEntity/representedOrganization/name (CONF:4537-8967). |
assignedPerson.name.exists() or representedOrganization.name.exists()
|
| II-1 | error | Act.typeId, Act.performer:payer.typeId, Act.performer:payer.assignedEntity.typeId, Act.performer:payer.assignedEntity.representedOrganization.typeId, Act.performer:guarantor.typeId, Act.performer:guarantor.assignedEntity.typeId, Act.participant:member.typeId, Act.participant:member.participantRole.typeId, Act.participant:member.participantRole.playingEntity.typeId, Act.participant:subscriber.typeId, Act.participant:subscriber.participantRole.typeId, Act.entryRelationship:plan.typeId, Act.entryRelationship:plan.act.typeId | An II instance must have either a root or an nullFlavor. |
root.exists() or nullFlavor.exists()
|
| should-addr | warning | Act.performer:guarantor.assignedEntity, Act.participant:member.participantRole, Act.participant:subscriber.participantRole | SHOULD contain addr |
addr.exists()
|
| should-code | warning | Act.performer:payer.assignedEntity | SHOULD contain code |
code.exists()
|
| should-code-attr | warning | Act.participant:member.participantRole.code | SHOULD contain @code |
code.exists()
|
| should-country | warning | Act.performer:payer.assignedEntity.addr, Act.performer:guarantor.assignedEntity.addr, Act.participant:member.participantRole.addr, Act.participant:subscriber.participantRole.addr | SHOULD contain country |
|
| should-effectiveTime | warning | Act | SHOULD contain effectiveTime |
effectiveTime.exists()
|
| should-high | warning | Act.participant:member.time | SHOULD contain high |
high.exists()
|
| should-low | warning | Act.participant:member.time | SHOULD contain low |
low.exists()
|
| should-name | warning | Act.performer:payer.assignedEntity.representedOrganization | SHOULD contain name |
name.exists()
|
| should-playingEntity | warning | Act.participant:member.participantRole | SHOULD contain playingEntity |
playingEntity.exists()
|
| should-representedOrganization | warning | Act.performer:payer.assignedEntity | SHOULD contain representedOrganization |
representedOrganization.exists()
|
| should-telecom | warning | Act.performer:guarantor.assignedEntity | SHOULD contain telecom |
telecom.exists()
|
| should-text-ref-value | warning | Act | SHOULD contain text/reference/@value |
text.reference.value.exists()
|
| should-time | warning | Act.performer:guarantor, Act.participant:member | SHOULD contain time |
time.exists()
|
| should-use | warning | Act.performer:payer.assignedEntity.telecom, Act.performer:guarantor.assignedEntity.telecom, Act.participant:member.participantRole.telecom, Act.participant:subscriber.participantRole.telecom | SHOULD contain @use |
nullFlavor.exists() or use.exists()
|
| value-starts-octothorpe | error | Act.text.reference | If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative |
value.exists() implies value.startsWith('#')
|
This structure is derived from Act
Summary
Mandatory: 17 elements(18 nested mandatory elements)
Must-Support: 11 elements
Fixed: 8 elements
Prohibited: 1 element
Slices
This structure defines the following Slices:
IG © 2023+ IHE Patient Care Coordination Technical Committee. Package ihe.pcc.pscc#0.0.1-current based on FHIR 5.0.0. Generated 2025-11-04
Links: Table of Contents |
QA Report
| New Issue | Issues
Version History |
|
Propose a change