Consolidated CDA
3.0.0-ballot - ballot United States of America flag

This page is part of the CCDA: Consolidated CDA Release (v3.0.0-ballot: CCDA 3.0 Ballot 1) based on FHIR (HL7® FHIR® Standard) v5.0.0. . 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-ballot
Draft as of 2023-12-21 Computable Name: RelatedPersonRelationshipAndNameParticipant
Other Identifiers: id: 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 Profile Content

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

This structure is derived from Participant1

NameFlagsCard.TypeDescription & Constraintsdoco
.. Participant1 1..1Participant1XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @typeCode, @contextControlCode, functionCode, time, associatedEntity
Base for all types and resources
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:related-person 1..1II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.5.8
..... @extension 1..1stRequired Pattern: 2023-05-01
... @typeCode 1..1csFixed Value: IND
... associatedEntity C1..1AssociatedEntityshould-addr: SHOULD contain addr
should-telecom: SHOULD contain telecom
.... @classCode 1..1csFixed Value: PRS
.... code 1..1CE(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..*USRealmAddressBase for all types and resources
.... telecom 0..*TEL
.... associatedPerson 1..1PersonThe 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)

PathConformanceValueSet
Participant1.associatedEntity.coderequiredPersonalAndLegalRelationshipRoleType

Constraints

IdGradePath(s)DetailsRequirements
should-addrwarningParticipant1.associatedEntitySHOULD contain addr
: addr.exists()
should-telecomwarningParticipant1.associatedEntitySHOULD contain telecom
: telecom.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Participant1 1..1Participant1XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @typeCode, @contextControlCode, functionCode, time, associatedEntity
Base for all types and resources
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:related-person 1..1II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.5.8
..... @extension 1..1stRequired Pattern: 2023-05-01
... @typeCode 1..1csBinding: ParticipationType (required)
Fixed Value: IND
... associatedEntity C1..1AssociatedEntityshould-addr: SHOULD contain addr
should-telecom: SHOULD contain telecom
.... @classCode 1..1csBinding: RoleClassAssociative (required)
Fixed Value: PRS
.... code 1..1CE(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 C0..*USRealmAddressBase for all types and resources
.... telecom 0..*TEL
.... associatedPerson 1..1PersonThe associatedPerson represents the name and contact information of the related person
..... name C1..*USRealmPersonNamePNUSFIELDED(USCDI) Related Person's Name

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Participant1.typeCoderequiredFixed Value: IND
Participant1.associatedEntity.classCoderequiredFixed Value: PRS
Participant1.associatedEntity.coderequiredPersonalAndLegalRelationshipRoleType

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..1Participant1XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @typeCode, @contextControlCode, functionCode, time, associatedEntity
Base for all types and resources
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @nullFlavor 0..1csBinding: CDANullFlavor (required)
... realmCode 0..*CS
... typeId 0..1II
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... @assigningAuthorityName 0..1st
.... @displayable 0..1bl
.... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1st
.... templateId:related-person 1..1II
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.5.8
..... @extension 1..1stRequired Pattern: 2023-05-01
... @typeCode 1..1csBinding: ParticipationType (required)
Fixed Value: IND
... @contextControlCode 0..1csBinding: ContextControl (required)
Fixed Value: OP
... functionCode 0..1CE
... time 0..1IVL_TS
... associatedEntity C1..1AssociatedEntityshould-addr: SHOULD contain addr
should-telecom: SHOULD contain telecom
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... realmCode 0..*CS
.... typeId 0..1II
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
..... @extension 1..1st
.... templateId 0..*II
.... @classCode 1..1csBinding: RoleClassAssociative (required)
Fixed Value: PRS
.... id 0..*II
.... sdtcIdentifiedBy 0..*IdentifiedByXML Namespace: urn:hl7-org:sdtc
XML: identifiedBy (urn:hl7-org:sdtc)
.... code 1..1CE(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 C0..*USRealmAddressBase for all types and resources
.... telecom 0..*TEL
.... associatedPerson 1..1PersonThe associatedPerson represents the name and contact information of the related person
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
...... @nullFlavor 0..1csBinding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1st
...... @displayable 0..1bl
...... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1st
..... templateId 0..*II
..... @classCode 0..1csBinding: EntityClassLivingSubject (required)
Fixed Value: PSN
..... @determinerCode 0..1csBinding: EntityDeterminer (required)
Fixed Value: INSTANCE
..... name C1..*USRealmPersonNamePNUSFIELDED(USCDI) Related Person's Name
..... sdtcDesc 0..1EDXML Namespace: urn:hl7-org:sdtc
XML: desc (urn:hl7-org:sdtc)
..... sdtcAsPatientRelationship 0..*InfrastructureRootXML Namespace: urn:hl7-org:sdtc
XML: asPatientRelationship (urn:hl7-org:sdtc)
...... @nullFlavor 0..1csBinding: CDANullFlavor (required)
...... realmCode 0..*CS
...... typeId 0..1II
....... @nullFlavor 0..1csBinding: CDANullFlavor (required)
....... @assigningAuthorityName 0..1st
....... @displayable 0..1bl
....... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
....... @extension 1..1st
...... templateId 0..*II
...... @classCode 1..1csFixed Value: PRS
...... @determinerCode 0..1csFixed Value: INSTANCE
...... code 1..1CEXML Namespace: urn:hl7-org:sdtc
XML Namespace: urn:hl7-org:sdtc
.... scopingOrganization 0..1Organization

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Participant1.nullFlavorrequiredCDANullFlavor
Participant1.typeId.nullFlavorrequiredCDANullFlavor
Participant1.templateId:related-person.nullFlavorrequiredCDANullFlavor
Participant1.typeCoderequiredFixed Value: IND
Participant1.contextControlCoderequiredFixed Value: OP
Participant1.associatedEntity.nullFlavorrequiredCDANullFlavor
Participant1.associatedEntity.typeId.nullFlavorrequiredCDANullFlavor
Participant1.associatedEntity.classCoderequiredFixed Value: PRS
Participant1.associatedEntity.coderequiredPersonalAndLegalRelationshipRoleType
Participant1.associatedEntity.associatedPerson.nullFlavorrequiredCDANullFlavor
Participant1.associatedEntity.associatedPerson.typeId.nullFlavorrequiredCDANullFlavor
Participant1.associatedEntity.associatedPerson.classCoderequiredFixed Value: PSN
Participant1.associatedEntity.associatedPerson.determinerCoderequiredFixed Value: INSTANCE
Participant1.associatedEntity.associatedPerson.sdtcAsPatientRelationship.nullFlavorrequiredCDANullFlavor
Participant1.associatedEntity.associatedPerson.sdtcAsPatientRelationship.typeId.nullFlavorrequiredCDANullFlavor

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 Value: 2 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Participant1.templateId is sliced based on the values of value:root, value:extension

Differential View

This structure is derived from Participant1

NameFlagsCard.TypeDescription & Constraintsdoco
.. Participant1 1..1Participant1XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @typeCode, @contextControlCode, functionCode, time, associatedEntity
Base for all types and resources
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:related-person 1..1II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.5.8
..... @extension 1..1stRequired Pattern: 2023-05-01
... @typeCode 1..1csFixed Value: IND
... associatedEntity C1..1AssociatedEntityshould-addr: SHOULD contain addr
should-telecom: SHOULD contain telecom
.... @classCode 1..1csFixed Value: PRS
.... code 1..1CE(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..*USRealmAddressBase for all types and resources
.... telecom 0..*TEL
.... associatedPerson 1..1PersonThe 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)

PathConformanceValueSet
Participant1.associatedEntity.coderequiredPersonalAndLegalRelationshipRoleType

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..1Participant1XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @typeCode, @contextControlCode, functionCode, time, associatedEntity
Base for all types and resources
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:related-person 1..1II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.5.8
..... @extension 1..1stRequired Pattern: 2023-05-01
... @typeCode 1..1csBinding: ParticipationType (required)
Fixed Value: IND
... associatedEntity C1..1AssociatedEntityshould-addr: SHOULD contain addr
should-telecom: SHOULD contain telecom
.... @classCode 1..1csBinding: RoleClassAssociative (required)
Fixed Value: PRS
.... code 1..1CE(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 C0..*USRealmAddressBase for all types and resources
.... telecom 0..*TEL
.... associatedPerson 1..1PersonThe associatedPerson represents the name and contact information of the related person
..... name C1..*USRealmPersonNamePNUSFIELDED(USCDI) Related Person's Name

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Participant1.typeCoderequiredFixed Value: IND
Participant1.associatedEntity.classCoderequiredFixed Value: PRS
Participant1.associatedEntity.coderequiredPersonalAndLegalRelationshipRoleType

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..1Participant1XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @typeCode, @contextControlCode, functionCode, time, associatedEntity
Base for all types and resources
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @nullFlavor 0..1csBinding: CDANullFlavor (required)
... realmCode 0..*CS
... typeId 0..1II
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... @assigningAuthorityName 0..1st
.... @displayable 0..1bl
.... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1st
.... templateId:related-person 1..1II
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.5.8
..... @extension 1..1stRequired Pattern: 2023-05-01
... @typeCode 1..1csBinding: ParticipationType (required)
Fixed Value: IND
... @contextControlCode 0..1csBinding: ContextControl (required)
Fixed Value: OP
... functionCode 0..1CE
... time 0..1IVL_TS
... associatedEntity C1..1AssociatedEntityshould-addr: SHOULD contain addr
should-telecom: SHOULD contain telecom
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... realmCode 0..*CS
.... typeId 0..1II
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
..... @extension 1..1st
.... templateId 0..*II
.... @classCode 1..1csBinding: RoleClassAssociative (required)
Fixed Value: PRS
.... id 0..*II
.... sdtcIdentifiedBy 0..*IdentifiedByXML Namespace: urn:hl7-org:sdtc
XML: identifiedBy (urn:hl7-org:sdtc)
.... code 1..1CE(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 C0..*USRealmAddressBase for all types and resources
.... telecom 0..*TEL
.... associatedPerson 1..1PersonThe associatedPerson represents the name and contact information of the related person
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
...... @nullFlavor 0..1csBinding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1st
...... @displayable 0..1bl
...... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1st
..... templateId 0..*II
..... @classCode 0..1csBinding: EntityClassLivingSubject (required)
Fixed Value: PSN
..... @determinerCode 0..1csBinding: EntityDeterminer (required)
Fixed Value: INSTANCE
..... name C1..*USRealmPersonNamePNUSFIELDED(USCDI) Related Person's Name
..... sdtcDesc 0..1EDXML Namespace: urn:hl7-org:sdtc
XML: desc (urn:hl7-org:sdtc)
..... sdtcAsPatientRelationship 0..*InfrastructureRootXML Namespace: urn:hl7-org:sdtc
XML: asPatientRelationship (urn:hl7-org:sdtc)
...... @nullFlavor 0..1csBinding: CDANullFlavor (required)
...... realmCode 0..*CS
...... typeId 0..1II
....... @nullFlavor 0..1csBinding: CDANullFlavor (required)
....... @assigningAuthorityName 0..1st
....... @displayable 0..1bl
....... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
....... @extension 1..1st
...... templateId 0..*II
...... @classCode 1..1csFixed Value: PRS
...... @determinerCode 0..1csFixed Value: INSTANCE
...... code 1..1CEXML Namespace: urn:hl7-org:sdtc
XML Namespace: urn:hl7-org:sdtc
.... scopingOrganization 0..1Organization

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Participant1.nullFlavorrequiredCDANullFlavor
Participant1.typeId.nullFlavorrequiredCDANullFlavor
Participant1.templateId:related-person.nullFlavorrequiredCDANullFlavor
Participant1.typeCoderequiredFixed Value: IND
Participant1.contextControlCoderequiredFixed Value: OP
Participant1.associatedEntity.nullFlavorrequiredCDANullFlavor
Participant1.associatedEntity.typeId.nullFlavorrequiredCDANullFlavor
Participant1.associatedEntity.classCoderequiredFixed Value: PRS
Participant1.associatedEntity.coderequiredPersonalAndLegalRelationshipRoleType
Participant1.associatedEntity.associatedPerson.nullFlavorrequiredCDANullFlavor
Participant1.associatedEntity.associatedPerson.typeId.nullFlavorrequiredCDANullFlavor
Participant1.associatedEntity.associatedPerson.classCoderequiredFixed Value: PSN
Participant1.associatedEntity.associatedPerson.determinerCoderequiredFixed Value: INSTANCE
Participant1.associatedEntity.associatedPerson.sdtcAsPatientRelationship.nullFlavorrequiredCDANullFlavor
Participant1.associatedEntity.associatedPerson.sdtcAsPatientRelationship.typeId.nullFlavorrequiredCDANullFlavor

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 Value: 2 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Participant1.templateId is sliced based on the values of value:root, value:extension

 

Other representations of profile: CSV, Excel