Consolidated CDA (C-CDA)
3.0.0 - STU3
Consolidated CDA (C-CDA)
3.0.0 - STU3
This page is part of the CCDA: Consolidated CDA Release (v3.0.0: CCDA 3.0) generated with FHIR (HL7® FHIR® Standard) v5.0.0. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
| Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/CareTeamMemberAct | Version: 3.0.0 | |||
| Draft as of 2024-05-18 | Computable Name: CareTeamMemberAct | |||
| Other Identifiers: urn:ietf:rfc:3986#Uniform Resource Identifier (URI)#urn:hl7ii:2.16.840.1.113883.10.20.22.4.500.1:2024-05-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 Template, Differentials, Snapshots and how the different presentations work.
This structure is derived from Act
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Act |
C | 1..1 | Act | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, @negationInd, id, code, text, statusCode, effectiveTime, priorityCode, languageCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, sdtcInFulfillmentOf1 Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) should-text-ref-value: SHOULD contain text/reference/@value |
  Slices for templateId |
1..* | II | Slice: Unordered, Open by value:root, value:extension | |
   templateId:care-team-member-act |
1..1 | II | ||
  @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: 2024-05-01 | |
 @classCode |
1..1 | cs | Fixed Value: PCPR | |
| @moodCode |
1..1 | cs | Fixed Value: EVN | |
| code |
1..1 | CD | Care team information panel | |
| @code |
1..1 | cs | Required Pattern: 92707-9 | |
 @codeSystem |
1..1 | oid, uuid, ruid | LOINC Required Pattern: 2.16.840.1.113883.6.1 | |
| text |
0..1 | ED | SHOULD reference the portion of section narrative text corresponding to this entry | |
| reference |
C | 0..1 | TEL | value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative |
| statusCode |
1..1 | CS | ||
| @nullFlavor |
0..0 | |||
| @code |
1..1 | cs | Binding: ActStatus  (required) | |
| effectiveTime |
1..1 | IVL_TS | ||
| low |
1..1 | IVXB_TS | ||
| high |
0..1 | IVXB_TS | ||
| performer |
1..1 | Performer2 | ||
| sdtcFunctionCode |
0..1 | CE | XML Namespace: urn:hl7-org:sdtc (USCDI) Care Team Member Role - 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 |
C | 1..1 | AssignedEntity | 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). should-addr: SHOULD contain addr should-telecom: SHOULD contain telecom should-assignedPerson: SHOULD contain assignedPerson |
| id |
1..* | II | (USCDI) Care Team Member Identifier | |
| @root |
C | 0..1 | oid, uuid, ruid | should-npi: SHOULD be NPI |
 addr |
0..* | USRealmAddress | (USCDI) Care Team Member Location | |
| telecom |
0..* | TEL | (USCDI) Care Team Member Telecom | |
| assignedPerson |
0..1 | Person | (USCDI) Care Team Member Name | |
| name |
1..1 | USRealmPersonNamePNUSFIELDED | Base for all types and resources | |
| representedOrganization |
0..1 | Organization | ||
| telecom |
1..* | TEL | ||
| addr |
1..* | USRealmAddress | Base for all types and resources | |
| Slices for participant |
0..* | Participant2 | Slice: Unordered, Open by value:typeCode | |
 participant:location |
0..* | Participant2 | This participant represents the location where the care team member provides the service. | |
 @typeCode |
1..1 | cs | Fixed Value: LOC | |
| participantRole |
1..1 | ParticipantRole | ||
| participant:addl-functions |
0..* | Participant2 | This participant is used to express additional care team functions performed by this member of the team. Include additional participant to record additional roles (functionCode) this Care Team member plays. | |
| @typeCode |
1..1 | cs | Fixed Value: IND | |
| sdtcFunctionCode |
1..1 | CE | sdtc:functionCode Binding: Care Team Member Function (required) | |
 participantRole |
1..1 | ParticipantRole | ||
| @nullFlavor |
1..1 | cs | Required Pattern: NA | |
| Slices for entryRelationship |
0..* | EntryRelationship | Slice: Unordered, Open by profile:observation, profile:act, exists:encounter, exists:observation, exists:act | |
| entryRelationship:encounter |
0..* | EntryRelationship | entryRelationship | |
| @typeCode |
1..1 | cs | Fixed Value: REFR | |
| act |
0..0 | |||
 encounter |
C | 1..1 | Encounter | 4515-90: If the first 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). |
 id |
1..1 | II | ||
| observation |
0..0 | |||
| entryRelationship:note |
0..* | EntryRelationship | This is the note activity to narratively describe information about the member on the care team. | |
| @typeCode |
1..1 | cs | Fixed Value: REFR | |
| act |
1..1 | NoteActivity | Base for all types and resources | |
| encounter |
0..0 | |||
| observation |
0..0 | |||
| entryRelationship:schedule |
0..1 | EntryRelationship | This is the schedule of when or how frequently the care team member participates (or provides care to the patient) on the care team. | |
| @typeCode |
1..1 | cs | Fixed Value: REFR | |
| act |
0..0 | |||
| encounter |
0..0 | |||
| observation |
1..1 | CareTeamMemberScheduleObservation | Base for all types and resources | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Act.statusCode.code | required | ActStatus http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.15933 | |
| Act.performer.sdtcFunctionCode | preferred | CareTeamMemberFunction http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1099.30 | |
| Act.participant:addl-functions.sdtcFunctionCode | required | CareTeamMemberFunction http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1099.30 |
| Id | Grade | Path(s) | Details | Requirements |
| 4515-90 | error | Act.entryRelationship:encounter.encounter | If the first 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). : id.first().nullFlavor = 'NA' or (%resource.descendants().ofType(CDA.Encounter).where(hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/EncounterActivity') and id.exists($this.root = %context.id.first().root and $this.extension ~ %context.id.first().extension))) | |
| 4515-180 | error | Act.performer.assignedEntity | 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). : assignedPerson.exists() or (%resource.descendants().ofType(CDA.Performer2).where(assignedEntity.assignedPerson.exists() and assignedEntity.id.exists($this.root = %context.id.first().root and $this.extension ~ %context.id.first().extension))) | |
| should-addr | warning | Act.performer.assignedEntity | SHOULD contain addr : addr.exists() | |
| should-assignedPerson | warning | Act.performer.assignedEntity | SHOULD contain assignedPerson : assignedPerson.exists() | |
| should-npi | warning | Act.performer.assignedEntity.id.root | SHOULD be NPI : $this = '2.16.840.1.113883.4.6' | |
| should-telecom | warning | Act.performer.assignedEntity | SHOULD contain telecom : telecom.exists() | |
| should-text-ref-value | warning | Act | SHOULD contain text/reference/@value : text.reference.value.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 |
|---|---|---|---|---|
| Act |
C | 1..1 | Act | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, @negationInd, id, code, text, statusCode, effectiveTime, priorityCode, languageCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, sdtcInFulfillmentOf1 Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) should-text-ref-value: SHOULD contain text/reference/@value |
| Slices for templateId |
1..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:care-team-member-act |
1..1 | II | ||
 @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: 2024-05-01 | |
| @classCode |
1..1 | cs | Binding: XActClassDocumentEntryAct (2.0.0) (required) Fixed Value: PCPR | |
| @moodCode |
1..1 | cs | Binding: XDocumentActMood (2.0.0) (required) Fixed Value: EVN | |
| code |
1..1 | CD | Care team information panel Binding: v3 Code System ActCode (example) | |
| @code |
1..1 | cs | Required Pattern: 92707-9 | |
| @codeSystem |
1..1 | oid, uuid, ruid | LOINC Required Pattern: 2.16.840.1.113883.6.1 | |
| text |
0..1 | ED | SHOULD reference the portion of section narrative text corresponding to this entry | |
| reference |
C | 0..1 | TEL | value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative |
| 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 | ||
| performer |
1..1 | Performer2 | ||
| sdtcFunctionCode |
0..1 | CE | XML Namespace: urn:hl7-org:sdtc (USCDI) Care Team Member Role - 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 |
C | 1..1 | AssignedEntity | 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). should-addr: SHOULD contain addr should-telecom: SHOULD contain telecom should-assignedPerson: SHOULD contain assignedPerson |
| id |
1..* | II | (USCDI) Care Team Member Identifier | |
| @root |
C | 0..1 | oid, uuid, ruid | should-npi: SHOULD be NPI |
| addr |
C | 0..* | USRealmAddress | (USCDI) Care Team Member Location shall-city: SHALL contain exactly one [1..1] city (CONF:81-7292). shall-streetAddressLine: SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). should-use: SHOULD contain @use should-country: SHOULD contain country 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296) 81-10024: If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024). 81-10025: If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025). shall-max-ad-parts: SHALL have at most one of each: state, city, postalCode, and country |
| telecom |
0..* | TEL | (USCDI) Care Team Member Telecom | |
| assignedPerson |
0..1 | Person | (USCDI) Care Team Member Name | |
| name |
C | 1..1 | USRealmPersonNamePNUSFIELDED | Base for all types and resources pn-no-ls: No PN name part may have a qualifier of LS. 81-9371: The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). 81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372). |
| representedOrganization |
0..1 | Organization | ||
| telecom |
1..* | TEL | ||
| addr |
C | 1..* | USRealmAddress | Base for all types and resources shall-city: SHALL contain exactly one [1..1] city (CONF:81-7292). shall-streetAddressLine: SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). should-use: SHOULD contain @use should-country: SHOULD contain country 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296) 81-10024: If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024). 81-10025: If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025). shall-max-ad-parts: SHALL have at most one of each: state, city, postalCode, and country |
| Slices for participant |
0..* | Participant2 | Slice: Unordered, Open by value:typeCode | |
| participant:location |
0..* | Participant2 | This participant represents the location where the care team member provides the service. | |
| @typeCode |
1..1 | cs | Binding: CDAParticipationType (required) Fixed Value: LOC | |
| participantRole |
1..1 | ParticipantRole | ||
| participant:addl-functions |
0..* | Participant2 | This participant is used to express additional care team functions performed by this member of the team. Include additional participant to record additional roles (functionCode) this Care Team member plays. | |
| @typeCode |
1..1 | cs | Binding: CDAParticipationType (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 | ||
| @nullFlavor |
1..1 | cs | Binding: CDANullFlavor (required) Required Pattern: NA | |
| Slices for entryRelationship |
0..* | EntryRelationship | Slice: Unordered, Open by profile:observation, profile:act, exists:encounter, exists:observation, exists:act | |
| entryRelationship:encounter |
0..* | EntryRelationship | entryRelationship | |
| @typeCode |
1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: REFR | |
| encounter |
C | 1..1 | Encounter | 4515-90: If the first 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). |
| @classCode |
1..1 | cs | Binding: CDAActClass (required) Fixed Value: ENC | |
| @moodCode |
1..1 | cs | Binding: XDocumentEncounterMood (2.0.0) (required) | |
| id |
1..1 | II | ||
| entryRelationship:note |
0..* | EntryRelationship | This is the note activity to narratively describe information about the member on the care team. | |
| @typeCode |
1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: REFR | |
| act |
C | 1..1 | NoteActivity | Base for all types and resources should-text-ref-value: SHOULD contain text/reference/@value |
| entryRelationship:schedule |
0..1 | EntryRelationship | This is the schedule of when or how frequently the care team member participates (or provides care to the patient) on the care team. | |
| @typeCode |
1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: REFR | |
| observation |
C | 1..1 | CareTeamMemberScheduleObservation | Base for all types and resources should-text-ref-value: SHOULD contain text/reference/@value |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Act.classCode | required | Fixed Value: PCPRhttp://terminology.hl7.org/ValueSet/v3-xActClassDocumentEntryAct|2.0.0 | |
| Act.moodCode | required | Fixed Value: EVNhttp://terminology.hl7.org/ValueSet/v3-xDocumentActMood|2.0.0 | |
| Act.code | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | |
| Act.statusCode | required | ActStatushttp://terminology.hl7.org/ValueSet/v3-ActStatus | |
| Act.statusCode.code | required | ActStatus http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.15933 | |
| Act.performer.sdtcFunctionCode | preferred | CareTeamMemberFunction http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1099.30 | |
| Act.participant:location.typeCode | required | Fixed Value: LOChttp://hl7.org/cda/stds/core/ValueSet/CDAParticipationType | |
| Act.participant:addl-functions.typeCode | required | Fixed Value: INDhttp://hl7.org/cda/stds/core/ValueSet/CDAParticipationType | |
| Act.participant:addl-functions.sdtcFunctionCode | required | CareTeamMemberFunction http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1099.30 | |
| Act.participant:addl-functions.participantRole.nullFlavor | required | Pattern: NAhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Act.entryRelationship:encounter.typeCode | required | Fixed Value: REFRhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship | |
| Act.entryRelationship:encounter.encounter.classCode | required | Fixed Value: ENChttp://hl7.org/cda/stds/core/ValueSet/CDAActClass | |
| Act.entryRelationship:encounter.encounter.moodCode | required | XDocumentEncounterMoodhttp://terminology.hl7.org/ValueSet/v3-xDocumentEncounterMood|2.0.0 | |
| Act.entryRelationship:note.typeCode | required | Fixed Value: REFRhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship | |
| Act.entryRelationship:schedule.typeCode | required | Fixed Value: REFRhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship |
| Id | Grade | Path(s) | Details | Requirements |
| 4515-90 | error | Act.entryRelationship:encounter.encounter | If the first 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). : id.first().nullFlavor = 'NA' or (%resource.descendants().ofType(CDA.Encounter).where(hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/EncounterActivity') and id.exists($this.root = %context.id.first().root and $this.extension ~ %context.id.first().extension))) | |
| 4515-180 | error | Act.performer.assignedEntity | 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). : assignedPerson.exists() or (%resource.descendants().ofType(CDA.Performer2).where(assignedEntity.assignedPerson.exists() and assignedEntity.id.exists($this.root = %context.id.first().root and $this.extension ~ %context.id.first().extension))) | |
| 81-7296 | error | Act.performer.assignedEntity.addr, Act.performer.assignedEntity.representedOrganization.addr | **SHALL NOT** have mixed content except for white space (CONF:81-7296) : item.xmlText.empty() | |
| 81-9371 | error | Act.performer.assignedEntity.assignedPerson.name | The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). : conformsTo('http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPatientNamePTNUSFIELDED') or item.xmlText.exists() | |
| 81-9372 | error | Act.performer.assignedEntity.assignedPerson.name | The string **SHALL NOT** contain name parts (CONF:81-9372). : item.xmlText.exists() implies (item.delimiter | item.family | item.given | item.prefix | item.suffix).empty() | |
| 81-10024 | error | Act.performer.assignedEntity.addr, Act.performer.assignedEntity.representedOrganization.addr | If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024). : nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state')) | |
| 81-10025 | error | Act.performer.assignedEntity.addr, Act.performer.assignedEntity.representedOrganization.addr | If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025). : nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?')) | |
| pn-no-ls | error | Act.performer.assignedEntity.assignedPerson.name | No PN name part may have a qualifier of LS. : (item.delimiter | item.family | item.given | item.prefix | item.suffix).where(qualifier.where($this = 'LS').exists()).empty() | |
| shall-city | error | Act.performer.assignedEntity.addr, Act.performer.assignedEntity.representedOrganization.addr | SHALL contain exactly one [1..1] city (CONF:81-7292). : nullFlavor.exists() or item.city.count() = 1 | |
| shall-max-ad-parts | error | Act.performer.assignedEntity.addr, Act.performer.assignedEntity.representedOrganization.addr | SHALL have at most one of each: state, city, postalCode, and country : (item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1) | |
| shall-streetAddressLine | error | Act.performer.assignedEntity.addr, Act.performer.assignedEntity.representedOrganization.addr | SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). : nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4) | |
| should-addr | warning | Act.performer.assignedEntity | SHOULD contain addr : addr.exists() | |
| should-assignedPerson | warning | Act.performer.assignedEntity | SHOULD contain assignedPerson : assignedPerson.exists() | |
| should-country | warning | Act.performer.assignedEntity.addr, Act.performer.assignedEntity.representedOrganization.addr | SHOULD contain country : nullFlavor.exists() or item.country.exists() | |
| should-npi | warning | Act.performer.assignedEntity.id.root | SHOULD be NPI : $this = '2.16.840.1.113883.4.6' | |
| should-telecom | warning | Act.performer.assignedEntity | SHOULD contain telecom : telecom.exists() | |
| should-text-ref-value | warning | Act | SHOULD contain text/reference/@value : text.reference.value.exists() | |
| should-text-ref-value | warning | Act.entryRelationship:note.act, Act.entryRelationship:schedule.observation | SHOULD contain text/reference/@value : text.reference.value.exists() | |
| should-use | warning | Act.performer.assignedEntity.addr, Act.performer.assignedEntity.representedOrganization.addr | 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 |
|---|---|---|---|---|
| Act |
C | 1..1 | Act | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, @negationInd, id, code, text, statusCode, effectiveTime, priorityCode, languageCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, sdtcInFulfillmentOf1 Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) should-text-ref-value: SHOULD contain text/reference/@value |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
0..1 | II | ||
| @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 |
1..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:care-team-member-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.22.4.500.1 | |
| @extension |
1..1 | st | Required Pattern: 2024-05-01 | |
| @classCode |
1..1 | cs | Binding: XActClassDocumentEntryAct (2.0.0) (required) Fixed Value: PCPR | |
| @moodCode |
1..1 | cs | Binding: XDocumentActMood (2.0.0) (required) Fixed Value: EVN | |
| @negationInd |
0..1 | bl | ||
| id |
0..* | II | ||
| code |
1..1 | CD | Care team information panel Binding: v3 Code System ActCode (example) | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @code |
1..1 | cs | Required Pattern: 92707-9 | |
| @codeSystem |
1..1 | oid, uuid, ruid | LOINC 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 | ||
| text |
0..1 | ED | SHOULD reference the portion of section narrative text corresponding to this entry | |
| @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 | value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative |
| thumbnail |
0..1 | ED | ||
| statusCode |
1..1 | CS | Binding: ActStatus (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: CDANullFlavor (required) | |
| @value |
0..1 | ts | Date Format: YYYYMMDDHHMMSS.UUUU[+|-ZZzz] | |
| @operator |
0..1 | cs | Binding: CDASetOperator (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 (example) | |
| languageCode |
0..1 | CS | Binding: AllLanguages (required) | |
| subject |
0..1 | Subject | ||
| specimen |
0..* | Specimen | ||
| performer |
1..1 | Performer2 | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
0..1 | II | ||
| @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 |
0..1 | cs | Binding: ParticipationPhysicalPerformer (required) Fixed Value: PRF | |
| sdtcFunctionCode |
0..1 | CE | XML Namespace: urn:hl7-org:sdtc (USCDI) Care Team Member Role - 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 |
C | 1..1 | AssignedEntity | 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). should-addr: SHOULD contain addr should-telecom: SHOULD contain telecom should-assignedPerson: SHOULD contain assignedPerson |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
0..1 | II | ||
| @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 | (USCDI) Care Team Member Identifier | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
C | 0..1 | oid, uuid, ruid | should-npi: SHOULD be NPI |
| @extension |
0..1 | st | ||
| sdtcIdentifiedBy |
0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |
| code |
0..1 | CE | Binding: CDARoleCode (example) | |
| addr |
C | 0..* | USRealmAddress | (USCDI) Care Team Member Location shall-city: SHALL contain exactly one [1..1] city (CONF:81-7292). shall-streetAddressLine: SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). should-use: SHOULD contain @use should-country: SHOULD contain country 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296) 81-10024: If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024). 81-10025: If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025). shall-max-ad-parts: SHALL have at most one of each: state, city, postalCode, and country |
| telecom |
0..* | TEL | (USCDI) Care Team Member Telecom | |
| assignedPerson |
0..1 | Person | (USCDI) Care Team Member Name | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
0..1 | II | ||
| @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: EntityClassLivingSubject (required) Fixed Value: PSN | |
| @determinerCode |
0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
| name |
C | 1..1 | USRealmPersonNamePNUSFIELDED | Base for all types and resources pn-no-ls: No PN name part may have a qualifier of LS. 81-9371: The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). 81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372). |
| sdtcDesc |
0..1 | ED | XML Namespace: urn:hl7-org:sdtc XML: desc (urn:hl7-org:sdtc) | |
| sdtcAsPatientRelationship |
0..* | InfrastructureRoot | XML Namespace: urn:hl7-org:sdtc XML: asPatientRelationship (urn:hl7-org:sdtc) | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
0..1 | II | ||
| @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 | Fixed Value: PRS | |
| @determinerCode |
0..1 | cs | Fixed Value: INSTANCE | |
| code |
1..1 | CE | XML Namespace: urn:hl7-org:sdtc XML Namespace: urn:hl7-org:sdtc | |
| representedOrganization |
0..1 | Organization | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
0..1 | II | ||
| @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: EntityClassOrganization (required) Fixed Value: ORG | |
| @determinerCode |
0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
| id |
0..* | II | ||
| name |
0..* | ON | ||
| telecom |
1..* | TEL | ||
| addr |
C | 1..* | USRealmAddress | Base for all types and resources shall-city: SHALL contain exactly one [1..1] city (CONF:81-7292). shall-streetAddressLine: SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). should-use: SHOULD contain @use should-country: SHOULD contain country 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296) 81-10024: If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024). 81-10025: If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025). shall-max-ad-parts: SHALL have at most one of each: state, city, postalCode, and country |
| 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 | |
| author |
0..* | Author | ||
| informant |
0..* | Informant | ||
| Slices for participant |
0..* | Participant2 | Slice: Unordered, Open by value:typeCode | |
| participant:location |
0..* | Participant2 | This participant represents the location where the care team member provides the service. | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
0..1 | II | ||
| @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: LOC | |
| @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 |
1..1 | ParticipantRole | ||
| participant:addl-functions |
0..* | Participant2 | This participant is used to express additional care team functions performed by this member of the team. Include additional participant to record additional roles (functionCode) this Care Team member plays. | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
0..1 | II | ||
| @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: IND | |
| @contextControlCode |
0..1 | cs | Binding: CDAContextControl (required) Fixed Value: OP | |
| 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 | ||
| @nullFlavor |
1..1 | cs | Binding: CDANullFlavor (required) Required Pattern: NA | |
| realmCode |
0..* | CS | ||
| typeId |
0..1 | II | ||
| @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 |
0..* | II | ||
| sdtcIdentifiedBy |
0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |
| code |
0..1 | CE | Binding: CDARoleCode (example) | |
| addr |
0..* | AD | ||
| telecom |
0..* | TEL | ||
| playingDevice |
0..1 | Device | ||
| playingEntity |
0..1 | PlayingEntity | ||
| scopingEntity |
0..1 | Entity | ||
| Slices for entryRelationship |
0..* | EntryRelationship | Slice: Unordered, Open by profile:observation, profile:act, exists:encounter, exists:observation, exists:act | |
| entryRelationship:encounter |
0..* | EntryRelationship | entryRelationship | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
0..1 | II | ||
| @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 | ||
| encounter |
C | 1..1 | Encounter | 4515-90: If the first 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). |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
0..1 | II | ||
| @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: CDAActClass (required) Fixed Value: ENC | |
| @moodCode |
1..1 | cs | Binding: XDocumentEncounterMood (2.0.0) (required) | |
| id |
1..1 | II | ||
| code |
0..1 | CD | Binding: ActEncounterCode (example) | |
| 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 (example) | |
| 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) | |
| 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:note |
0..* | EntryRelationship | This is the note activity to narratively describe information about the member on the care team. | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
0..1 | II | ||
| @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 |
C | 1..1 | NoteActivity | Base for all types and resources should-text-ref-value: SHOULD contain text/reference/@value |
| 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:schedule |
0..1 | EntryRelationship | This is the schedule of when or how frequently the care team member participates (or provides care to the patient) on the care team. | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
0..1 | II | ||
| @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 | ||
| observation |
C | 1..1 | CareTeamMemberScheduleObservation | Base for all types and resources should-text-ref-value: SHOULD contain text/reference/@value |
| 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 | Conformance | ValueSet / Code | URI |
| Act.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Act.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Act.templateId:care-team-member-act.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Act.classCode | required | Fixed Value: PCPRhttp://terminology.hl7.org/ValueSet/v3-xActClassDocumentEntryAct|2.0.0 | |
| Act.moodCode | required | Fixed Value: EVNhttp://terminology.hl7.org/ValueSet/v3-xDocumentActMood|2.0.0 | |
| Act.code | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | |
| Act.code.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Act.text.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Act.text.compression | required | CDACompressionAlgorithmhttp://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm | |
| Act.text.integrityCheckAlgorithm | required | IntegrityCheckAlgorithmhttp://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0 | |
| Act.text.mediaType | example | MediaTypehttp://terminology.hl7.org/ValueSet/v3-MediaType | |
| Act.text.representation | required | BinaryDataEncodinghttp://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding | |
| Act.statusCode | required | ActStatushttp://terminology.hl7.org/ValueSet/v3-ActStatus | |
| Act.statusCode.code | required | ActStatus http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.15933 | |
| Act.effectiveTime.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Act.effectiveTime.operator | required | CDASetOperatorhttp://hl7.org/cda/stds/core/ValueSet/CDASetOperator | |
| Act.priorityCode | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority | |
| Act.languageCode | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languagesfrom the FHIR Standard | |
| Act.performer.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Act.performer.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Act.performer.typeCode | required | Fixed Value: PRFhttp://terminology.hl7.org/ValueSet/v3-ParticipationPhysicalPerformer | |
| Act.performer.sdtcFunctionCode | preferred | CareTeamMemberFunction http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1099.30 | |
| Act.performer.assignedEntity.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Act.performer.assignedEntity.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Act.performer.assignedEntity.classCode | required | Fixed Value: ASSIGNEDhttp://terminology.hl7.org/ValueSet/v3-RoleClassAssignedEntity | |
| Act.performer.assignedEntity.id.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Act.performer.assignedEntity.code | example | CDARoleCodehttp://hl7.org/cda/stds/core/ValueSet/CDARoleCode | |
| Act.performer.assignedEntity.assignedPerson.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Act.performer.assignedEntity.assignedPerson.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Act.performer.assignedEntity.assignedPerson.classCode | required | Fixed Value: PSNhttp://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject | |
| Act.performer.assignedEntity.assignedPerson.determinerCode | required | Fixed Value: INSTANCEhttp://terminology.hl7.org/ValueSet/v3-EntityDeterminer | |
| Act.performer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Act.performer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Act.performer.assignedEntity.representedOrganization.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Act.performer.assignedEntity.representedOrganization.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Act.performer.assignedEntity.representedOrganization.classCode | required | Fixed Value: ORGhttp://terminology.hl7.org/ValueSet/v3-EntityClassOrganization | |
| Act.performer.assignedEntity.representedOrganization.determinerCode | required | Fixed Value: INSTANCEhttp://terminology.hl7.org/ValueSet/v3-EntityDeterminer | |
| Act.performer.assignedEntity.representedOrganization.standardIndustryClassCode | example | OrganizationIndustryClassNAICShttp://terminology.hl7.org/ValueSet/v3-OrganizationIndustryClassNAICS | |
| Act.participant:location.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Act.participant:location.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Act.participant:location.typeCode | required | Fixed Value: LOChttp://hl7.org/cda/stds/core/ValueSet/CDAParticipationType | |
| Act.participant:location.contextControlCode | required | Fixed Value: OPhttp://hl7.org/cda/stds/core/ValueSet/CDAContextControl | |
| Act.participant:addl-functions.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Act.participant:addl-functions.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Act.participant:addl-functions.typeCode | required | Fixed Value: INDhttp://hl7.org/cda/stds/core/ValueSet/CDAParticipationType | |
| Act.participant:addl-functions.contextControlCode | required | Fixed Value: OPhttp://hl7.org/cda/stds/core/ValueSet/CDAContextControl | |
| Act.participant:addl-functions.sdtcFunctionCode | required | CareTeamMemberFunction http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1099.30 | |
| Act.participant:addl-functions.participantRole.nullFlavor | required | Pattern: NAhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Act.participant:addl-functions.participantRole.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Act.participant:addl-functions.participantRole.classCode | required | CDARoleClassRoothttp://hl7.org/cda/stds/core/ValueSet/CDARoleClassRoot | |
| Act.participant:addl-functions.participantRole.code | example | CDARoleCodehttp://hl7.org/cda/stds/core/ValueSet/CDARoleCode | |
| Act.entryRelationship:encounter.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Act.entryRelationship:encounter.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Act.entryRelationship:encounter.typeCode | required | Fixed Value: REFRhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship | |
| Act.entryRelationship:encounter.encounter.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Act.entryRelationship:encounter.encounter.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Act.entryRelationship:encounter.encounter.classCode | required | Fixed Value: ENChttp://hl7.org/cda/stds/core/ValueSet/CDAActClass | |
| Act.entryRelationship:encounter.encounter.moodCode | required | XDocumentEncounterMoodhttp://terminology.hl7.org/ValueSet/v3-xDocumentEncounterMood|2.0.0 | |
| Act.entryRelationship:encounter.encounter.code | example | ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode | |
| Act.entryRelationship:encounter.encounter.statusCode | required | ActStatushttp://terminology.hl7.org/ValueSet/v3-ActStatus | |
| Act.entryRelationship:encounter.encounter.priorityCode | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority | |
| Act.entryRelationship:note.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Act.entryRelationship:note.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Act.entryRelationship:note.typeCode | required | Fixed Value: REFRhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship | |
| Act.entryRelationship:schedule.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Act.entryRelationship:schedule.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Act.entryRelationship:schedule.typeCode | required | Fixed Value: REFRhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship |
| Id | Grade | Path(s) | Details | Requirements |
| 4515-90 | error | Act.entryRelationship:encounter.encounter | If the first 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). : id.first().nullFlavor = 'NA' or (%resource.descendants().ofType(CDA.Encounter).where(hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/EncounterActivity') and id.exists($this.root = %context.id.first().root and $this.extension ~ %context.id.first().extension))) | |
| 4515-180 | error | Act.performer.assignedEntity | 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). : assignedPerson.exists() or (%resource.descendants().ofType(CDA.Performer2).where(assignedEntity.assignedPerson.exists() and assignedEntity.id.exists($this.root = %context.id.first().root and $this.extension ~ %context.id.first().extension))) | |
| 81-7296 | error | Act.performer.assignedEntity.addr, Act.performer.assignedEntity.representedOrganization.addr | **SHALL NOT** have mixed content except for white space (CONF:81-7296) : item.xmlText.empty() | |
| 81-9371 | error | Act.performer.assignedEntity.assignedPerson.name | The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). : conformsTo('http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPatientNamePTNUSFIELDED') or item.xmlText.exists() | |
| 81-9372 | error | Act.performer.assignedEntity.assignedPerson.name | The string **SHALL NOT** contain name parts (CONF:81-9372). : item.xmlText.exists() implies (item.delimiter | item.family | item.given | item.prefix | item.suffix).empty() | |
| 81-10024 | error | Act.performer.assignedEntity.addr, Act.performer.assignedEntity.representedOrganization.addr | If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024). : nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state')) | |
| 81-10025 | error | Act.performer.assignedEntity.addr, Act.performer.assignedEntity.representedOrganization.addr | If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025). : nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?')) | |
| pn-no-ls | error | Act.performer.assignedEntity.assignedPerson.name | No PN name part may have a qualifier of LS. : (item.delimiter | item.family | item.given | item.prefix | item.suffix).where(qualifier.where($this = 'LS').exists()).empty() | |
| shall-city | error | Act.performer.assignedEntity.addr, Act.performer.assignedEntity.representedOrganization.addr | SHALL contain exactly one [1..1] city (CONF:81-7292). : nullFlavor.exists() or item.city.count() = 1 | |
| shall-max-ad-parts | error | Act.performer.assignedEntity.addr, Act.performer.assignedEntity.representedOrganization.addr | SHALL have at most one of each: state, city, postalCode, and country : (item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1) | |
| shall-streetAddressLine | error | Act.performer.assignedEntity.addr, Act.performer.assignedEntity.representedOrganization.addr | SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). : nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4) | |
| should-addr | warning | Act.performer.assignedEntity | SHOULD contain addr : addr.exists() | |
| should-assignedPerson | warning | Act.performer.assignedEntity | SHOULD contain assignedPerson : assignedPerson.exists() | |
| should-country | warning | Act.performer.assignedEntity.addr, Act.performer.assignedEntity.representedOrganization.addr | SHOULD contain country : nullFlavor.exists() or item.country.exists() | |
| should-npi | warning | Act.performer.assignedEntity.id.root | SHOULD be NPI : $this = '2.16.840.1.113883.4.6' | |
| should-telecom | warning | Act.performer.assignedEntity | SHOULD contain telecom : telecom.exists() | |
| should-text-ref-value | warning | Act | SHOULD contain text/reference/@value : text.reference.value.exists() | |
| should-text-ref-value | warning | Act.entryRelationship:note.act, Act.entryRelationship:schedule.observation | SHOULD contain text/reference/@value : text.reference.value.exists() | |
| should-use | warning | Act.performer.assignedEntity.addr, Act.performer.assignedEntity.representedOrganization.addr | 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: 11 elements(9 nested mandatory elements)
Fixed: 7 elements
Prohibited: 7 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Act
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Act |
C | 1..1 | Act | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, @negationInd, id, code, text, statusCode, effectiveTime, priorityCode, languageCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, sdtcInFulfillmentOf1 Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) should-text-ref-value: SHOULD contain text/reference/@value |
| Slices for templateId |
1..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:care-team-member-act |
1..1 | II | ||
| @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: 2024-05-01 | |
| @classCode |
1..1 | cs | Fixed Value: PCPR | |
| @moodCode |
1..1 | cs | Fixed Value: EVN | |
| code |
1..1 | CD | Care team information panel | |
| @code |
1..1 | cs | Required Pattern: 92707-9 | |
| @codeSystem |
1..1 | oid, uuid, ruid | LOINC Required Pattern: 2.16.840.1.113883.6.1 | |
| text |
0..1 | ED | SHOULD reference the portion of section narrative text corresponding to this entry | |
| reference |
C | 0..1 | TEL | value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative |
| statusCode |
1..1 | CS | ||
| @nullFlavor |
0..0 | |||
| @code |
1..1 | cs | Binding: ActStatus (required) | |
| effectiveTime |
1..1 | IVL_TS | ||
| low |
1..1 | IVXB_TS | ||
| high |
0..1 | IVXB_TS | ||
| performer |
1..1 | Performer2 | ||
| sdtcFunctionCode |
0..1 | CE | XML Namespace: urn:hl7-org:sdtc (USCDI) Care Team Member Role - 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 |
C | 1..1 | AssignedEntity | 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). should-addr: SHOULD contain addr should-telecom: SHOULD contain telecom should-assignedPerson: SHOULD contain assignedPerson |
| id |
1..* | II | (USCDI) Care Team Member Identifier | |
| @root |
C | 0..1 | oid, uuid, ruid | should-npi: SHOULD be NPI |
| addr |
0..* | USRealmAddress | (USCDI) Care Team Member Location | |
| telecom |
0..* | TEL | (USCDI) Care Team Member Telecom | |
| assignedPerson |
0..1 | Person | (USCDI) Care Team Member Name | |
| name |
1..1 | USRealmPersonNamePNUSFIELDED | Base for all types and resources | |
| representedOrganization |
0..1 | Organization | ||
| telecom |
1..* | TEL | ||
| addr |
1..* | USRealmAddress | Base for all types and resources | |
| Slices for participant |
0..* | Participant2 | Slice: Unordered, Open by value:typeCode | |
| participant:location |
0..* | Participant2 | This participant represents the location where the care team member provides the service. | |
| @typeCode |
1..1 | cs | Fixed Value: LOC | |
| participantRole |
1..1 | ParticipantRole | ||
| participant:addl-functions |
0..* | Participant2 | This participant is used to express additional care team functions performed by this member of the team. Include additional participant to record additional roles (functionCode) this Care Team member plays. | |
| @typeCode |
1..1 | cs | Fixed Value: IND | |
| sdtcFunctionCode |
1..1 | CE | sdtc:functionCode Binding: Care Team Member Function (required) | |
| participantRole |
1..1 | ParticipantRole | ||
| @nullFlavor |
1..1 | cs | Required Pattern: NA | |
| Slices for entryRelationship |
0..* | EntryRelationship | Slice: Unordered, Open by profile:observation, profile:act, exists:encounter, exists:observation, exists:act | |
| entryRelationship:encounter |
0..* | EntryRelationship | entryRelationship | |
| @typeCode |
1..1 | cs | Fixed Value: REFR | |
| act |
0..0 | |||
| encounter |
C | 1..1 | Encounter | 4515-90: If the first 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). |
| id |
1..1 | II | ||
| observation |
0..0 | |||
| entryRelationship:note |
0..* | EntryRelationship | This is the note activity to narratively describe information about the member on the care team. | |
| @typeCode |
1..1 | cs | Fixed Value: REFR | |
| act |
1..1 | NoteActivity | Base for all types and resources | |
| encounter |
0..0 | |||
| observation |
0..0 | |||
| entryRelationship:schedule |
0..1 | EntryRelationship | This is the schedule of when or how frequently the care team member participates (or provides care to the patient) on the care team. | |
| @typeCode |
1..1 | cs | Fixed Value: REFR | |
| act |
0..0 | |||
| encounter |
0..0 | |||
| observation |
1..1 | CareTeamMemberScheduleObservation | Base for all types and resources | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Act.statusCode.code | required | ActStatus http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.15933 | |
| Act.performer.sdtcFunctionCode | preferred | CareTeamMemberFunction http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1099.30 | |
| Act.participant:addl-functions.sdtcFunctionCode | required | CareTeamMemberFunction http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1099.30 |
| Id | Grade | Path(s) | Details | Requirements |
| 4515-90 | error | Act.entryRelationship:encounter.encounter | If the first 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). : id.first().nullFlavor = 'NA' or (%resource.descendants().ofType(CDA.Encounter).where(hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/EncounterActivity') and id.exists($this.root = %context.id.first().root and $this.extension ~ %context.id.first().extension))) | |
| 4515-180 | error | Act.performer.assignedEntity | 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). : assignedPerson.exists() or (%resource.descendants().ofType(CDA.Performer2).where(assignedEntity.assignedPerson.exists() and assignedEntity.id.exists($this.root = %context.id.first().root and $this.extension ~ %context.id.first().extension))) | |
| should-addr | warning | Act.performer.assignedEntity | SHOULD contain addr : addr.exists() | |
| should-assignedPerson | warning | Act.performer.assignedEntity | SHOULD contain assignedPerson : assignedPerson.exists() | |
| should-npi | warning | Act.performer.assignedEntity.id.root | SHOULD be NPI : $this = '2.16.840.1.113883.4.6' | |
| should-telecom | warning | Act.performer.assignedEntity | SHOULD contain telecom : telecom.exists() | |
| should-text-ref-value | warning | Act | SHOULD contain text/reference/@value : text.reference.value.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('#') |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Act |
C | 1..1 | Act | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, @negationInd, id, code, text, statusCode, effectiveTime, priorityCode, languageCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, sdtcInFulfillmentOf1 Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) should-text-ref-value: SHOULD contain text/reference/@value |
| Slices for templateId |
1..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:care-team-member-act |
1..1 | II | ||
| @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: 2024-05-01 | |
| @classCode |
1..1 | cs | Binding: XActClassDocumentEntryAct (2.0.0) (required) Fixed Value: PCPR | |
| @moodCode |
1..1 | cs | Binding: XDocumentActMood (2.0.0) (required) Fixed Value: EVN | |
| code |
1..1 | CD | Care team information panel Binding: v3 Code System ActCode (example) | |
| @code |
1..1 | cs | Required Pattern: 92707-9 | |
| @codeSystem |
1..1 | oid, uuid, ruid | LOINC Required Pattern: 2.16.840.1.113883.6.1 | |
| text |
0..1 | ED | SHOULD reference the portion of section narrative text corresponding to this entry | |
| reference |
C | 0..1 | TEL | value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative |
| 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 | ||
| performer |
1..1 | Performer2 | ||
| sdtcFunctionCode |
0..1 | CE | XML Namespace: urn:hl7-org:sdtc (USCDI) Care Team Member Role - 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 |
C | 1..1 | AssignedEntity | 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). should-addr: SHOULD contain addr should-telecom: SHOULD contain telecom should-assignedPerson: SHOULD contain assignedPerson |
| id |
1..* | II | (USCDI) Care Team Member Identifier | |
| @root |
C | 0..1 | oid, uuid, ruid | should-npi: SHOULD be NPI |
| addr |
C | 0..* | USRealmAddress | (USCDI) Care Team Member Location shall-city: SHALL contain exactly one [1..1] city (CONF:81-7292). shall-streetAddressLine: SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). should-use: SHOULD contain @use should-country: SHOULD contain country 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296) 81-10024: If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024). 81-10025: If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025). shall-max-ad-parts: SHALL have at most one of each: state, city, postalCode, and country |
| telecom |
0..* | TEL | (USCDI) Care Team Member Telecom | |
| assignedPerson |
0..1 | Person | (USCDI) Care Team Member Name | |
| name |
C | 1..1 | USRealmPersonNamePNUSFIELDED | Base for all types and resources pn-no-ls: No PN name part may have a qualifier of LS. 81-9371: The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). 81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372). |
| representedOrganization |
0..1 | Organization | ||
| telecom |
1..* | TEL | ||
| addr |
C | 1..* | USRealmAddress | Base for all types and resources shall-city: SHALL contain exactly one [1..1] city (CONF:81-7292). shall-streetAddressLine: SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). should-use: SHOULD contain @use should-country: SHOULD contain country 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296) 81-10024: If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024). 81-10025: If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025). shall-max-ad-parts: SHALL have at most one of each: state, city, postalCode, and country |
| Slices for participant |
0..* | Participant2 | Slice: Unordered, Open by value:typeCode | |
| participant:location |
0..* | Participant2 | This participant represents the location where the care team member provides the service. | |
| @typeCode |
1..1 | cs | Binding: CDAParticipationType (required) Fixed Value: LOC | |
| participantRole |
1..1 | ParticipantRole | ||
| participant:addl-functions |
0..* | Participant2 | This participant is used to express additional care team functions performed by this member of the team. Include additional participant to record additional roles (functionCode) this Care Team member plays. | |
| @typeCode |
1..1 | cs | Binding: CDAParticipationType (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 | ||
| @nullFlavor |
1..1 | cs | Binding: CDANullFlavor (required) Required Pattern: NA | |
| Slices for entryRelationship |
0..* | EntryRelationship | Slice: Unordered, Open by profile:observation, profile:act, exists:encounter, exists:observation, exists:act | |
| entryRelationship:encounter |
0..* | EntryRelationship | entryRelationship | |
| @typeCode |
1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: REFR | |
| encounter |
C | 1..1 | Encounter | 4515-90: If the first 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). |
| @classCode |
1..1 | cs | Binding: CDAActClass (required) Fixed Value: ENC | |
| @moodCode |
1..1 | cs | Binding: XDocumentEncounterMood (2.0.0) (required) | |
| id |
1..1 | II | ||
| entryRelationship:note |
0..* | EntryRelationship | This is the note activity to narratively describe information about the member on the care team. | |
| @typeCode |
1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: REFR | |
| act |
C | 1..1 | NoteActivity | Base for all types and resources should-text-ref-value: SHOULD contain text/reference/@value |
| entryRelationship:schedule |
0..1 | EntryRelationship | This is the schedule of when or how frequently the care team member participates (or provides care to the patient) on the care team. | |
| @typeCode |
1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: REFR | |
| observation |
C | 1..1 | CareTeamMemberScheduleObservation | Base for all types and resources should-text-ref-value: SHOULD contain text/reference/@value |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Act.classCode | required | Fixed Value: PCPRhttp://terminology.hl7.org/ValueSet/v3-xActClassDocumentEntryAct|2.0.0 | |
| Act.moodCode | required | Fixed Value: EVNhttp://terminology.hl7.org/ValueSet/v3-xDocumentActMood|2.0.0 | |
| Act.code | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | |
| Act.statusCode | required | ActStatushttp://terminology.hl7.org/ValueSet/v3-ActStatus | |
| Act.statusCode.code | required | ActStatus http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.15933 | |
| Act.performer.sdtcFunctionCode | preferred | CareTeamMemberFunction http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1099.30 | |
| Act.participant:location.typeCode | required | Fixed Value: LOChttp://hl7.org/cda/stds/core/ValueSet/CDAParticipationType | |
| Act.participant:addl-functions.typeCode | required | Fixed Value: INDhttp://hl7.org/cda/stds/core/ValueSet/CDAParticipationType | |
| Act.participant:addl-functions.sdtcFunctionCode | required | CareTeamMemberFunction http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1099.30 | |
| Act.participant:addl-functions.participantRole.nullFlavor | required | Pattern: NAhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Act.entryRelationship:encounter.typeCode | required | Fixed Value: REFRhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship | |
| Act.entryRelationship:encounter.encounter.classCode | required | Fixed Value: ENChttp://hl7.org/cda/stds/core/ValueSet/CDAActClass | |
| Act.entryRelationship:encounter.encounter.moodCode | required | XDocumentEncounterMoodhttp://terminology.hl7.org/ValueSet/v3-xDocumentEncounterMood|2.0.0 | |
| Act.entryRelationship:note.typeCode | required | Fixed Value: REFRhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship | |
| Act.entryRelationship:schedule.typeCode | required | Fixed Value: REFRhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship |
| Id | Grade | Path(s) | Details | Requirements |
| 4515-90 | error | Act.entryRelationship:encounter.encounter | If the first 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). : id.first().nullFlavor = 'NA' or (%resource.descendants().ofType(CDA.Encounter).where(hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/EncounterActivity') and id.exists($this.root = %context.id.first().root and $this.extension ~ %context.id.first().extension))) | |
| 4515-180 | error | Act.performer.assignedEntity | 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). : assignedPerson.exists() or (%resource.descendants().ofType(CDA.Performer2).where(assignedEntity.assignedPerson.exists() and assignedEntity.id.exists($this.root = %context.id.first().root and $this.extension ~ %context.id.first().extension))) | |
| 81-7296 | error | Act.performer.assignedEntity.addr, Act.performer.assignedEntity.representedOrganization.addr | **SHALL NOT** have mixed content except for white space (CONF:81-7296) : item.xmlText.empty() | |
| 81-9371 | error | Act.performer.assignedEntity.assignedPerson.name | The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). : conformsTo('http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPatientNamePTNUSFIELDED') or item.xmlText.exists() | |
| 81-9372 | error | Act.performer.assignedEntity.assignedPerson.name | The string **SHALL NOT** contain name parts (CONF:81-9372). : item.xmlText.exists() implies (item.delimiter | item.family | item.given | item.prefix | item.suffix).empty() | |
| 81-10024 | error | Act.performer.assignedEntity.addr, Act.performer.assignedEntity.representedOrganization.addr | If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024). : nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state')) | |
| 81-10025 | error | Act.performer.assignedEntity.addr, Act.performer.assignedEntity.representedOrganization.addr | If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025). : nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?')) | |
| pn-no-ls | error | Act.performer.assignedEntity.assignedPerson.name | No PN name part may have a qualifier of LS. : (item.delimiter | item.family | item.given | item.prefix | item.suffix).where(qualifier.where($this = 'LS').exists()).empty() | |
| shall-city | error | Act.performer.assignedEntity.addr, Act.performer.assignedEntity.representedOrganization.addr | SHALL contain exactly one [1..1] city (CONF:81-7292). : nullFlavor.exists() or item.city.count() = 1 | |
| shall-max-ad-parts | error | Act.performer.assignedEntity.addr, Act.performer.assignedEntity.representedOrganization.addr | SHALL have at most one of each: state, city, postalCode, and country : (item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1) | |
| shall-streetAddressLine | error | Act.performer.assignedEntity.addr, Act.performer.assignedEntity.representedOrganization.addr | SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). : nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4) | |
| should-addr | warning | Act.performer.assignedEntity | SHOULD contain addr : addr.exists() | |
| should-assignedPerson | warning | Act.performer.assignedEntity | SHOULD contain assignedPerson : assignedPerson.exists() | |
| should-country | warning | Act.performer.assignedEntity.addr, Act.performer.assignedEntity.representedOrganization.addr | SHOULD contain country : nullFlavor.exists() or item.country.exists() | |
| should-npi | warning | Act.performer.assignedEntity.id.root | SHOULD be NPI : $this = '2.16.840.1.113883.4.6' | |
| should-telecom | warning | Act.performer.assignedEntity | SHOULD contain telecom : telecom.exists() | |
| should-text-ref-value | warning | Act | SHOULD contain text/reference/@value : text.reference.value.exists() | |
| should-text-ref-value | warning | Act.entryRelationship:note.act, Act.entryRelationship:schedule.observation | SHOULD contain text/reference/@value : text.reference.value.exists() | |
| should-use | warning | Act.performer.assignedEntity.addr, Act.performer.assignedEntity.representedOrganization.addr | 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 |
|---|---|---|---|---|
| Act |
C | 1..1 | Act | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, @negationInd, id, code, text, statusCode, effectiveTime, priorityCode, languageCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, sdtcInFulfillmentOf1 Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) should-text-ref-value: SHOULD contain text/reference/@value |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
0..1 | II | ||
| @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 |
1..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:care-team-member-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.22.4.500.1 | |
| @extension |
1..1 | st | Required Pattern: 2024-05-01 | |
| @classCode |
1..1 | cs | Binding: XActClassDocumentEntryAct (2.0.0) (required) Fixed Value: PCPR | |
| @moodCode |
1..1 | cs | Binding: XDocumentActMood (2.0.0) (required) Fixed Value: EVN | |
| @negationInd |
0..1 | bl | ||
| id |
0..* | II | ||
| code |
1..1 | CD | Care team information panel Binding: v3 Code System ActCode (example) | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @code |
1..1 | cs | Required Pattern: 92707-9 | |
| @codeSystem |
1..1 | oid, uuid, ruid | LOINC 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 | ||
| text |
0..1 | ED | SHOULD reference the portion of section narrative text corresponding to this entry | |
| @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 | value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative |
| thumbnail |
0..1 | ED | ||
| statusCode |
1..1 | CS | Binding: ActStatus (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: CDANullFlavor (required) | |
| @value |
0..1 | ts | Date Format: YYYYMMDDHHMMSS.UUUU[+|-ZZzz] | |
| @operator |
0..1 | cs | Binding: CDASetOperator (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 (example) | |
| languageCode |
0..1 | CS | Binding: AllLanguages (required) | |
| subject |
0..1 | Subject | ||
| specimen |
0..* | Specimen | ||
| performer |
1..1 | Performer2 | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
0..1 | II | ||
| @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 |
0..1 | cs | Binding: ParticipationPhysicalPerformer (required) Fixed Value: PRF | |
| sdtcFunctionCode |
0..1 | CE | XML Namespace: urn:hl7-org:sdtc (USCDI) Care Team Member Role - 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 |
C | 1..1 | AssignedEntity | 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). should-addr: SHOULD contain addr should-telecom: SHOULD contain telecom should-assignedPerson: SHOULD contain assignedPerson |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
0..1 | II | ||
| @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 | (USCDI) Care Team Member Identifier | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
C | 0..1 | oid, uuid, ruid | should-npi: SHOULD be NPI |
| @extension |
0..1 | st | ||
| sdtcIdentifiedBy |
0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |
| code |
0..1 | CE | Binding: CDARoleCode (example) | |
| addr |
C | 0..* | USRealmAddress | (USCDI) Care Team Member Location shall-city: SHALL contain exactly one [1..1] city (CONF:81-7292). shall-streetAddressLine: SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). should-use: SHOULD contain @use should-country: SHOULD contain country 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296) 81-10024: If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024). 81-10025: If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025). shall-max-ad-parts: SHALL have at most one of each: state, city, postalCode, and country |
| telecom |
0..* | TEL | (USCDI) Care Team Member Telecom | |
| assignedPerson |
0..1 | Person | (USCDI) Care Team Member Name | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
0..1 | II | ||
| @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: EntityClassLivingSubject (required) Fixed Value: PSN | |
| @determinerCode |
0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
| name |
C | 1..1 | USRealmPersonNamePNUSFIELDED | Base for all types and resources pn-no-ls: No PN name part may have a qualifier of LS. 81-9371: The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). 81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372). |
| sdtcDesc |
0..1 | ED | XML Namespace: urn:hl7-org:sdtc XML: desc (urn:hl7-org:sdtc) | |
| sdtcAsPatientRelationship |
0..* | InfrastructureRoot | XML Namespace: urn:hl7-org:sdtc XML: asPatientRelationship (urn:hl7-org:sdtc) | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
0..1 | II | ||
| @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 | Fixed Value: PRS | |
| @determinerCode |
0..1 | cs | Fixed Value: INSTANCE | |
| code |
1..1 | CE | XML Namespace: urn:hl7-org:sdtc XML Namespace: urn:hl7-org:sdtc | |
| representedOrganization |
0..1 | Organization | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
0..1 | II | ||
| @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: EntityClassOrganization (required) Fixed Value: ORG | |
| @determinerCode |
0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
| id |
0..* | II | ||
| name |
0..* | ON | ||
| telecom |
1..* | TEL | ||
| addr |
C | 1..* | USRealmAddress | Base for all types and resources shall-city: SHALL contain exactly one [1..1] city (CONF:81-7292). shall-streetAddressLine: SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). should-use: SHOULD contain @use should-country: SHOULD contain country 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296) 81-10024: If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024). 81-10025: If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025). shall-max-ad-parts: SHALL have at most one of each: state, city, postalCode, and country |
| 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 | |
| author |
0..* | Author | ||
| informant |
0..* | Informant | ||
| Slices for participant |
0..* | Participant2 | Slice: Unordered, Open by value:typeCode | |
| participant:location |
0..* | Participant2 | This participant represents the location where the care team member provides the service. | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
0..1 | II | ||
| @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: LOC | |
| @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 |
1..1 | ParticipantRole | ||
| participant:addl-functions |
0..* | Participant2 | This participant is used to express additional care team functions performed by this member of the team. Include additional participant to record additional roles (functionCode) this Care Team member plays. | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
0..1 | II | ||
| @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: IND | |
| @contextControlCode |
0..1 | cs | Binding: CDAContextControl (required) Fixed Value: OP | |
| 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 | ||
| @nullFlavor |
1..1 | cs | Binding: CDANullFlavor (required) Required Pattern: NA | |
| realmCode |
0..* | CS | ||
| typeId |
0..1 | II | ||
| @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 |
0..* | II | ||
| sdtcIdentifiedBy |
0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |
| code |
0..1 | CE | Binding: CDARoleCode (example) | |
| addr |
0..* | AD | ||
| telecom |
0..* | TEL | ||
| playingDevice |
0..1 | Device | ||
| playingEntity |
0..1 | PlayingEntity | ||
| scopingEntity |
0..1 | Entity | ||
| Slices for entryRelationship |
0..* | EntryRelationship | Slice: Unordered, Open by profile:observation, profile:act, exists:encounter, exists:observation, exists:act | |
| entryRelationship:encounter |
0..* | EntryRelationship | entryRelationship | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
0..1 | II | ||
| @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 | ||
| encounter |
C | 1..1 | Encounter | 4515-90: If the first 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). |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
0..1 | II | ||
| @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: CDAActClass (required) Fixed Value: ENC | |
| @moodCode |
1..1 | cs | Binding: XDocumentEncounterMood (2.0.0) (required) | |
| id |
1..1 | II | ||
| code |
0..1 | CD | Binding: ActEncounterCode (example) | |
| 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 (example) | |
| 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) | |
| 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:note |
0..* | EntryRelationship | This is the note activity to narratively describe information about the member on the care team. | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
0..1 | II | ||
| @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 |
C | 1..1 | NoteActivity | Base for all types and resources should-text-ref-value: SHOULD contain text/reference/@value |
| 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:schedule |
0..1 | EntryRelationship | This is the schedule of when or how frequently the care team member participates (or provides care to the patient) on the care team. | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
0..1 | II | ||
| @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 | ||
| observation |
C | 1..1 | CareTeamMemberScheduleObservation | Base for all types and resources should-text-ref-value: SHOULD contain text/reference/@value |
| 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 | Conformance | ValueSet / Code | URI |
| Act.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Act.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Act.templateId:care-team-member-act.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Act.classCode | required | Fixed Value: PCPRhttp://terminology.hl7.org/ValueSet/v3-xActClassDocumentEntryAct|2.0.0 | |
| Act.moodCode | required | Fixed Value: EVNhttp://terminology.hl7.org/ValueSet/v3-xDocumentActMood|2.0.0 | |
| Act.code | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | |
| Act.code.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Act.text.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Act.text.compression | required | CDACompressionAlgorithmhttp://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm | |
| Act.text.integrityCheckAlgorithm | required | IntegrityCheckAlgorithmhttp://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0 | |
| Act.text.mediaType | example | MediaTypehttp://terminology.hl7.org/ValueSet/v3-MediaType | |
| Act.text.representation | required | BinaryDataEncodinghttp://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding | |
| Act.statusCode | required | ActStatushttp://terminology.hl7.org/ValueSet/v3-ActStatus | |
| Act.statusCode.code | required | ActStatus http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.15933 | |
| Act.effectiveTime.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Act.effectiveTime.operator | required | CDASetOperatorhttp://hl7.org/cda/stds/core/ValueSet/CDASetOperator | |
| Act.priorityCode | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority | |
| Act.languageCode | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languagesfrom the FHIR Standard | |
| Act.performer.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Act.performer.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Act.performer.typeCode | required | Fixed Value: PRFhttp://terminology.hl7.org/ValueSet/v3-ParticipationPhysicalPerformer | |
| Act.performer.sdtcFunctionCode | preferred | CareTeamMemberFunction http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1099.30 | |
| Act.performer.assignedEntity.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Act.performer.assignedEntity.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Act.performer.assignedEntity.classCode | required | Fixed Value: ASSIGNEDhttp://terminology.hl7.org/ValueSet/v3-RoleClassAssignedEntity | |
| Act.performer.assignedEntity.id.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Act.performer.assignedEntity.code | example | CDARoleCodehttp://hl7.org/cda/stds/core/ValueSet/CDARoleCode | |
| Act.performer.assignedEntity.assignedPerson.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Act.performer.assignedEntity.assignedPerson.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Act.performer.assignedEntity.assignedPerson.classCode | required | Fixed Value: PSNhttp://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject | |
| Act.performer.assignedEntity.assignedPerson.determinerCode | required | Fixed Value: INSTANCEhttp://terminology.hl7.org/ValueSet/v3-EntityDeterminer | |
| Act.performer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Act.performer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Act.performer.assignedEntity.representedOrganization.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Act.performer.assignedEntity.representedOrganization.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Act.performer.assignedEntity.representedOrganization.classCode | required | Fixed Value: ORGhttp://terminology.hl7.org/ValueSet/v3-EntityClassOrganization | |
| Act.performer.assignedEntity.representedOrganization.determinerCode | required | Fixed Value: INSTANCEhttp://terminology.hl7.org/ValueSet/v3-EntityDeterminer | |
| Act.performer.assignedEntity.representedOrganization.standardIndustryClassCode | example | OrganizationIndustryClassNAICShttp://terminology.hl7.org/ValueSet/v3-OrganizationIndustryClassNAICS | |
| Act.participant:location.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Act.participant:location.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Act.participant:location.typeCode | required | Fixed Value: LOChttp://hl7.org/cda/stds/core/ValueSet/CDAParticipationType | |
| Act.participant:location.contextControlCode | required | Fixed Value: OPhttp://hl7.org/cda/stds/core/ValueSet/CDAContextControl | |
| Act.participant:addl-functions.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Act.participant:addl-functions.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Act.participant:addl-functions.typeCode | required | Fixed Value: INDhttp://hl7.org/cda/stds/core/ValueSet/CDAParticipationType | |
| Act.participant:addl-functions.contextControlCode | required | Fixed Value: OPhttp://hl7.org/cda/stds/core/ValueSet/CDAContextControl | |
| Act.participant:addl-functions.sdtcFunctionCode | required | CareTeamMemberFunction http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1099.30 | |
| Act.participant:addl-functions.participantRole.nullFlavor | required | Pattern: NAhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Act.participant:addl-functions.participantRole.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Act.participant:addl-functions.participantRole.classCode | required | CDARoleClassRoothttp://hl7.org/cda/stds/core/ValueSet/CDARoleClassRoot | |
| Act.participant:addl-functions.participantRole.code | example | CDARoleCodehttp://hl7.org/cda/stds/core/ValueSet/CDARoleCode | |
| Act.entryRelationship:encounter.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Act.entryRelationship:encounter.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Act.entryRelationship:encounter.typeCode | required | Fixed Value: REFRhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship | |
| Act.entryRelationship:encounter.encounter.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Act.entryRelationship:encounter.encounter.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Act.entryRelationship:encounter.encounter.classCode | required | Fixed Value: ENChttp://hl7.org/cda/stds/core/ValueSet/CDAActClass | |
| Act.entryRelationship:encounter.encounter.moodCode | required | XDocumentEncounterMoodhttp://terminology.hl7.org/ValueSet/v3-xDocumentEncounterMood|2.0.0 | |
| Act.entryRelationship:encounter.encounter.code | example | ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode | |
| Act.entryRelationship:encounter.encounter.statusCode | required | ActStatushttp://terminology.hl7.org/ValueSet/v3-ActStatus | |
| Act.entryRelationship:encounter.encounter.priorityCode | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority | |
| Act.entryRelationship:note.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Act.entryRelationship:note.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Act.entryRelationship:note.typeCode | required | Fixed Value: REFRhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship | |
| Act.entryRelationship:schedule.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Act.entryRelationship:schedule.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Act.entryRelationship:schedule.typeCode | required | Fixed Value: REFRhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship |
| Id | Grade | Path(s) | Details | Requirements |
| 4515-90 | error | Act.entryRelationship:encounter.encounter | If the first 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). : id.first().nullFlavor = 'NA' or (%resource.descendants().ofType(CDA.Encounter).where(hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/EncounterActivity') and id.exists($this.root = %context.id.first().root and $this.extension ~ %context.id.first().extension))) | |
| 4515-180 | error | Act.performer.assignedEntity | 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). : assignedPerson.exists() or (%resource.descendants().ofType(CDA.Performer2).where(assignedEntity.assignedPerson.exists() and assignedEntity.id.exists($this.root = %context.id.first().root and $this.extension ~ %context.id.first().extension))) | |
| 81-7296 | error | Act.performer.assignedEntity.addr, Act.performer.assignedEntity.representedOrganization.addr | **SHALL NOT** have mixed content except for white space (CONF:81-7296) : item.xmlText.empty() | |
| 81-9371 | error | Act.performer.assignedEntity.assignedPerson.name | The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). : conformsTo('http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPatientNamePTNUSFIELDED') or item.xmlText.exists() | |
| 81-9372 | error | Act.performer.assignedEntity.assignedPerson.name | The string **SHALL NOT** contain name parts (CONF:81-9372). : item.xmlText.exists() implies (item.delimiter | item.family | item.given | item.prefix | item.suffix).empty() | |
| 81-10024 | error | Act.performer.assignedEntity.addr, Act.performer.assignedEntity.representedOrganization.addr | If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024). : nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state')) | |
| 81-10025 | error | Act.performer.assignedEntity.addr, Act.performer.assignedEntity.representedOrganization.addr | If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025). : nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?')) | |
| pn-no-ls | error | Act.performer.assignedEntity.assignedPerson.name | No PN name part may have a qualifier of LS. : (item.delimiter | item.family | item.given | item.prefix | item.suffix).where(qualifier.where($this = 'LS').exists()).empty() | |
| shall-city | error | Act.performer.assignedEntity.addr, Act.performer.assignedEntity.representedOrganization.addr | SHALL contain exactly one [1..1] city (CONF:81-7292). : nullFlavor.exists() or item.city.count() = 1 | |
| shall-max-ad-parts | error | Act.performer.assignedEntity.addr, Act.performer.assignedEntity.representedOrganization.addr | SHALL have at most one of each: state, city, postalCode, and country : (item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1) | |
| shall-streetAddressLine | error | Act.performer.assignedEntity.addr, Act.performer.assignedEntity.representedOrganization.addr | SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). : nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4) | |
| should-addr | warning | Act.performer.assignedEntity | SHOULD contain addr : addr.exists() | |
| should-assignedPerson | warning | Act.performer.assignedEntity | SHOULD contain assignedPerson : assignedPerson.exists() | |
| should-country | warning | Act.performer.assignedEntity.addr, Act.performer.assignedEntity.representedOrganization.addr | SHOULD contain country : nullFlavor.exists() or item.country.exists() | |
| should-npi | warning | Act.performer.assignedEntity.id.root | SHOULD be NPI : $this = '2.16.840.1.113883.4.6' | |
| should-telecom | warning | Act.performer.assignedEntity | SHOULD contain telecom : telecom.exists() | |
| should-text-ref-value | warning | Act | SHOULD contain text/reference/@value : text.reference.value.exists() | |
| should-text-ref-value | warning | Act.entryRelationship:note.act, Act.entryRelationship:schedule.observation | SHOULD contain text/reference/@value : text.reference.value.exists() | |
| should-use | warning | Act.performer.assignedEntity.addr, Act.performer.assignedEntity.representedOrganization.addr | 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: 11 elements(9 nested mandatory elements)
Fixed: 7 elements
Prohibited: 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#3.0.0 based on FHIR 5.0.0. Generated 2024-05-18
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change