Consolidated CDA (C-CDA)
3.0.0 - STU3 United States of America flag

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. For a full list of available versions, see the Directory of published versions

Logical Model: Related Person Relationship and Name Participant

Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/RelatedPersonRelationshipAndNameParticipant Version: 3.0.0
Draft as of 2024-05-18 Computable Name: RelatedPersonRelationshipAndNameParticipant
Other Identifiers: urn:ietf:rfc:3986#Uniform Resource Identifier (URI)#urn:hl7ii:2.16.840.1.113883.10.20.22.5.8:2023-05-01

This template represents a generic participant person that has a relationship to the patient. (e.g., parent, next-of-kin, neighbor). The related person’s name is required and it is recommended that the person’s contact information is present. The more specific CDA participant of Guardian (recordTarget/patientRole/patient/guardian) can be used to represent a legally responsible guardian of the patient within the header. This template may be used to represent a person with any relationship to the patient within the header, or at the entry level when pertinent to a particular clinical statement.

Usage:

  • This Logical Model is not used by any profiles in this Implementation Guide

Formal Views of Template Content

Description of Template, Differentials, Snapshots and how the different presentations work.

This structure is derived from Participant1

NameFlagsCard.TypeDescription & Constraintsdoco
.. Participant1 1..1 Participant1 XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @typeCode, @contextControlCode, functionCode, time, associatedEntity
Base for all types and resources
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... Slices for templateId 1..* II Slice: Unordered, Open by value:root, value:extension
.... templateId:related-person 1..1 II
..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.5.8
..... @extension 1..1 st Required Pattern: 2023-05-01
... @typeCode 1..1 cs Fixed Value: IND
... associatedEntity C 1..1 AssociatedEntity should-addr: SHOULD contain addr
should-telecom: SHOULD contain telecom
.... @classCode 1..1 cs
.... code 1..1 CE (USCDI) Related Person's Relationship - This associatedEntity/code represents the person's relationship to the patient.
Binding: Personal And Legal Relationship Role Type . (required)
.... addr 0..* USRealmAddress Base for all types and resources
.... telecom 0..* TEL
.... associatedPerson 1..1 Person The associatedPerson represents the name and contact information of the related person
..... name 1..* USRealmPersonNamePNUSFIELDED (USCDI) Related Person's Name

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Participant1.associatedEntity.coderequiredPersonalAndLegalRelationshipRoleType .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.12.1

Constraints

IdGradePath(s)DetailsRequirements
should-addrwarningParticipant1.associatedEntitySHOULD contain addr
: addr.exists()
should-telecomwarningParticipant1.associatedEntitySHOULD contain telecom
: telecom.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Participant1 1..1 Participant1 XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @typeCode, @contextControlCode, functionCode, time, associatedEntity
Base for all types and resources
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... Slices for templateId 1..* II Slice: Unordered, Open by value:root, value:extension
.... templateId:related-person 1..1 II
..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.5.8
..... @extension 1..1 st Required Pattern: 2023-05-01
... @typeCode 1..1 cs Binding: CDAParticipationType (required)
Fixed Value: IND
... associatedEntity C 1..1 AssociatedEntity should-addr: SHOULD contain addr
should-telecom: SHOULD contain telecom
.... @classCode 1..1 cs Binding: CDARoleClassAssociative (required)
.... code 1..1 CE (USCDI) Related Person's Relationship - This associatedEntity/code represents the person's relationship to the patient.
Binding: Personal And Legal Relationship Role Type . (required)
.... addr C 0..* 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
.... telecom 0..* TEL
.... associatedPerson 1..1 Person The associatedPerson represents the name and contact information of the related person
..... name C 1..* USRealmPersonNamePNUSFIELDED (USCDI) Related Person's Name
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).

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Participant1.typeCoderequiredFixed Value: IND
http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType
Participant1.associatedEntity.classCoderequiredCDARoleClassAssociative
http://hl7.org/cda/stds/core/ValueSet/CDARoleClassAssociative
Participant1.associatedEntity.coderequiredPersonalAndLegalRelationshipRoleType .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.12.1

Constraints

IdGradePath(s)DetailsRequirements
81-7296errorParticipant1.associatedEntity.addr**SHALL NOT** have mixed content except for white space (CONF:81-7296)
: item.xmlText.empty()
81-9371errorParticipant1.associatedEntity.associatedPerson.nameThe 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-9372errorParticipant1.associatedEntity.associatedPerson.nameThe 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-10024errorParticipant1.associatedEntity.addrIf 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-10025errorParticipant1.associatedEntity.addrIf 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-lserrorParticipant1.associatedEntity.associatedPerson.nameNo 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-cityerrorParticipant1.associatedEntity.addrSHALL contain exactly one [1..1] city (CONF:81-7292).
: nullFlavor.exists() or item.city.count() = 1
shall-max-ad-partserrorParticipant1.associatedEntity.addrSHALL 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-streetAddressLineerrorParticipant1.associatedEntity.addrSHALL 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-addrwarningParticipant1.associatedEntitySHOULD contain addr
: addr.exists()
should-countrywarningParticipant1.associatedEntity.addrSHOULD contain country
: nullFlavor.exists() or item.country.exists()
should-telecomwarningParticipant1.associatedEntitySHOULD contain telecom
: telecom.exists()
should-usewarningParticipant1.associatedEntity.addrSHOULD contain @use
: nullFlavor.exists() or use.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Participant1 1..1 Participant1 XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @typeCode, @contextControlCode, functionCode, time, associatedEntity
Base for all types and resources
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @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:related-person 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.5.8
..... @extension 1..1 st Required Pattern: 2023-05-01
... @typeCode 1..1 cs Binding: CDAParticipationType (required)
Fixed Value: IND
... @contextControlCode 0..1 cs Binding: CDAContextControl (required)
Fixed Value: OP
... functionCode 0..1 CE
... time 0..1 IVL_TS
... associatedEntity C 1..1 AssociatedEntity should-addr: SHOULD contain addr
should-telecom: SHOULD contain telecom
.... @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: CDARoleClassAssociative (required)
.... id 0..* II
.... sdtcIdentifiedBy 0..* IdentifiedBy XML Namespace: urn:hl7-org:sdtc
XML: identifiedBy (urn:hl7-org:sdtc)
.... code 1..1 CE (USCDI) Related Person's Relationship - This associatedEntity/code represents the person's relationship to the patient.
Binding: Personal And Legal Relationship Role Type . (required)
.... addr C 0..* 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
.... telecom 0..* TEL
.... associatedPerson 1..1 Person The associatedPerson represents the name and contact information of the related person
..... @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..* USRealmPersonNamePNUSFIELDED (USCDI) Related Person's Name
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
.... scopingOrganization 0..1 Organization

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Participant1.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Participant1.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Participant1.templateId:related-person.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Participant1.typeCoderequiredFixed Value: IND
http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType
Participant1.contextControlCoderequiredFixed Value: OP
http://hl7.org/cda/stds/core/ValueSet/CDAContextControl
Participant1.associatedEntity.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Participant1.associatedEntity.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Participant1.associatedEntity.classCoderequiredCDARoleClassAssociative
http://hl7.org/cda/stds/core/ValueSet/CDARoleClassAssociative
Participant1.associatedEntity.coderequiredPersonalAndLegalRelationshipRoleType .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.12.1
Participant1.associatedEntity.associatedPerson.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Participant1.associatedEntity.associatedPerson.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Participant1.associatedEntity.associatedPerson.classCoderequiredFixed Value: PSN
http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject
Participant1.associatedEntity.associatedPerson.determinerCoderequiredFixed Value: INSTANCE
http://terminology.hl7.org/ValueSet/v3-EntityDeterminer
Participant1.associatedEntity.associatedPerson.sdtcAsPatientRelationship.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Participant1.associatedEntity.associatedPerson.sdtcAsPatientRelationship.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor

Constraints

IdGradePath(s)DetailsRequirements
81-7296errorParticipant1.associatedEntity.addr**SHALL NOT** have mixed content except for white space (CONF:81-7296)
: item.xmlText.empty()
81-9371errorParticipant1.associatedEntity.associatedPerson.nameThe 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-9372errorParticipant1.associatedEntity.associatedPerson.nameThe 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-10024errorParticipant1.associatedEntity.addrIf 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-10025errorParticipant1.associatedEntity.addrIf 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-lserrorParticipant1.associatedEntity.associatedPerson.nameNo 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-cityerrorParticipant1.associatedEntity.addrSHALL contain exactly one [1..1] city (CONF:81-7292).
: nullFlavor.exists() or item.city.count() = 1
shall-max-ad-partserrorParticipant1.associatedEntity.addrSHALL 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-streetAddressLineerrorParticipant1.associatedEntity.addrSHALL 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-addrwarningParticipant1.associatedEntitySHOULD contain addr
: addr.exists()
should-countrywarningParticipant1.associatedEntity.addrSHOULD contain country
: nullFlavor.exists() or item.country.exists()
should-telecomwarningParticipant1.associatedEntitySHOULD contain telecom
: telecom.exists()
should-usewarningParticipant1.associatedEntity.addrSHOULD contain @use
: nullFlavor.exists() or use.exists()

This structure is derived from Participant1

Summary

Mandatory: 7 elements
Fixed: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 2 is sliced based on the values of Participant1.templateId

Differential View

This structure is derived from Participant1

NameFlagsCard.TypeDescription & Constraintsdoco
.. Participant1 1..1 Participant1 XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @typeCode, @contextControlCode, functionCode, time, associatedEntity
Base for all types and resources
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... Slices for templateId 1..* II Slice: Unordered, Open by value:root, value:extension
.... templateId:related-person 1..1 II
..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.5.8
..... @extension 1..1 st Required Pattern: 2023-05-01
... @typeCode 1..1 cs Fixed Value: IND
... associatedEntity C 1..1 AssociatedEntity should-addr: SHOULD contain addr
should-telecom: SHOULD contain telecom
.... @classCode 1..1 cs
.... code 1..1 CE (USCDI) Related Person's Relationship - This associatedEntity/code represents the person's relationship to the patient.
Binding: Personal And Legal Relationship Role Type . (required)
.... addr 0..* USRealmAddress Base for all types and resources
.... telecom 0..* TEL
.... associatedPerson 1..1 Person The associatedPerson represents the name and contact information of the related person
..... name 1..* USRealmPersonNamePNUSFIELDED (USCDI) Related Person's Name

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Participant1.associatedEntity.coderequiredPersonalAndLegalRelationshipRoleType .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.12.1

Constraints

IdGradePath(s)DetailsRequirements
should-addrwarningParticipant1.associatedEntitySHOULD contain addr
: addr.exists()
should-telecomwarningParticipant1.associatedEntitySHOULD contain telecom
: telecom.exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Participant1 1..1 Participant1 XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @typeCode, @contextControlCode, functionCode, time, associatedEntity
Base for all types and resources
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... Slices for templateId 1..* II Slice: Unordered, Open by value:root, value:extension
.... templateId:related-person 1..1 II
..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.5.8
..... @extension 1..1 st Required Pattern: 2023-05-01
... @typeCode 1..1 cs Binding: CDAParticipationType (required)
Fixed Value: IND
... associatedEntity C 1..1 AssociatedEntity should-addr: SHOULD contain addr
should-telecom: SHOULD contain telecom
.... @classCode 1..1 cs Binding: CDARoleClassAssociative (required)
.... code 1..1 CE (USCDI) Related Person's Relationship - This associatedEntity/code represents the person's relationship to the patient.
Binding: Personal And Legal Relationship Role Type . (required)
.... addr C 0..* 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
.... telecom 0..* TEL
.... associatedPerson 1..1 Person The associatedPerson represents the name and contact information of the related person
..... name C 1..* USRealmPersonNamePNUSFIELDED (USCDI) Related Person's Name
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).

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Participant1.typeCoderequiredFixed Value: IND
http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType
Participant1.associatedEntity.classCoderequiredCDARoleClassAssociative
http://hl7.org/cda/stds/core/ValueSet/CDARoleClassAssociative
Participant1.associatedEntity.coderequiredPersonalAndLegalRelationshipRoleType .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.12.1

Constraints

IdGradePath(s)DetailsRequirements
81-7296errorParticipant1.associatedEntity.addr**SHALL NOT** have mixed content except for white space (CONF:81-7296)
: item.xmlText.empty()
81-9371errorParticipant1.associatedEntity.associatedPerson.nameThe 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-9372errorParticipant1.associatedEntity.associatedPerson.nameThe 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-10024errorParticipant1.associatedEntity.addrIf 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-10025errorParticipant1.associatedEntity.addrIf 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-lserrorParticipant1.associatedEntity.associatedPerson.nameNo 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-cityerrorParticipant1.associatedEntity.addrSHALL contain exactly one [1..1] city (CONF:81-7292).
: nullFlavor.exists() or item.city.count() = 1
shall-max-ad-partserrorParticipant1.associatedEntity.addrSHALL 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-streetAddressLineerrorParticipant1.associatedEntity.addrSHALL 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-addrwarningParticipant1.associatedEntitySHOULD contain addr
: addr.exists()
should-countrywarningParticipant1.associatedEntity.addrSHOULD contain country
: nullFlavor.exists() or item.country.exists()
should-telecomwarningParticipant1.associatedEntitySHOULD contain telecom
: telecom.exists()
should-usewarningParticipant1.associatedEntity.addrSHOULD contain @use
: nullFlavor.exists() or use.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Participant1 1..1 Participant1 XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @typeCode, @contextControlCode, functionCode, time, associatedEntity
Base for all types and resources
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @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:related-person 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.5.8
..... @extension 1..1 st Required Pattern: 2023-05-01
... @typeCode 1..1 cs Binding: CDAParticipationType (required)
Fixed Value: IND
... @contextControlCode 0..1 cs Binding: CDAContextControl (required)
Fixed Value: OP
... functionCode 0..1 CE
... time 0..1 IVL_TS
... associatedEntity C 1..1 AssociatedEntity should-addr: SHOULD contain addr
should-telecom: SHOULD contain telecom
.... @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: CDARoleClassAssociative (required)
.... id 0..* II
.... sdtcIdentifiedBy 0..* IdentifiedBy XML Namespace: urn:hl7-org:sdtc
XML: identifiedBy (urn:hl7-org:sdtc)
.... code 1..1 CE (USCDI) Related Person's Relationship - This associatedEntity/code represents the person's relationship to the patient.
Binding: Personal And Legal Relationship Role Type . (required)
.... addr C 0..* 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
.... telecom 0..* TEL
.... associatedPerson 1..1 Person The associatedPerson represents the name and contact information of the related person
..... @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..* USRealmPersonNamePNUSFIELDED (USCDI) Related Person's Name
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
.... scopingOrganization 0..1 Organization

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Participant1.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Participant1.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Participant1.templateId:related-person.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Participant1.typeCoderequiredFixed Value: IND
http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType
Participant1.contextControlCoderequiredFixed Value: OP
http://hl7.org/cda/stds/core/ValueSet/CDAContextControl
Participant1.associatedEntity.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Participant1.associatedEntity.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Participant1.associatedEntity.classCoderequiredCDARoleClassAssociative
http://hl7.org/cda/stds/core/ValueSet/CDARoleClassAssociative
Participant1.associatedEntity.coderequiredPersonalAndLegalRelationshipRoleType .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.12.1
Participant1.associatedEntity.associatedPerson.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Participant1.associatedEntity.associatedPerson.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Participant1.associatedEntity.associatedPerson.classCoderequiredFixed Value: PSN
http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject
Participant1.associatedEntity.associatedPerson.determinerCoderequiredFixed Value: INSTANCE
http://terminology.hl7.org/ValueSet/v3-EntityDeterminer
Participant1.associatedEntity.associatedPerson.sdtcAsPatientRelationship.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Participant1.associatedEntity.associatedPerson.sdtcAsPatientRelationship.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor

Constraints

IdGradePath(s)DetailsRequirements
81-7296errorParticipant1.associatedEntity.addr**SHALL NOT** have mixed content except for white space (CONF:81-7296)
: item.xmlText.empty()
81-9371errorParticipant1.associatedEntity.associatedPerson.nameThe 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-9372errorParticipant1.associatedEntity.associatedPerson.nameThe 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-10024errorParticipant1.associatedEntity.addrIf 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-10025errorParticipant1.associatedEntity.addrIf 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-lserrorParticipant1.associatedEntity.associatedPerson.nameNo 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-cityerrorParticipant1.associatedEntity.addrSHALL contain exactly one [1..1] city (CONF:81-7292).
: nullFlavor.exists() or item.city.count() = 1
shall-max-ad-partserrorParticipant1.associatedEntity.addrSHALL 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-streetAddressLineerrorParticipant1.associatedEntity.addrSHALL 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-addrwarningParticipant1.associatedEntitySHOULD contain addr
: addr.exists()
should-countrywarningParticipant1.associatedEntity.addrSHOULD contain country
: nullFlavor.exists() or item.country.exists()
should-telecomwarningParticipant1.associatedEntitySHOULD contain telecom
: telecom.exists()
should-usewarningParticipant1.associatedEntity.addrSHOULD contain @use
: nullFlavor.exists() or use.exists()

This structure is derived from Participant1

Summary

Mandatory: 7 elements
Fixed: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 2 is sliced based on the values of Participant1.templateId

 

Other representations of profile: CSV, Excel