Consolidated CDA Release 2.1 StructureDefinition Publication
2.1 - CI Build
Consolidated CDA Release 2.1 StructureDefinition Publication
2.1 - CI Build
Consolidated CDA Release 2.1 StructureDefinition Publication, published by Health Level Seven. This is not an authorized publication; it is the continuous build for version 2.1). This version is based on the current content of https://github.com/HL7/CDA-ccda-2.1-sd/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/CareTeamMemberAct | Version: 2.1 | |||
| Draft as of 2023-09-29 | Computable Name: CareTeamMemberAct | |||
| Other Identifiers: id: urn:hl7ii:2.16.840.1.113883.10.20.22.4.500.1:2022-06-01 | ||||
This template is used to represent a member of the care team. Care team members can include healthcare and community services providers, caregivers, relatives, the patient themselves, etc. A care team member can be another care team or an organization. Care team member attributes include the following: Care team member status on the care team Care team member time (e.g. duration, point-in-time, etc.) on the care team Schedule of the care team member describing when the care team member usually participates on the care team Care team member function on the care team such as the care team member specialty, relationship to the patient, and also role on the care team Care team member name, address, telecom, organization, etc. Care team member information (narrative description about the care team member)
The performer/assignedEntity/id may be set equal to (a pointer to) an id on a performer elsewhere in the document (header or entries) or a new performer can be described here. If the id is pointing to a performer already described elsewhere in the document, assignedEntity/id is sufficient to identify this performer and none of the remaining details of assignedEntity are required to be set. Application Software must be responsible for resolving the identifier back to its original object and then rendering the information in the correct place in the containing section’s narrative text.
This id must be a pointer to another Performer.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from CDAR2.Act
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Act | CDAR2.Act | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, @classCode, @moodCode, realmCode, typeId, templateId, id, code, @negationInd, text, statusCode, effectiveTime, priorityCode, languageCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition | ||
 classCode | 1..1 | cs | Fixed Value: PCPR | |
| moodCode | 1..1 | cs | Fixed Value: EVN | |
  Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
   templateId:templateId1 | 1..1 | II | templateId | |
  root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.500.1 | |
  extension | 1..1 | st | Required Pattern: 2022-06-01 | |
| code | 1..1 | CD | ||
| code | 1..1 | cs | Required Pattern: 85847-2 | |
 codeSystem | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.6.1 | |
| statusCode | 1..1 | CS | ||
| code | 1..1 | cs | Binding: ActStatus (required) | |
| effectiveTime | 1..1 | IVL_TS | ||
| low | 1..1 | IVXB_TS | ||
| high | 0..1 | IVXB_TS | ||
| Slices for performer | 1..* | Performer2 | Slice: Unordered, Open by value:sdtcFunctionCode, value:assignedEntity | |
| performer:performer1 | 1..1 | Performer2 | performer | |
| sdtcFunctionCode | 0..1 | CE | This sdtc:functionCode represents the function or role of the member on the care team. For example, the care team member roles on the care team can be a caregiver and a professional nurse or a primary care provider and the care coordinator. Binding: Care Team Member Function (preferred) | |
 assignedEntity | 1..1 | AssignedEntity | ||
| id | C | 1..* | II | 4515-180: If the assignedEntity/id is not referencing a Performer elsewhere in the document with an assignedPerson populated, this assignedEntity SHALL contain exactly one [1..1] assignedPerson (CONF:4515-180). |
| root | 0..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.4.6 | |
| addr | 0..* | AD | ||
| telecom | 0..* | TEL | ||
| assignedPerson | 0..1 | Person | This assignedPerson must be present on at least one performer in this document for each unique assignedEntity/id. | |
 name | 1..1 | USRealmPersonNamePNUSFIELDED | Base for all types and resources | |
| representedOrganization | C | 0..1 | Organization | 4515-184: When a provider is working on behalf of an organization an addr & telecom **SHALL** be present in representedOrganization (CONF:4515-184). |
| Slices for participant | 0..* | Participant2 | Slice: Unordered, Open by value:participantRole, value:typeCode | |
 participant:participant2 | 0..* | Participant2 | participant | |
 typeCode | 1..1 | cs | Fixed Value: LOC | |
| participantRole | 1..1 | ParticipantRole | ||
| participant:participant1 | C | 0..* | Participant2 | participant 4515-172: This participantRole SHALL contain exactly one [1..1] @nullFlavor="NI" No Information. (CONF:4515-172). |
| typeCode | 1..1 | cs | Fixed Value: IND | |
| sdtcFunctionCode | 1..1 | CE | sdtc:functionCode Binding: Care Team Member Function (required) | |
 Slices for entryRelationship | 0..* | EntryRelationship | Slice: Unordered, Open by value:observation, value:typeCode | |
| entryRelationship:entryRelationship1 | 0..* | EntryRelationship | entryRelationship | |
| typeCode | 1..1 | cs | Fixed Value: REFR | |
| encounter | 1..1 | Encounter | ||
| id | C | 1..1 | II | 4515-90: If the id does not match an encounter/id from an encounter elsewhere within the same document and the id does not contain @nullFlavor=NA, then this entry SHALL conform to the Encounter Activity (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.49:2015-08-01) (CONF:4515-90). |
| entryRelationship:entryRelationship2 | 0..* | EntryRelationship | entryRelationship | |
| typeCode | 1..1 | cs | Fixed Value: REFR | |
| act | 1..1 | NoteActivity | Base for all types and resources | |
| entryRelationship:entryRelationship3 | 0..1 | EntryRelationship | entryRelationship | |
| typeCode | 1..1 | cs | Fixed Value: REFR | |
| observation | 1..1 | CareTeamMemberScheduleObservation | Base for all types and resources | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Act.statusCode.code | required | ActStatus |
| Act.performer:performer1.sdtcFunctionCode | preferred | Care Team Member Function |
| Act.participant:participant1.sdtcFunctionCode | required | Care Team Member Function |
| Id | Grade | Path(s) | Details | Requirements |
| 4515-90 | error | Act.entryRelationship:entryRelationship1.encounter.id | If the id does not match an encounter/id from an encounter elsewhere within the same document and the id does not contain @nullFlavor=NA, then this entry SHALL conform to the Encounter Activity (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.49:2015-08-01) (CONF:4515-90). : | |
| 4515-172 | error | Act.participant:participant1 | This participantRole SHALL contain exactly one [1..1] @nullFlavor="NI" No Information. (CONF:4515-172). : | |
| 4515-180 | error | Act.performer:performer1.assignedEntity.id | If the assignedEntity/id is not referencing a Performer elsewhere in the document with an assignedPerson populated, this assignedEntity SHALL contain exactly one [1..1] assignedPerson (CONF:4515-180). : | |
| 4515-184 | error | Act.performer:performer1.assignedEntity.representedOrganization | When a provider is working on behalf of an organization an addr & telecom **SHALL** be present in representedOrganization (CONF:4515-184). : |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Act | 1..1 | CDAR2.Act | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, @classCode, @moodCode, realmCode, typeId, templateId, id, code, @negationInd, text, statusCode, effectiveTime, priorityCode, languageCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition Base for all types and resources | |
 @classCode | 1..1 | cs | Fixed Value: PCPR | |
| @moodCode | 1..1 | cs | Fixed Value: EVN | |
| Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:templateId1 | 1..1 | II | templateId | |
| @root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.500.1 | |
| @extension | 1..1 | st | Required Pattern: 2022-06-01 | |
| code | 1..1 | CD | Binding: v3 Code System ActCode (extensible) | |
| @code | 1..1 | cs | Required Pattern: 85847-2 | |
| @codeSystem | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.6.1 | |
| statusCode | 1..1 | CS | Binding: ActStatus (required) | |
| @code | 1..1 | cs | Binding: ActStatus (required) | |
| effectiveTime | 1..1 | IVL_TS | ||
| low | 1..1 | IVXB_TS | ||
| high | 0..1 | IVXB_TS | ||
| Slices for performer | 1..* | Performer2 | Slice: Unordered, Open by value:sdtcFunctionCode, value:assignedEntity | |
| performer:performer1 | 1..1 | Performer2 | performer | |
| sdtcFunctionCode | 0..1 | CE | XML Namespace: urn:hl7-org:sdtc This sdtc:functionCode represents the function or role of the member on the care team. For example, the care team member roles on the care team can be a caregiver and a professional nurse or a primary care provider and the care coordinator. XML: functionCode (urn:hl7-org:sdtc) Binding: Care Team Member Function (preferred) | |
| assignedEntity | 1..1 | AssignedEntity | ||
| id | C | 1..* | II | 4515-180: If the assignedEntity/id is not referencing a Performer elsewhere in the document with an assignedPerson populated, this assignedEntity SHALL contain exactly one [1..1] assignedPerson (CONF:4515-180). |
| @root | 0..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.4.6 | |
| addr | 0..* | AD | ||
| telecom | 0..* | TEL | ||
| assignedPerson | 0..1 | Person | This assignedPerson must be present on at least one performer in this document for each unique assignedEntity/id. | |
| name | C | 1..1 | USRealmPersonNamePNUSFIELDED | Base for all types and resources |
| representedOrganization | C | 0..1 | Organization | 4515-184: When a provider is working on behalf of an organization an addr & telecom **SHALL** be present in representedOrganization (CONF:4515-184). |
| Slices for participant | 0..* | Participant2 | Slice: Unordered, Open by value:participantRole, value:typeCode | |
| participant:participant2 | 0..* | Participant2 | participant | |
| @typeCode | 1..1 | cs | Binding: ParticipationType (required) Fixed Value: LOC | |
| participantRole | 1..1 | ParticipantRole | ||
| participant:participant1 | C | 0..* | Participant2 | participant 4515-172: This participantRole SHALL contain exactly one [1..1] @nullFlavor="NI" No Information. (CONF:4515-172). |
| @typeCode | 1..1 | cs | Binding: ParticipationType (required) Fixed Value: IND | |
| sdtcFunctionCode | 1..1 | CE | XML Namespace: urn:hl7-org:sdtc sdtc:functionCode XML: functionCode (urn:hl7-org:sdtc) Binding: Care Team Member Function (required) | |
| participantRole | 1..1 | ParticipantRole | ||
| Slices for entryRelationship | 0..* | EntryRelationship | Slice: Unordered, Open by value:observation, value:typeCode | |
| entryRelationship:entryRelationship1 | 0..* | EntryRelationship | entryRelationship | |
| @typeCode | 1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: REFR | |
| encounter | 1..1 | Encounter | ||
| @classCode | 1..1 | cs | Binding: ActClass (required) Fixed Value: ENC | |
| @moodCode | 1..1 | cs | ||
| id | C | 1..1 | II | 4515-90: If the id does not match an encounter/id from an encounter elsewhere within the same document and the id does not contain @nullFlavor=NA, then this entry SHALL conform to the Encounter Activity (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.49:2015-08-01) (CONF:4515-90). |
| entryRelationship:entryRelationship2 | 0..* | EntryRelationship | entryRelationship | |
| @typeCode | 1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: REFR | |
| act | 1..1 | NoteActivity | Base for all types and resources | |
| entryRelationship:entryRelationship3 | 0..1 | EntryRelationship | entryRelationship | |
| @typeCode | 1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: REFR | |
| observation | 1..1 | CareTeamMemberScheduleObservation | Base for all types and resources | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Act.code | extensible | ActCode |
| Act.statusCode | required | ActStatus |
| Act.statusCode.code | required | ActStatus |
| Act.performer:performer1.sdtcFunctionCode | preferred | Care Team Member Function |
| Act.participant:participant2.typeCode | required | Fixed Value: LOC |
| Act.participant:participant1.typeCode | required | Fixed Value: IND |
| Act.participant:participant1.sdtcFunctionCode | required | Care Team Member Function |
| Act.entryRelationship:entryRelationship1.typeCode | required | Fixed Value: REFR |
| Act.entryRelationship:entryRelationship1.encounter.classCode | required | Fixed Value: ENC |
| Act.entryRelationship:entryRelationship2.typeCode | required | Fixed Value: REFR |
| Act.entryRelationship:entryRelationship3.typeCode | required | Fixed Value: REFR |
| Id | Grade | Path(s) | Details | Requirements |
| 4515-90 | error | Act.entryRelationship:entryRelationship1.encounter.id | If the id does not match an encounter/id from an encounter elsewhere within the same document and the id does not contain @nullFlavor=NA, then this entry SHALL conform to the Encounter Activity (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.49:2015-08-01) (CONF:4515-90). : | |
| 4515-172 | error | Act.participant:participant1 | This participantRole SHALL contain exactly one [1..1] @nullFlavor="NI" No Information. (CONF:4515-172). : | |
| 4515-180 | error | Act.performer:performer1.assignedEntity.id | If the assignedEntity/id is not referencing a Performer elsewhere in the document with an assignedPerson populated, this assignedEntity SHALL contain exactly one [1..1] assignedPerson (CONF:4515-180). : | |
| 4515-184 | error | Act.performer:performer1.assignedEntity.representedOrganization | When a provider is working on behalf of an organization an addr & telecom **SHALL** be present in representedOrganization (CONF:4515-184). : | |
| 81-9371 | error | Act.performer:performer1.assignedEntity.assignedPerson.name | The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). : | |
| 81-9372 | error | Act.performer:performer1.assignedEntity.assignedPerson.name | The string **SHALL NOT** contain name parts (CONF:81-9372). : | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| pn-no-ls | error | Act.performer:performer1.assignedEntity.assignedPerson.name | No PN name part may have a qualifier of LS. : (delimiter | family | given | prefix | suffix).where(qualifier = 'LS').empty() |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Act | 1..1 | CDAR2.Act | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, @classCode, @moodCode, realmCode, typeId, templateId, id, code, @negationInd, text, statusCode, effectiveTime, priorityCode, languageCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition Base for all types and resources | |
| @nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
| @classCode | 1..1 | cs | Fixed Value: PCPR | |
| @moodCode | 1..1 | cs | Fixed Value: EVN | |
| realmCode | 0..* | CS | ||
| typeId | 0..1 | II | ||
| Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:templateId1 | 1..1 | II | templateId | |
| @nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
| @assigningAuthorityName | 0..1 | st | ||
| @displayable | 0..1 | bl | ||
| @root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.500.1 | |
| @extension | 1..1 | st | Required Pattern: 2022-06-01 | |
| id | 0..* | II | ||
| code | 1..1 | CD | Binding: v3 Code System ActCode (extensible) | |
| @nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
| @code | 1..1 | cs | Required Pattern: 85847-2 | |
| @codeSystem | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.6.1 | |
| @codeSystemName | 0..1 | st | ||
| @codeSystemVersion | 0..1 | st | ||
| @displayName | 0..1 | st | ||
| @sdtcValueSet | 0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc) | |
| @sdtcValueSetVersion | 0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc) | |
| originalText | 0..1 | ED | ||
| qualifier | 0..* | CR | ||
| translation | 0..* | CD | ||
| @negationInd | 0..1 | bl | ||
| text | 0..1 | ED | ||
| statusCode | 1..1 | CS | Binding: ActStatus (required) | |
| @nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
| @code | 1..1 | cs | Binding: ActStatus (required) | |
| @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 | 1..1 | IVL_TS | ||
| @nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
| @value | 0..1 | ts | Date Format: YYYYMMDDHHMMSS.UUUU[+|-ZZzz] | |
| @operator | 0..1 | cs | Binding: SetOperator (required) | |
| low | 1..1 | IVXB_TS | ||
| center | 0..1 | TS | ||
| width | 0..1 | PQ | ||
| high | 0..1 | IVXB_TS | ||
| priorityCode | 0..1 | CE | Binding: ActPriority (extensible) | |
| languageCode | 0..1 | CS | Binding: HumanLanguage (required) | |
| subject | 0..1 | Subject | ||
| specimen | 0..* | Specimen | ||
| Slices for performer | 1..* | Performer2 | Slice: Unordered, Open by value:sdtcFunctionCode, value:assignedEntity | |
| performer:performer1 | 1..1 | Performer2 | performer | |
| @nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
| @typeCode | 0..1 | cs | Binding: ParticipationPhysicalPerformer (required) Fixed Value: PRF | |
| realmCode | 0..* | CS | ||
| typeId | 0..1 | II | ||
| templateId | 0..* | II | ||
| sdtcFunctionCode | 0..1 | CE | XML Namespace: urn:hl7-org:sdtc This sdtc:functionCode represents the function or role of the member on the care team. For example, the care team member roles on the care team can be a caregiver and a professional nurse or a primary care provider and the care coordinator. XML: functionCode (urn:hl7-org:sdtc) Binding: Care Team Member Function (preferred) | |
| time | 0..1 | IVL_TS | ||
| modeCode | 0..1 | CE | ||
| assignedEntity | 1..1 | AssignedEntity | ||
| @classCode | 0..1 | cs | Binding: RoleClassAssignedEntity (required) Fixed Value: ASSIGNED | |
| templateId | 0..* | II | ||
| id | C | 1..* | II | 4515-180: If the assignedEntity/id is not referencing a Performer elsewhere in the document with an assignedPerson populated, this assignedEntity SHALL contain exactly one [1..1] assignedPerson (CONF:4515-180). |
| @nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
| @assigningAuthorityName | 0..1 | st | ||
| @displayable | 0..1 | bl | ||
| @root | 0..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.4.6 | |
| @extension | 0..1 | st | ||
| sdtcIdentifiedBy | 0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |
| code | 0..1 | CE | Binding: v3 Code System RoleCode (extensible) | |
| addr | 0..* | AD | ||
| telecom | 0..* | TEL | ||
| assignedPerson | 0..1 | Person | This assignedPerson must be present on at least one performer in this document for each unique assignedEntity/id. | |
| @classCode | 0..1 | cs | Binding: EntityClassLivingSubject (required) Fixed Value: PSN | |
| @determinerCode | 0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
| templateId | 0..* | II | ||
| name | C | 1..1 | USRealmPersonNamePNUSFIELDED | Base for all types and resources |
| sdtcAsPatientRelationship | 0..* | CE | XML Namespace: urn:hl7-org:sdtc XML: asPatientRelationship (urn:hl7-org:sdtc) | |
| representedOrganization | C | 0..1 | Organization | 4515-184: When a provider is working on behalf of an organization an addr & telecom **SHALL** be present in representedOrganization (CONF:4515-184). |
| author | 0..* | Author | ||
| informant | 0..* | Informant | ||
| Slices for participant | 0..* | Participant2 | Slice: Unordered, Open by value:participantRole, value:typeCode | |
| participant:participant2 | 0..* | Participant2 | participant | |
| @nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
| @typeCode | 1..1 | cs | Binding: ParticipationType (required) Fixed Value: LOC | |
| @contextControlCode | 0..1 | cs | Binding: ContextControl (required) Fixed Value: OP | |
| realmCode | 0..* | CS | ||
| typeId | 0..1 | II | ||
| templateId | 0..* | II | ||
| sdtcFunctionCode | 0..1 | CE | XML Namespace: urn:hl7-org:sdtc XML: functionCode (urn:hl7-org:sdtc) | |
| time | 0..1 | IVL_TS | ||
| awarenessCode | 0..1 | CE | ||
| participantRole | 1..1 | ParticipantRole | ||
| participant:participant1 | C | 0..* | Participant2 | participant 4515-172: This participantRole SHALL contain exactly one [1..1] @nullFlavor="NI" No Information. (CONF:4515-172). |
| @nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
| @typeCode | 1..1 | cs | Binding: ParticipationType (required) Fixed Value: IND | |
| @contextControlCode | 0..1 | cs | Binding: ContextControl (required) Fixed Value: OP | |
| realmCode | 0..* | CS | ||
| typeId | 0..1 | II | ||
| templateId | 0..* | II | ||
| sdtcFunctionCode | 1..1 | CE | XML Namespace: urn:hl7-org:sdtc sdtc:functionCode XML: functionCode (urn:hl7-org:sdtc) Binding: Care Team Member Function (required) | |
| time | 0..1 | IVL_TS | ||
| awarenessCode | 0..1 | CE | ||
| participantRole | 1..1 | ParticipantRole | ||
| Slices for entryRelationship | 0..* | EntryRelationship | Slice: Unordered, Open by value:observation, value:typeCode | |
| entryRelationship:entryRelationship1 | 0..* | EntryRelationship | entryRelationship | |
| @nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
| realmCode | 0..* | CS | ||
| typeId | 0..1 | II | ||
| templateId | 0..* | II | ||
| @typeCode | 1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: REFR | |
| @inversionInd | 0..1 | bl | ||
| @contextConductionInd | 0..1 | bl | ||
| @negationInd | 0..1 | bl | ||
| sequenceNumber | 0..1 | INT | ||
| seperatableInd | 0..1 | BL | ||
| act | 0..1 | Act | ||
 encounter | 1..1 | Encounter | ||
 @classCode | 1..1 | cs | Binding: ActClass (required) Fixed Value: ENC | |
| @moodCode | 1..1 | cs | ||
| realmCode | 0..* | CS | ||
| typeId | 0..1 | II | ||
| templateId | 0..* | II | ||
| id | C | 1..1 | II | 4515-90: If the id does not match an encounter/id from an encounter elsewhere within the same document and the id does not contain @nullFlavor=NA, then this entry SHALL conform to the Encounter Activity (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.49:2015-08-01) (CONF:4515-90). |
| code | 0..1 | CD | Binding: ActEncounterCode (extensible) | |
| text | 0..1 | ED | ||
| statusCode | 0..1 | CS | Binding: ActStatus (required) | |
| effectiveTime | 0..1 | IVL_TS | ||
| sdtcDischargeDispositionCode | 0..1 | CE | XML Namespace: urn:hl7-org:sdtc XML: dischargeDispositionCode (urn:hl7-org:sdtc) | |
| priorityCode | 0..1 | CE | Binding: ActPriority (extensible) | |
| 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 | ||
| 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 | ||
| entryRelationship:entryRelationship2 | 0..* | EntryRelationship | entryRelationship | |
| @nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
| realmCode | 0..* | CS | ||
| typeId | 0..1 | II | ||
| templateId | 0..* | II | ||
| @typeCode | 1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: REFR | |
| @inversionInd | 0..1 | bl | ||
| @contextConductionInd | 0..1 | bl | ||
| @negationInd | 0..1 | bl | ||
| sequenceNumber | 0..1 | INT | ||
| seperatableInd | 0..1 | BL | ||
| act | 1..1 | NoteActivity | Base for all types and resources | |
| 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 | ||
| entryRelationship:entryRelationship3 | 0..1 | EntryRelationship | entryRelationship | |
| @nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
| realmCode | 0..* | CS | ||
| typeId | 0..1 | II | ||
| templateId | 0..* | II | ||
| @typeCode | 1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: REFR | |
| @inversionInd | 0..1 | bl | ||
| @contextConductionInd | 0..1 | bl | ||
| @negationInd | 0..1 | bl | ||
| sequenceNumber | 0..1 | INT | ||
| seperatableInd | 0..1 | BL | ||
| act | 0..1 | Act | ||
| encounter | 0..1 | Encounter | ||
| observation | 1..1 | CareTeamMemberScheduleObservation | Base for all types and resources | |
| observationMedia | 0..1 | ObservationMedia | ||
| organizer | 0..1 | Organizer | ||
| procedure | 0..1 | Procedure | ||
| regionOfInterest | 0..1 | RegionOfInterest | ||
| substanceAdministration | 0..1 | SubstanceAdministration | ||
| supply | 0..1 | Supply | ||
| reference | 0..* | Reference | ||
| precondition | 0..* | Precondition | ||
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Act.nullFlavor | required | NullFlavor |
| Act.templateId:templateId1.nullFlavor | required | NullFlavor |
| Act.code | extensible | ActCode |
| Act.code.nullFlavor | required | NullFlavor |
| Act.statusCode | required | ActStatus |
| Act.statusCode.nullFlavor | required | NullFlavor |
| Act.statusCode.code | required | ActStatus |
| Act.effectiveTime.nullFlavor | required | NullFlavor |
| Act.effectiveTime.operator | required | SetOperator |
| Act.priorityCode | extensible | ActPriority |
| Act.languageCode | required | HumanLanguage (a valid code from http://terminology.hl7.org/CodeSystem/ietf3066) |
| Act.performer:performer1.nullFlavor | required | NullFlavor |
| Act.performer:performer1.typeCode | required | Fixed Value: PRF |
| Act.performer:performer1.sdtcFunctionCode | preferred | Care Team Member Function |
| Act.performer:performer1.assignedEntity.classCode | required | Fixed Value: ASSIGNED |
| Act.performer:performer1.assignedEntity.id.nullFlavor | required | NullFlavor |
| Act.performer:performer1.assignedEntity.code | extensible | RoleCode |
| Act.performer:performer1.assignedEntity.assignedPerson.classCode | required | Fixed Value: PSN |
| Act.performer:performer1.assignedEntity.assignedPerson.determinerCode | required | Fixed Value: INSTANCE |
| Act.participant:participant2.nullFlavor | required | NullFlavor |
| Act.participant:participant2.typeCode | required | Fixed Value: LOC |
| Act.participant:participant2.contextControlCode | required | Fixed Value: OP |
| Act.participant:participant1.nullFlavor | required | NullFlavor |
| Act.participant:participant1.typeCode | required | Fixed Value: IND |
| Act.participant:participant1.contextControlCode | required | Fixed Value: OP |
| Act.participant:participant1.sdtcFunctionCode | required | Care Team Member Function |
| Act.entryRelationship:entryRelationship1.nullFlavor | required | NullFlavor |
| Act.entryRelationship:entryRelationship1.typeCode | required | Fixed Value: REFR |
| Act.entryRelationship:entryRelationship1.encounter.classCode | required | Fixed Value: ENC |
| Act.entryRelationship:entryRelationship1.encounter.code | extensible | ActEncounterCode |
| Act.entryRelationship:entryRelationship1.encounter.statusCode | required | ActStatus |
| Act.entryRelationship:entryRelationship1.encounter.priorityCode | extensible | ActPriority |
| Act.entryRelationship:entryRelationship2.nullFlavor | required | NullFlavor |
| Act.entryRelationship:entryRelationship2.typeCode | required | Fixed Value: REFR |
| Act.entryRelationship:entryRelationship3.nullFlavor | required | NullFlavor |
| Act.entryRelationship:entryRelationship3.typeCode | required | Fixed Value: REFR |
| Id | Grade | Path(s) | Details | Requirements |
| 4515-90 | error | Act.entryRelationship:entryRelationship1.encounter.id | If the id does not match an encounter/id from an encounter elsewhere within the same document and the id does not contain @nullFlavor=NA, then this entry SHALL conform to the Encounter Activity (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.49:2015-08-01) (CONF:4515-90). : | |
| 4515-172 | error | Act.participant:participant1 | This participantRole SHALL contain exactly one [1..1] @nullFlavor="NI" No Information. (CONF:4515-172). : | |
| 4515-180 | error | Act.performer:performer1.assignedEntity.id | If the assignedEntity/id is not referencing a Performer elsewhere in the document with an assignedPerson populated, this assignedEntity SHALL contain exactly one [1..1] assignedPerson (CONF:4515-180). : | |
| 4515-184 | error | Act.performer:performer1.assignedEntity.representedOrganization | When a provider is working on behalf of an organization an addr & telecom **SHALL** be present in representedOrganization (CONF:4515-184). : | |
| 81-9371 | error | Act.performer:performer1.assignedEntity.assignedPerson.name | The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). : | |
| 81-9372 | error | Act.performer:performer1.assignedEntity.assignedPerson.name | The string **SHALL NOT** contain name parts (CONF:81-9372). : | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| pn-no-ls | error | Act.performer:performer1.assignedEntity.assignedPerson.name | No PN name part may have a qualifier of LS. : (delimiter | family | given | prefix | suffix).where(qualifier = 'LS').empty() |
This structure is derived from CDAR2.Act
Summary
Mandatory: 12 elements (8 nested mandatory elements)
Fixed Value: 7 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from CDAR2.Act
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Act | CDAR2.Act | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, @classCode, @moodCode, realmCode, typeId, templateId, id, code, @negationInd, text, statusCode, effectiveTime, priorityCode, languageCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition | ||
| classCode | 1..1 | cs | Fixed Value: PCPR | |
| moodCode | 1..1 | cs | Fixed Value: EVN | |
| Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:templateId1 | 1..1 | II | templateId | |
| root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.500.1 | |
| extension | 1..1 | st | Required Pattern: 2022-06-01 | |
| code | 1..1 | CD | ||
| code | 1..1 | cs | Required Pattern: 85847-2 | |
| codeSystem | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.6.1 | |
| statusCode | 1..1 | CS | ||
| code | 1..1 | cs | Binding: ActStatus (required) | |
| effectiveTime | 1..1 | IVL_TS | ||
| low | 1..1 | IVXB_TS | ||
| high | 0..1 | IVXB_TS | ||
| Slices for performer | 1..* | Performer2 | Slice: Unordered, Open by value:sdtcFunctionCode, value:assignedEntity | |
| performer:performer1 | 1..1 | Performer2 | performer | |
| sdtcFunctionCode | 0..1 | CE | This sdtc:functionCode represents the function or role of the member on the care team. For example, the care team member roles on the care team can be a caregiver and a professional nurse or a primary care provider and the care coordinator. Binding: Care Team Member Function (preferred) | |
| assignedEntity | 1..1 | AssignedEntity | ||
| id | C | 1..* | II | 4515-180: If the assignedEntity/id is not referencing a Performer elsewhere in the document with an assignedPerson populated, this assignedEntity SHALL contain exactly one [1..1] assignedPerson (CONF:4515-180). |
| root | 0..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.4.6 | |
| addr | 0..* | AD | ||
| telecom | 0..* | TEL | ||
| assignedPerson | 0..1 | Person | This assignedPerson must be present on at least one performer in this document for each unique assignedEntity/id. | |
| name | 1..1 | USRealmPersonNamePNUSFIELDED | Base for all types and resources | |
| representedOrganization | C | 0..1 | Organization | 4515-184: When a provider is working on behalf of an organization an addr & telecom **SHALL** be present in representedOrganization (CONF:4515-184). |
| Slices for participant | 0..* | Participant2 | Slice: Unordered, Open by value:participantRole, value:typeCode | |
| participant:participant2 | 0..* | Participant2 | participant | |
| typeCode | 1..1 | cs | Fixed Value: LOC | |
| participantRole | 1..1 | ParticipantRole | ||
| participant:participant1 | C | 0..* | Participant2 | participant 4515-172: This participantRole SHALL contain exactly one [1..1] @nullFlavor="NI" No Information. (CONF:4515-172). |
| typeCode | 1..1 | cs | Fixed Value: IND | |
| sdtcFunctionCode | 1..1 | CE | sdtc:functionCode Binding: Care Team Member Function (required) | |
| Slices for entryRelationship | 0..* | EntryRelationship | Slice: Unordered, Open by value:observation, value:typeCode | |
| entryRelationship:entryRelationship1 | 0..* | EntryRelationship | entryRelationship | |
| typeCode | 1..1 | cs | Fixed Value: REFR | |
| encounter | 1..1 | Encounter | ||
| id | C | 1..1 | II | 4515-90: If the id does not match an encounter/id from an encounter elsewhere within the same document and the id does not contain @nullFlavor=NA, then this entry SHALL conform to the Encounter Activity (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.49:2015-08-01) (CONF:4515-90). |
| entryRelationship:entryRelationship2 | 0..* | EntryRelationship | entryRelationship | |
| typeCode | 1..1 | cs | Fixed Value: REFR | |
| act | 1..1 | NoteActivity | Base for all types and resources | |
| entryRelationship:entryRelationship3 | 0..1 | EntryRelationship | entryRelationship | |
| typeCode | 1..1 | cs | Fixed Value: REFR | |
| observation | 1..1 | CareTeamMemberScheduleObservation | Base for all types and resources | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Act.statusCode.code | required | ActStatus |
| Act.performer:performer1.sdtcFunctionCode | preferred | Care Team Member Function |
| Act.participant:participant1.sdtcFunctionCode | required | Care Team Member Function |
| Id | Grade | Path(s) | Details | Requirements |
| 4515-90 | error | Act.entryRelationship:entryRelationship1.encounter.id | If the id does not match an encounter/id from an encounter elsewhere within the same document and the id does not contain @nullFlavor=NA, then this entry SHALL conform to the Encounter Activity (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.49:2015-08-01) (CONF:4515-90). : | |
| 4515-172 | error | Act.participant:participant1 | This participantRole SHALL contain exactly one [1..1] @nullFlavor="NI" No Information. (CONF:4515-172). : | |
| 4515-180 | error | Act.performer:performer1.assignedEntity.id | If the assignedEntity/id is not referencing a Performer elsewhere in the document with an assignedPerson populated, this assignedEntity SHALL contain exactly one [1..1] assignedPerson (CONF:4515-180). : | |
| 4515-184 | error | Act.performer:performer1.assignedEntity.representedOrganization | When a provider is working on behalf of an organization an addr & telecom **SHALL** be present in representedOrganization (CONF:4515-184). : |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Act | 1..1 | CDAR2.Act | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, @classCode, @moodCode, realmCode, typeId, templateId, id, code, @negationInd, text, statusCode, effectiveTime, priorityCode, languageCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition Base for all types and resources | |
| @classCode | 1..1 | cs | Fixed Value: PCPR | |
| @moodCode | 1..1 | cs | Fixed Value: EVN | |
| Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:templateId1 | 1..1 | II | templateId | |
| @root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.500.1 | |
| @extension | 1..1 | st | Required Pattern: 2022-06-01 | |
| code | 1..1 | CD | Binding: v3 Code System ActCode (extensible) | |
| @code | 1..1 | cs | Required Pattern: 85847-2 | |
| @codeSystem | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.6.1 | |
| statusCode | 1..1 | CS | Binding: ActStatus (required) | |
| @code | 1..1 | cs | Binding: ActStatus (required) | |
| effectiveTime | 1..1 | IVL_TS | ||
| low | 1..1 | IVXB_TS | ||
| high | 0..1 | IVXB_TS | ||
| Slices for performer | 1..* | Performer2 | Slice: Unordered, Open by value:sdtcFunctionCode, value:assignedEntity | |
| performer:performer1 | 1..1 | Performer2 | performer | |
| sdtcFunctionCode | 0..1 | CE | XML Namespace: urn:hl7-org:sdtc This sdtc:functionCode represents the function or role of the member on the care team. For example, the care team member roles on the care team can be a caregiver and a professional nurse or a primary care provider and the care coordinator. XML: functionCode (urn:hl7-org:sdtc) Binding: Care Team Member Function (preferred) | |
| assignedEntity | 1..1 | AssignedEntity | ||
| id | C | 1..* | II | 4515-180: If the assignedEntity/id is not referencing a Performer elsewhere in the document with an assignedPerson populated, this assignedEntity SHALL contain exactly one [1..1] assignedPerson (CONF:4515-180). |
| @root | 0..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.4.6 | |
| addr | 0..* | AD | ||
| telecom | 0..* | TEL | ||
| assignedPerson | 0..1 | Person | This assignedPerson must be present on at least one performer in this document for each unique assignedEntity/id. | |
| name | C | 1..1 | USRealmPersonNamePNUSFIELDED | Base for all types and resources |
| representedOrganization | C | 0..1 | Organization | 4515-184: When a provider is working on behalf of an organization an addr & telecom **SHALL** be present in representedOrganization (CONF:4515-184). |
| Slices for participant | 0..* | Participant2 | Slice: Unordered, Open by value:participantRole, value:typeCode | |
| participant:participant2 | 0..* | Participant2 | participant | |
| @typeCode | 1..1 | cs | Binding: ParticipationType (required) Fixed Value: LOC | |
| participantRole | 1..1 | ParticipantRole | ||
| participant:participant1 | C | 0..* | Participant2 | participant 4515-172: This participantRole SHALL contain exactly one [1..1] @nullFlavor="NI" No Information. (CONF:4515-172). |
| @typeCode | 1..1 | cs | Binding: ParticipationType (required) Fixed Value: IND | |
| sdtcFunctionCode | 1..1 | CE | XML Namespace: urn:hl7-org:sdtc sdtc:functionCode XML: functionCode (urn:hl7-org:sdtc) Binding: Care Team Member Function (required) | |
| participantRole | 1..1 | ParticipantRole | ||
| Slices for entryRelationship | 0..* | EntryRelationship | Slice: Unordered, Open by value:observation, value:typeCode | |
| entryRelationship:entryRelationship1 | 0..* | EntryRelationship | entryRelationship | |
| @typeCode | 1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: REFR | |
| encounter | 1..1 | Encounter | ||
| @classCode | 1..1 | cs | Binding: ActClass (required) Fixed Value: ENC | |
| @moodCode | 1..1 | cs | ||
| id | C | 1..1 | II | 4515-90: If the id does not match an encounter/id from an encounter elsewhere within the same document and the id does not contain @nullFlavor=NA, then this entry SHALL conform to the Encounter Activity (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.49:2015-08-01) (CONF:4515-90). |
| entryRelationship:entryRelationship2 | 0..* | EntryRelationship | entryRelationship | |
| @typeCode | 1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: REFR | |
| act | 1..1 | NoteActivity | Base for all types and resources | |
| entryRelationship:entryRelationship3 | 0..1 | EntryRelationship | entryRelationship | |
| @typeCode | 1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: REFR | |
| observation | 1..1 | CareTeamMemberScheduleObservation | Base for all types and resources | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Act.code | extensible | ActCode |
| Act.statusCode | required | ActStatus |
| Act.statusCode.code | required | ActStatus |
| Act.performer:performer1.sdtcFunctionCode | preferred | Care Team Member Function |
| Act.participant:participant2.typeCode | required | Fixed Value: LOC |
| Act.participant:participant1.typeCode | required | Fixed Value: IND |
| Act.participant:participant1.sdtcFunctionCode | required | Care Team Member Function |
| Act.entryRelationship:entryRelationship1.typeCode | required | Fixed Value: REFR |
| Act.entryRelationship:entryRelationship1.encounter.classCode | required | Fixed Value: ENC |
| Act.entryRelationship:entryRelationship2.typeCode | required | Fixed Value: REFR |
| Act.entryRelationship:entryRelationship3.typeCode | required | Fixed Value: REFR |
| Id | Grade | Path(s) | Details | Requirements |
| 4515-90 | error | Act.entryRelationship:entryRelationship1.encounter.id | If the id does not match an encounter/id from an encounter elsewhere within the same document and the id does not contain @nullFlavor=NA, then this entry SHALL conform to the Encounter Activity (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.49:2015-08-01) (CONF:4515-90). : | |
| 4515-172 | error | Act.participant:participant1 | This participantRole SHALL contain exactly one [1..1] @nullFlavor="NI" No Information. (CONF:4515-172). : | |
| 4515-180 | error | Act.performer:performer1.assignedEntity.id | If the assignedEntity/id is not referencing a Performer elsewhere in the document with an assignedPerson populated, this assignedEntity SHALL contain exactly one [1..1] assignedPerson (CONF:4515-180). : | |
| 4515-184 | error | Act.performer:performer1.assignedEntity.representedOrganization | When a provider is working on behalf of an organization an addr & telecom **SHALL** be present in representedOrganization (CONF:4515-184). : | |
| 81-9371 | error | Act.performer:performer1.assignedEntity.assignedPerson.name | The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). : | |
| 81-9372 | error | Act.performer:performer1.assignedEntity.assignedPerson.name | The string **SHALL NOT** contain name parts (CONF:81-9372). : | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| pn-no-ls | error | Act.performer:performer1.assignedEntity.assignedPerson.name | No PN name part may have a qualifier of LS. : (delimiter | family | given | prefix | suffix).where(qualifier = 'LS').empty() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Act | 1..1 | CDAR2.Act | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, @classCode, @moodCode, realmCode, typeId, templateId, id, code, @negationInd, text, statusCode, effectiveTime, priorityCode, languageCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition Base for all types and resources | |
| @nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
| @classCode | 1..1 | cs | Fixed Value: PCPR | |
| @moodCode | 1..1 | cs | Fixed Value: EVN | |
| realmCode | 0..* | CS | ||
| typeId | 0..1 | II | ||
| Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:templateId1 | 1..1 | II | templateId | |
| @nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
| @assigningAuthorityName | 0..1 | st | ||
| @displayable | 0..1 | bl | ||
| @root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.500.1 | |
| @extension | 1..1 | st | Required Pattern: 2022-06-01 | |
| id | 0..* | II | ||
| code | 1..1 | CD | Binding: v3 Code System ActCode (extensible) | |
| @nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
| @code | 1..1 | cs | Required Pattern: 85847-2 | |
| @codeSystem | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.6.1 | |
| @codeSystemName | 0..1 | st | ||
| @codeSystemVersion | 0..1 | st | ||
| @displayName | 0..1 | st | ||
| @sdtcValueSet | 0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc) | |
| @sdtcValueSetVersion | 0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc) | |
| originalText | 0..1 | ED | ||
| qualifier | 0..* | CR | ||
| translation | 0..* | CD | ||
| @negationInd | 0..1 | bl | ||
| text | 0..1 | ED | ||
| statusCode | 1..1 | CS | Binding: ActStatus (required) | |
| @nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
| @code | 1..1 | cs | Binding: ActStatus (required) | |
| @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 | 1..1 | IVL_TS | ||
| @nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
| @value | 0..1 | ts | Date Format: YYYYMMDDHHMMSS.UUUU[+|-ZZzz] | |
| @operator | 0..1 | cs | Binding: SetOperator (required) | |
| low | 1..1 | IVXB_TS | ||
| center | 0..1 | TS | ||
| width | 0..1 | PQ | ||
| high | 0..1 | IVXB_TS | ||
| priorityCode | 0..1 | CE | Binding: ActPriority (extensible) | |
| languageCode | 0..1 | CS | Binding: HumanLanguage (required) | |
| subject | 0..1 | Subject | ||
| specimen | 0..* | Specimen | ||
| Slices for performer | 1..* | Performer2 | Slice: Unordered, Open by value:sdtcFunctionCode, value:assignedEntity | |
| performer:performer1 | 1..1 | Performer2 | performer | |
| @nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
| @typeCode | 0..1 | cs | Binding: ParticipationPhysicalPerformer (required) Fixed Value: PRF | |
| realmCode | 0..* | CS | ||
| typeId | 0..1 | II | ||
| templateId | 0..* | II | ||
| sdtcFunctionCode | 0..1 | CE | XML Namespace: urn:hl7-org:sdtc This sdtc:functionCode represents the function or role of the member on the care team. For example, the care team member roles on the care team can be a caregiver and a professional nurse or a primary care provider and the care coordinator. XML: functionCode (urn:hl7-org:sdtc) Binding: Care Team Member Function (preferred) | |
| time | 0..1 | IVL_TS | ||
| modeCode | 0..1 | CE | ||
| assignedEntity | 1..1 | AssignedEntity | ||
| @classCode | 0..1 | cs | Binding: RoleClassAssignedEntity (required) Fixed Value: ASSIGNED | |
| templateId | 0..* | II | ||
| id | C | 1..* | II | 4515-180: If the assignedEntity/id is not referencing a Performer elsewhere in the document with an assignedPerson populated, this assignedEntity SHALL contain exactly one [1..1] assignedPerson (CONF:4515-180). |
| @nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
| @assigningAuthorityName | 0..1 | st | ||
| @displayable | 0..1 | bl | ||
| @root | 0..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.4.6 | |
| @extension | 0..1 | st | ||
| sdtcIdentifiedBy | 0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |
| code | 0..1 | CE | Binding: v3 Code System RoleCode (extensible) | |
| addr | 0..* | AD | ||
| telecom | 0..* | TEL | ||
| assignedPerson | 0..1 | Person | This assignedPerson must be present on at least one performer in this document for each unique assignedEntity/id. | |
| @classCode | 0..1 | cs | Binding: EntityClassLivingSubject (required) Fixed Value: PSN | |
| @determinerCode | 0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
| templateId | 0..* | II | ||
| name | C | 1..1 | USRealmPersonNamePNUSFIELDED | Base for all types and resources |
| sdtcAsPatientRelationship | 0..* | CE | XML Namespace: urn:hl7-org:sdtc XML: asPatientRelationship (urn:hl7-org:sdtc) | |
| representedOrganization | C | 0..1 | Organization | 4515-184: When a provider is working on behalf of an organization an addr & telecom **SHALL** be present in representedOrganization (CONF:4515-184). |
| author | 0..* | Author | ||
| informant | 0..* | Informant | ||
| Slices for participant | 0..* | Participant2 | Slice: Unordered, Open by value:participantRole, value:typeCode | |
| participant:participant2 | 0..* | Participant2 | participant | |
| @nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
| @typeCode | 1..1 | cs | Binding: ParticipationType (required) Fixed Value: LOC | |
| @contextControlCode | 0..1 | cs | Binding: ContextControl (required) Fixed Value: OP | |
| realmCode | 0..* | CS | ||
| typeId | 0..1 | II | ||
| templateId | 0..* | II | ||
| sdtcFunctionCode | 0..1 | CE | XML Namespace: urn:hl7-org:sdtc XML: functionCode (urn:hl7-org:sdtc) | |
| time | 0..1 | IVL_TS | ||
| awarenessCode | 0..1 | CE | ||
| participantRole | 1..1 | ParticipantRole | ||
| participant:participant1 | C | 0..* | Participant2 | participant 4515-172: This participantRole SHALL contain exactly one [1..1] @nullFlavor="NI" No Information. (CONF:4515-172). |
| @nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
| @typeCode | 1..1 | cs | Binding: ParticipationType (required) Fixed Value: IND | |
| @contextControlCode | 0..1 | cs | Binding: ContextControl (required) Fixed Value: OP | |
| realmCode | 0..* | CS | ||
| typeId | 0..1 | II | ||
| templateId | 0..* | II | ||
| sdtcFunctionCode | 1..1 | CE | XML Namespace: urn:hl7-org:sdtc sdtc:functionCode XML: functionCode (urn:hl7-org:sdtc) Binding: Care Team Member Function (required) | |
| time | 0..1 | IVL_TS | ||
| awarenessCode | 0..1 | CE | ||
| participantRole | 1..1 | ParticipantRole | ||
| Slices for entryRelationship | 0..* | EntryRelationship | Slice: Unordered, Open by value:observation, value:typeCode | |
| entryRelationship:entryRelationship1 | 0..* | EntryRelationship | entryRelationship | |
| @nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
| realmCode | 0..* | CS | ||
| typeId | 0..1 | II | ||
| templateId | 0..* | II | ||
| @typeCode | 1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: REFR | |
| @inversionInd | 0..1 | bl | ||
| @contextConductionInd | 0..1 | bl | ||
| @negationInd | 0..1 | bl | ||
| sequenceNumber | 0..1 | INT | ||
| seperatableInd | 0..1 | BL | ||
| act | 0..1 | Act | ||
| encounter | 1..1 | Encounter | ||
| @classCode | 1..1 | cs | Binding: ActClass (required) Fixed Value: ENC | |
| @moodCode | 1..1 | cs | ||
| realmCode | 0..* | CS | ||
| typeId | 0..1 | II | ||
| templateId | 0..* | II | ||
| id | C | 1..1 | II | 4515-90: If the id does not match an encounter/id from an encounter elsewhere within the same document and the id does not contain @nullFlavor=NA, then this entry SHALL conform to the Encounter Activity (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.49:2015-08-01) (CONF:4515-90). |
| code | 0..1 | CD | Binding: ActEncounterCode (extensible) | |
| text | 0..1 | ED | ||
| statusCode | 0..1 | CS | Binding: ActStatus (required) | |
| effectiveTime | 0..1 | IVL_TS | ||
| sdtcDischargeDispositionCode | 0..1 | CE | XML Namespace: urn:hl7-org:sdtc XML: dischargeDispositionCode (urn:hl7-org:sdtc) | |
| priorityCode | 0..1 | CE | Binding: ActPriority (extensible) | |
| 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 | ||
| 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 | ||
| entryRelationship:entryRelationship2 | 0..* | EntryRelationship | entryRelationship | |
| @nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
| realmCode | 0..* | CS | ||
| typeId | 0..1 | II | ||
| templateId | 0..* | II | ||
| @typeCode | 1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: REFR | |
| @inversionInd | 0..1 | bl | ||
| @contextConductionInd | 0..1 | bl | ||
| @negationInd | 0..1 | bl | ||
| sequenceNumber | 0..1 | INT | ||
| seperatableInd | 0..1 | BL | ||
| act | 1..1 | NoteActivity | Base for all types and resources | |
| 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 | ||
| entryRelationship:entryRelationship3 | 0..1 | EntryRelationship | entryRelationship | |
| @nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
| realmCode | 0..* | CS | ||
| typeId | 0..1 | II | ||
| templateId | 0..* | II | ||
| @typeCode | 1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: REFR | |
| @inversionInd | 0..1 | bl | ||
| @contextConductionInd | 0..1 | bl | ||
| @negationInd | 0..1 | bl | ||
| sequenceNumber | 0..1 | INT | ||
| seperatableInd | 0..1 | BL | ||
| act | 0..1 | Act | ||
| encounter | 0..1 | Encounter | ||
| observation | 1..1 | CareTeamMemberScheduleObservation | Base for all types and resources | |
| observationMedia | 0..1 | ObservationMedia | ||
| organizer | 0..1 | Organizer | ||
| procedure | 0..1 | Procedure | ||
| regionOfInterest | 0..1 | RegionOfInterest | ||
| substanceAdministration | 0..1 | SubstanceAdministration | ||
| supply | 0..1 | Supply | ||
| reference | 0..* | Reference | ||
| precondition | 0..* | Precondition | ||
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Act.nullFlavor | required | NullFlavor |
| Act.templateId:templateId1.nullFlavor | required | NullFlavor |
| Act.code | extensible | ActCode |
| Act.code.nullFlavor | required | NullFlavor |
| Act.statusCode | required | ActStatus |
| Act.statusCode.nullFlavor | required | NullFlavor |
| Act.statusCode.code | required | ActStatus |
| Act.effectiveTime.nullFlavor | required | NullFlavor |
| Act.effectiveTime.operator | required | SetOperator |
| Act.priorityCode | extensible | ActPriority |
| Act.languageCode | required | HumanLanguage (a valid code from http://terminology.hl7.org/CodeSystem/ietf3066) |
| Act.performer:performer1.nullFlavor | required | NullFlavor |
| Act.performer:performer1.typeCode | required | Fixed Value: PRF |
| Act.performer:performer1.sdtcFunctionCode | preferred | Care Team Member Function |
| Act.performer:performer1.assignedEntity.classCode | required | Fixed Value: ASSIGNED |
| Act.performer:performer1.assignedEntity.id.nullFlavor | required | NullFlavor |
| Act.performer:performer1.assignedEntity.code | extensible | RoleCode |
| Act.performer:performer1.assignedEntity.assignedPerson.classCode | required | Fixed Value: PSN |
| Act.performer:performer1.assignedEntity.assignedPerson.determinerCode | required | Fixed Value: INSTANCE |
| Act.participant:participant2.nullFlavor | required | NullFlavor |
| Act.participant:participant2.typeCode | required | Fixed Value: LOC |
| Act.participant:participant2.contextControlCode | required | Fixed Value: OP |
| Act.participant:participant1.nullFlavor | required | NullFlavor |
| Act.participant:participant1.typeCode | required | Fixed Value: IND |
| Act.participant:participant1.contextControlCode | required | Fixed Value: OP |
| Act.participant:participant1.sdtcFunctionCode | required | Care Team Member Function |
| Act.entryRelationship:entryRelationship1.nullFlavor | required | NullFlavor |
| Act.entryRelationship:entryRelationship1.typeCode | required | Fixed Value: REFR |
| Act.entryRelationship:entryRelationship1.encounter.classCode | required | Fixed Value: ENC |
| Act.entryRelationship:entryRelationship1.encounter.code | extensible | ActEncounterCode |
| Act.entryRelationship:entryRelationship1.encounter.statusCode | required | ActStatus |
| Act.entryRelationship:entryRelationship1.encounter.priorityCode | extensible | ActPriority |
| Act.entryRelationship:entryRelationship2.nullFlavor | required | NullFlavor |
| Act.entryRelationship:entryRelationship2.typeCode | required | Fixed Value: REFR |
| Act.entryRelationship:entryRelationship3.nullFlavor | required | NullFlavor |
| Act.entryRelationship:entryRelationship3.typeCode | required | Fixed Value: REFR |
| Id | Grade | Path(s) | Details | Requirements |
| 4515-90 | error | Act.entryRelationship:entryRelationship1.encounter.id | If the id does not match an encounter/id from an encounter elsewhere within the same document and the id does not contain @nullFlavor=NA, then this entry SHALL conform to the Encounter Activity (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.49:2015-08-01) (CONF:4515-90). : | |
| 4515-172 | error | Act.participant:participant1 | This participantRole SHALL contain exactly one [1..1] @nullFlavor="NI" No Information. (CONF:4515-172). : | |
| 4515-180 | error | Act.performer:performer1.assignedEntity.id | If the assignedEntity/id is not referencing a Performer elsewhere in the document with an assignedPerson populated, this assignedEntity SHALL contain exactly one [1..1] assignedPerson (CONF:4515-180). : | |
| 4515-184 | error | Act.performer:performer1.assignedEntity.representedOrganization | When a provider is working on behalf of an organization an addr & telecom **SHALL** be present in representedOrganization (CONF:4515-184). : | |
| 81-9371 | error | Act.performer:performer1.assignedEntity.assignedPerson.name | The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). : | |
| 81-9372 | error | Act.performer:performer1.assignedEntity.assignedPerson.name | The string **SHALL NOT** contain name parts (CONF:81-9372). : | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| pn-no-ls | error | Act.performer:performer1.assignedEntity.assignedPerson.name | No PN name part may have a qualifier of LS. : (delimiter | family | given | prefix | suffix).where(qualifier = 'LS').empty() |
This structure is derived from CDAR2.Act
Summary
Mandatory: 12 elements (8 nested mandatory elements)
Fixed Value: 7 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
IG © 2019+ Health Level Seven. Package hl7.cda.us.ccda#2.1 based on FHIR 5.0.0. Generated 2023-09-29
Links: Table of Contents |
QA Report
| Version History 
|
|
Propose a change