Id2.16.840.1.113883.10.20.22.1.1Effective Date2013‑01‑31
Statusdraft DraftVersion Label1.1
NameUSRealmHeaderDisplay NameUS Realm Header
Description
This section describes constraints that apply to the header for all documents within the scope of this implementation guide. Header constraints specific to each document type are described in the appropriate document-specific section below.
ContextPathname //
ClassificationCDA Document Level Template
Open/ClosedOpen (other than defined elements are allowed)
ItemDTCardConfDescriptionLabel
cda:ClinicalDocument
USRedotsader
cda:realmCode
CS1 … 1MSHALL contain exactly one [1..1] realmCode="US" (CONF:16791).confdots6791
@code
CONF1 … 1FUS
cda:typeId
II1 … 1MSHALL contain exactly one [1..1] typeId (CONF:5361).conf‑5361
@root
uid1 … 1F2.16.840.1.113883.1.3conf‑5250
@extension
st1 … 1FPOCD_HD000040conf‑5251
cda:templateId
II1 … 1MSHALL contain exactly one [1..1] templateId (CONF:5252) such that itconf‑5252
@root
uid1 … 1F2.16.840.1.113883.10.20.22.1.1confdots0036
cda:id
II1 … 1RSHALL contain exactly one [1..1] id (CONF:5363).

This id SHALL be a globally unique identifier for the document
conf‑5363
cda:code
CE1 … 1RSHALL contain exactly one [1..1] code (CONF:5253).conf‑5253
cda:title
ST1 … 1RSHALL contain exactly one [1..1] title (CONF:5254).

can either be a locally defined name or the display name corresponding to clinicalDocument/code
conf‑5254
cda:effectiveTime
TS1 … 1RSHALL contain exactly one [1..1] effectiveTime (CONF:5256).

The content SHALL be a conformant US Realm Date and Time (DTM.US.FIELDED) (2.16.840.1.113883.10.20.22.5.4)
conf‑5256
 Schematron assertrolered error 
 teststring-length(@value)>=8 
 MessageThe content SHALL be a conformant US Realm Date and Time (DTM.US.FIELDED) (2.16.840.1.113883.10.20.22.5.4)  
cda:confidentialityCode
CE1 … 1RSHALL contain exactly one [1..1] confidentialityCode, which SHOULD be selected from ValueSet HL7 BasicConfidentialityKind 2.16.840.1.113883.1.11.16926 DYNAMIC (CONF:5259).conf‑5259
 CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.1.11.16926 HL7 BasicConfidentialityKind (DYNAMIC)
cda:languageCode
CS (extensible)1 … 1RSHALL contain exactly one [1..1] languageCode, which SHALL be selected from ValueSet Language 2.16.840.1.113883.1.11.11526 DYNAMIC (CONF:5372).conf‑5372
 CONF
The value of @code should be drawn from value set 2.16.840.1.113883.1.11.11526 HumanLanguage (DYNAMIC)
cda:setId
II0 … 1MAY contain zero or one [0..1] setId (CONF:5261).

If setId is present versionNumber SHALL be present
conf‑5261
cda:versionNumber
INT0 … 1MAY contain zero or one [0..1] versionNumber (CONF:5264).

If versionNumber is present setId SHALL be present
conf‑5264
cda:recordTarget
1 … *MSHALL contain at least one [1..*] recordTarget (CONF:5266).conf‑5266
cda:patientRole
1 … 1MSuch recordTargets SHALL contain exactly one [1..1] patientRole (CONF:5267).conf‑5267
cda:id
II1 … *RThis patientRole SHALL contain at least one [1..*] id (CONF:5268).conf‑5268
cda:addr
AD1 … *RThis patientRole SHALL contain at least one [1..*] addr (CONF:5271).

The content of addr SHALL be a conformant US Realm Address (AD.US.FIELDED) (2.16.840.1.113883.10.20.22.5.2)
conf‑5271
 Schematron assertrolered error 
 testcda:streetAddressLine and cda:city and (cda:country!='US' or ((not(cda:country) or cda:country='US') and cda:state and cda:postalCode)) 
 MessageThe content of addr SHALL be a conformant US Realm Address (AD.US.FIELDED) (2.16.840.1.113883.10.20.22.5.2) 
cda:telecom
TEL1 … *RThis patientRole SHALL contain at least one [1..*] telecom (CONF:5280).conf‑5280
@use
set_cs0 … 1 conf‑5375
 CONF
The value of @use shall be drawn from value set 2.16.840.1.113883.11.20.9.20 Telecom Use (US Realm Header) (DYNAMIC)
cda:patient
1 … 1MThis patientRole SHALL contain exactly one [1..1] patient (CONF:5283).conf‑5283
cda:name
PN1 … *RThis patient SHALL contain at least one [1..*] name (CONF:5284).

The content of name SHALL be a conformant US Realm Patient Name (PTN.US.FIELDED) (2.16.840.1.113883.10.20.22.5.1)
conf‑5284
 Schematron assertrolered error 
 testcda:given and cda:family 
 MessageThe content of name SHALL be a conformant US Realm Patient Name (PTN.US.FIELDED) (2.16.840.1.113883.10.20.22.5.1) 
cda:administrativeGenderCode
CE1 … 1RThis patient SHALL contain exactly one [1..1] administrativeGenderCode, which SHALL be selected from ValueSet Administrative Gender (HL7 V3) 2.16.840.1.113883.1.11.1 DYNAMIC (CONF:6394).conf‑6394
 CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.1.11.1 Administrative Gender (HL7 V3) (DYNAMIC)
cda:birthTime
TS1 … 1MThis patient SHALL contain exactly one [1..1] birthTime (CONF:5298).

SHALL be precise to year

SHOULD be precise to day
conf‑5298
 Schematron assertrolered error 
 teststring-length(@value) >= 4 
 MessageSHALL be precise to year 
 Schematron assertroleorange warning 
 teststring-length(@value) >= 8 
 MessageSHOULD be precise to day 
cda:maritalStatusCode
CE0 … 1RThis patient SHOULD contain zero or one [0..1] maritalStatusCode, which SHALL be selected from ValueSet Marital Status 2.16.840.1.113883.1.11.12212 DYNAMIC (CONF:5303).conf‑5303
 CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.1.11.12212 Marital Status (DYNAMIC)
cda:religiousAffiliationCode
CE0 … 1This patient MAY contain zero or one [0..1] religiousAffiliationCode, which SHALL be selected from ValueSet Religious Affiliation 2.16.840.1.113883.1.11.19185 DYNAMIC (CONF:5317).conf‑5317
 CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.1.11.19185 Religious Affiliation (DYNAMIC)
cda:raceCode
CE0 … 1This patient MAY contain zero or one [0..1] raceCode, which SHALL be selected from ValueSet Race 2.16.840.1.113883.1.11.14914 DYNAMIC (CONF:5322).conf‑5322
 CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.1.11.14914 Race (DYNAMIC)
sdtc:raceCode
CE0 … *conf‑7263
 CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.1.11.14914 Race (DYNAMIC)
cda:ethnicGroupCode
CE0 … 1This patient MAY contain zero or one [0..1] ethnicGroupCode, which SHALL be selected from ValueSet EthnicityGroup 2.16.840.1.114222.4.11.837 DYNAMIC (CONF:5323).conf‑5323
 CONF
The value of @code shall be drawn from value set 2.16.840.1.114222.4.11.837 Ethnicity (DYNAMIC)
cda:guardian
0 … *This patient MAY contain zero or more [0..*] guardian (CONF:5325).conf‑5325
cda:code
CE0 … 1RThe guardian, if present, SHOULD contain zero or one [0..1] code, which SHALL be selected from ValueSet ResponsibleParty 2.16.840.1.113883.1.11.19830 DYNAMIC (CONF:5326).conf‑5326
 CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.1.11.19830 ResponsibleParty (DYNAMIC)
cda:addr
AD0 … *RThe guardian, if present, SHOULD contain zero or more [0..*] addr (CONF:5359).

The content of addr SHALL be a conformant US Realm Address (AD.US.FIELDED) (2.16.840.1.113883.10.20.22.5.2)
conf‑5359
 Schematron assertrolered error 
 testcda:streetAddressLine and cda:city and ((not(cda:country) or cda:country!='US') or (cda:country='US' and cda:state and cda:postalCode)) 
 MessageThe content of addr SHALL be a conformant US Realm Address (AD.US.FIELDED) (2.16.840.1.113883.10.20.22.5.2) 
cda:telecom
TEL0 … *The guardian, if present, MAY contain zero or more [0..*] telecom (CONF:5382).conf‑5382
@use
set_cs0 … 1 conf‑7993
 CONF
The value of @use shall be drawn from value set 2.16.840.1.113883.11.20.9.20 Telecom Use (US Realm Header) (DYNAMIC)
cda:guardianPerson
1 … 1MThe guardian, if present, SHALL contain exactly one [1..1] guardianPerson (CONF:5385).conf‑5385
cda:name
PN1 … *RThis guardianPerson SHALL contain at least one [1..*] name (CONF:5386).

The content of name SHALL be a conformant US Realm Person Name (PN.US.FIELDED) (2.16.840.1.113883.10.20.22.5.1.1)
conf‑5386
 Schematron assertrolered error 
 test(cda:given and cda:family) or (not(*) and string-length(.)!=0) 
 MessageThe content of name SHALL be a conformant US Realm Person Name (PN.US.FIELDED) (2.16.840.1.113883.10.20.22.5.1.1) 
cda:birthplace
0 … 1This patient MAY contain zero or one [0..1] birthplace (CONF:5395).conf‑5395
cda:place
1 … 1MThe birthplace, if present, SHALL contain exactly one [1..1] place (CONF:5396).conf‑5396
cda:addr
AD1 … 1RThis place SHALL contain exactly one [1..1] addr (CONF:5397).

If country is US, this addr SHALL contain exactly one [1..1] state, which SHALL be selected from ValueSet 2.16.840.1.113883.3.88.12.80.1 StateValueSet DYNAMIC
conf‑5397
cda:country
ADXP0 … 1RThis addr SHOULD contain zero or one [0..1] country, which SHALL be selected from ValueSet Country 2.16.840.1.113883.3.88.12.80.63 DYNAMIC (CONF:5404).conf‑5404
 CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.3.88.12.80.63 Country (DYNAMIC)
cda:postalCode
ADXP0 … 1This addr MAY contain zero or one [0..1] postalCode, which SHALL be selected from ValueSet PostalCode 2.16.840.1.113883.3.88.12.80.2 DYNAMIC (CONF:5403).conf‑5403
 CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.3.88.12.80.2 PostalCode (DYNAMIC)
cda:state
ADXP0 … 1If country is US, this addr SHALL contain exactly one [1..1] state, which SHALL be selected from ValueSet 2.16.840.1.113883.3.88.12.80.1 StateValueSet DYNAMICconf‑5397
 CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.3.88.12.80.1 StateValueSet (DYNAMIC)
 Schematron assertrolered error 
 testnot(ancestor::cda:patientRole/cda:addr[cda:country='US' or cda:country='USA']) or cda:state 
 MessageIf country is US, this addr SHALL contain exactly one [1..1] state, which SHALL be selected from ValueSet 2.16.840.1.113883.3.88.12.80.1 StateValueSet DYNAMIC 
cda:languageCommunication
0 … *RThis patient SHOULD contain zero or more [0..*] languageCommunication (CONF:5406).conf‑5406
cda:languageCode
CS1 … 1RThe languageCommunication, if present, SHALL contain exactly one [1..1] languageCode, which SHALL be selected from ValueSet Language 2.16.840.1.113883.1.11.11526 DYNAMIC (CONF:5407).conf‑5407
 CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.1.11.11526 HumanLanguage (DYNAMIC)
cda:modeCode
CE0 … 1The languageCommunication, if present, MAY contain zero or one [0..1] modeCode, which SHALL be selected from ValueSet LanguageAbilityMode 2.16.840.1.113883.1.11.12249 DYNAMIC (CONF:5409).conf‑5409
 CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.1.11.12249 LanguageAbilityMode (DYNAMIC)
cda:proficiencyLevelCode
CE0 … 1RThe languageCommunication, if present, SHOULD contain zero or one [0..1] proficiencyLevelCode, which SHALL be selected from ValueSet LanguageAbilityProficiency 2.16.840.1.113883.1.11.12199 DYNAMIC (CONF:9965).conf‑9965
 CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.1.11.12199 LanguageAbilityProficiency (DYNAMIC)
cda:preferenceInd
BL0 … 1The languageCommunication, if present, MAY contain zero or one [0..1] preferenceInd (CONF:5414).conf‑5414
cda:providerOrganization
0 … 1This patientRole MAY contain zero or one [0..1] providerOrganization (CONF:5416).conf‑5416
cda:id
II1 … *RThe providerOrganization, if present, SHALL contain at least one [1..*] id (CONF:5417).conf‑5417
@root
uid0 … 1 confdots6820
cda:name
ON1 … *RThe providerOrganization, if present, SHALL contain at least one [1..*] name (CONF:5419).conf‑5419
cda:telecom
TEL1 … *RThe providerOrganization, if present, SHALL contain at least one [1..*] telecom (CONF:5420).conf‑5420
@use
set_cs0 … 1 conf‑7994
 CONF
The value of @use shall be drawn from value set 2.16.840.1.113883.11.20.9.20 Telecom Use (US Realm Header) (DYNAMIC)
cda:addr
AD1 … *RThe providerOrganization, if present, SHALL contain at least one [1..*] addr (CONF:5422).

The content of addr SHALL be a conformant US Realm Address (AD.US.FIELDED) (2.16.840.1.113883.10.20.22.5.2)
conf‑5422
 Schematron assertrolered error 
 testcda:streetAddressLine and cda:city and ((not(cda:country) or cda:country!='US') or (cda:country='US' and cda:state and cda:postalCode)) 
 MessageThe content of addr SHALL be a conformant US Realm Address (AD.US.FIELDED) (2.16.840.1.113883.10.20.22.5.2) 
cda:author
1 … *MSHALL contain at least one [1..*] author (CONF:5444).conf‑5444
cda:time
TS1 … 1MSuch authors SHALL contain exactly one [1..1] time (CONF:5445).

The content SHALL be a conformant US Realm Date and Time (DTM.US.FIELDED) (2.16.840.1.113883.10.20.22.5.4)
conf‑5445
 Schematron assertrolered error 
 teststring-length(@value)>=8 
 MessageThe content SHALL be a conformant US Realm Date and Time (DTM.US.FIELDED) (2.16.840.1.113883.10.20.22.5.4) 
cda:assignedAuthor
1 … 1MSuch authors SHALL contain exactly one [1..1] assignedAuthor (CONF:5448).

There SHALL be exactly one assignedAuthor/assignedPerson or exactly one assignedAuthor/assignedAuthoringDevice
conf‑5448
cda:id
II1 … *This assignedAuthor SHALL contain at least one [1..*] id (CONF:1198-5449).CONFdots5449
cda:id
II0 … 1RIf this assignedAuthor is an assignedPersonCONFdots2882
where [parent::cda:assignedPerson]
@nullFlavor
cs0 … 1FUNKCONFdots2883
 MAY contain zero or one [0..1] @nullFlavor="UNK" Unknown (CodeSystem: HL7NullFlavor urn:oid:2.16.840.1.113883.5.1008) (CONF:1198-32883).
@root
uid1 … 1F2.16.840.1.113883.4.6CONFdots2884
 SHALL contain exactly one [1..1] @root="2.16.840.1.113883.4.6" National Provider Identifier (CONF:1198-32884).
@extension
st0 … 1 SHOULD contain zero or one [0..1] @extension (CONF:1198-32885).CONFdots2885
cda:code
CE (extensible)0 … 1RThis assignedAuthor SHOULD contain zero or one [0..1] code (CONF:16787).CONFdots6787
@code
cs0 … 1 The code, if present, SHALL contain exactly one [1..1] @code, which SHOULD be selected from ValueSet Healthcare Provider Taxonomy urn:oid:2.16.840.1.114222.4.11.1066 DYNAMIC (CONF:1198-16788)."CONFdots6788
 CONF
The value of @code shall be drawn from value set 2.16.840.1.114222.4.11.1066 Healthcare Provider Taxonomy (DYNAMIC)
cda:addr
AD1 … *RThis assignedAuthor SHALL contain at least one [1..*] addr (CONF:5452).

The content SHALL be a conformant US Realm Address (AD.US.FIELDED) (2.16.840.1.113883.10.20.22.5.2)
conf‑5452
 Schematron assertrolered error 
 testcda:streetAddressLine and cda:city and ((not(cda:country) or cda:country!='US') or (cda:country='US' and cda:state and cda:postalCode)) 
 MessageThe content SHALL be a conformant US Realm Address (AD.US.FIELDED) (2.16.840.1.113883.10.20.22.5.2) 
cda:telecom
TEL1 … *RThis assignedAuthor SHALL contain at least one [1..*] telecom (CONF:5428).conf‑5428
@use
set_cs0 … 1 conf‑7995
 CONF
The value of @use shall be drawn from value set 2.16.840.1.113883.11.20.9.20 Telecom Use (US Realm Header) (DYNAMIC)
Choice1 … 1Elements to choose from:
  • cda:assignedPerson
  • cda:assignedAuthoringDevice
cda:assignedPerson
0 … 1RThis assignedAuthor SHOULD contain zero or one [0..1] assignedPerson (CONF:5430).conf‑5430
cda:name
PN1 … *RThe assignedPerson, if present, SHALL contain at least one [1..*] name (CONF:16789).

The content SHALL be a conformant US Realm Person Name (PN.US.FIELDED) (2.16.840.1.113883.10.20.22.5.1.1)
confdots6789
 Schematron assertrolered error 
 test(count(cda:given) > 0 and cda:family) or (count(*)=0 and string-length(.)!=0) 
 MessageThe content SHALL be a conformant US Realm Person Name (PN.US.FIELDED) (2.16.840.1.113883.10.20.22.5.1.1) 
cda:assignedAuthoringDevice
0 … 1RThis assignedAuthor SHOULD contain zero or one [0..1] assignedAuthoringDevice (CONF:16783).confdots6783
cda:manufacturerModelName
SC1 … 1RThe assignedAuthoringDevice, if present, SHALL contain exactly one [1..1] manufacturerModelName (CONF:16784).confdots6784
cda:softwareName
SC1 … 1RThe assignedAuthoringDevice, if present, SHALL contain exactly one [1..1] softwareName (CONF:16785).confdots6785
cda:dataEnterer
0 … 1MAY contain zero or one [0..1] dataEnterer (CONF:5441).conf‑5441
cda:assignedEntity
1 … 1MThe dataEnterer, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:5442).

This assignedEntity MAY contain zero or one [0..1] code which SHOULD be selected from coding system NUCC Health Care Provider Taxonomy 2.16.840.1.113883.6.101
conf‑5442
cda:id
II1 … *RThis assignedEntity SHALL contain at least one [1..*] id (CONF:5443).conf‑5443
@root
uid0 … 1 confdots6821
cda:addr
AD1 … *RThis assignedEntity SHALL contain at least one [1..*] addr (CONF:5460).

The content of addr SHALL be a conformant US Realm Address (AD.US.FIELDED) (2.16.840.1.113883.10.20.22.5.2)
conf‑5460
 Schematron assertrolered error 
 testcda:streetAddressLine and cda:city and ((not(cda:country) or cda:country!='US') or (cda:country='US' and cda:state and cda:postalCode)) 
 MessageThe content of addr SHALL be a conformant US Realm Address (AD.US.FIELDED) (2.16.840.1.113883.10.20.22.5.2) 
cda:telecom
TEL1 … *RThis assignedEntity SHALL contain at least one [1..*] telecom (CONF:5466).conf‑5466
@use
set_cs0 … 1 conf‑7996
 CONF
The value of @use shall be drawn from value set 2.16.840.1.113883.11.20.9.20 Telecom Use (US Realm Header) (DYNAMIC)
cda:assignedPerson
1 … 1MThis assignedEntity SHALL contain exactly one [1..1] assignedPerson (CONF:5469).conf‑5469
cda:name
PN1 … *RThis assignedPerson SHALL contain at least one [1..*] name (CONF:5470).

The content of name SHALL be a conformant US Realm Person Name (PN.US.FIELDED) (2.16.840.1.113883.10.20.22.5.1.1)
conf‑5470
 Schematron assertrolered error 
 test(cda:given and cda:family) or (not(*) and string-length(.)!=0) 
 MessageThe content of name SHALL be a conformant US Realm Person Name (PN.US.FIELDED) (2.16.840.1.113883.10.20.22.5.1.1) 
cda:informant
0 … *MAY contain zero or more [0..*] informant (CONF:8001) such that itconf‑8001
where [cda:assignedEntity]
cda:assignedEntity
1 … 1MSHALL contain exactly one [1..1] assignedEntity (CONF:8002).

This assignedEntity MAY contain zero or one [0..1] code which SHOULD be selected from coding system NUCC Health Care Provider Taxonomy 2.16.840.1.113883.6.101
conf‑8002
cda:id
II1 … *RThis assignedEntity SHALL contain at least one [1..*] id (CONF:9945).

If assignedEntity/id is a provider then this id, SHOULD include zero or one [0..1] id where id/@root ="2.16.840.1.113883.4.6" National Provider Identifier
conf‑9945
cda:code
CE0 … 1This assignedEntity MAY contain zero or one [0..1] code which SHOULD be selected from coding system NUCC Health Care Provider Taxonomy 2.16.840.1.113883.6.101conf‑8002
@codeSystem
CONF0 … 1F2.16.840.1.113883.6.101
cda:addr
AD1 … *MThis assignedEntity SHALL contain at least one [1..*] addr (CONF:8220).

The content of addr SHALL be a conformant US Realm Address (AD.US.FIELDED) (2.16.840.1.113883.10.20.22.5.2)
conf‑8220
 Schematron assertrolered error 
 testcda:streetAddressLine and cda:city and (cda:country!='US' or ((not(cda:country) or cda:country='US') and cda:state and cda:postalCode)) 
 MessageThe content of addr SHALL be a conformant US Realm Address (AD.US.FIELDED) (2.16.840.1.113883.10.20.22.5.2) 
cda:assignedPerson
1 … 1MThis assignedEntity SHALL contain exactly one [1..1] assignedPerson (CONF:8221).conf‑8221
cda:name
PN1 … *MThis assignedPerson SHALL contain at least one [1..*] name (CONF:8222).

The content of name SHALL be a conformant US Realm Person Name (PN.US.FIELDED) (2.16.840.1.113883.10.20.22.5.1.1)
conf‑8222
 Schematron assertrolered error 
 test(count(cda:given) > 0 and cda:family) or (count(*)=0 and string-length(.)!=0) 
 MessageThe content of name SHALL be a conformant US Realm Person Name (PN.US.FIELDED) (2.16.840.1.113883.10.20.22.5.1.1) 
cda:informant
0 … *MAY contain zero or more [0..*] informant (CONF:26467) such that itconfdots4681
where [cda:relatedEntity]
cda:relatedEntity
1 … 1RSHALL contain exactly one [1..1] relatedEntity (CONF:26468).confdots4682
cda:custodian
1 … 1MSHALL contain exactly one [1..1] custodian (CONF:5519).conf‑5519
cda:assignedCustodian
1 … 1MThis custodian SHALL contain exactly one [1..1] assignedCustodian (CONF:5520).conf‑5520
cda:representedCustodianOrganization
1 … 1MThis assignedCustodian SHALL contain exactly one [1..1] representedCustodianOrganization (CONF:5521).conf‑5521
cda:id
II1 … *RThis representedCustodianOrganization SHALL contain at least one [1..*] id (CONF:5522).conf‑5522
@root
uid0 … 1 confdots6822
cda:name
ON1 … 1RThis representedCustodianOrganization SHALL contain exactly one [1..1] name (CONF:5524).conf‑5524
cda:telecom
TEL1 … 1RThis representedCustodianOrganization SHALL contain exactly one [1..1] telecom (CONF:5525).conf‑5525
@use
set_cs0 … 1 conf‑7998
 CONF
The value of @use shall be drawn from value set 2.16.840.1.113883.11.20.9.20 Telecom Use (US Realm Header) (DYNAMIC)
cda:addr
AD1 … 1RThis representedCustodianOrganization SHALL contain exactly one [1..1] addr (CONF:5559).

The content of addr SHALL be a conformant US Realm Address (AD.US.FIELDED) (2.16.840.1.113883.10.20.22.5.2)
conf‑5559
 Schematron assertrolered error 
 testcda:streetAddressLine and cda:city and ((not(cda:country) or cda:country!='US') or (cda:country='US' and cda:state and cda:postalCode)) 
 MessageThe content of addr SHALL be a conformant US Realm Address (AD.US.FIELDED) (2.16.840.1.113883.10.20.22.5.2) 
cda:informationRecipient
0 … *MAY contain zero or more [0..*] informationRecipient (CONF:5565).conf‑5565
cda:intendedRecipient
1 … 1MThe informationRecipient, if present, SHALL contain exactly one [1..1] intendedRecipient (CONF:5566).conf‑5566
cda:informationRecipient
0 … 1This intendedRecipient MAY contain zero or one [0..1] informationRecipient (CONF:5567).conf‑5567
cda:name
PN1 … *MThe informationRecipient, if present, SHALL contain at least one [1..*] name (CONF:5568).

The content of name SHALL be a conformant US Realm Person Name (PN.US.FIELDED) (2.16.840.1.113883.10.20.22.5.1.1)
conf‑5568
 Schematron assertrolered error 
 test(cda:given and cda:family) or (not(*) and string-length(.)!=0) 
 MessageThe content of name SHALL be a conformant US Realm Person Name (PN.US.FIELDED) (2.16.840.1.113883.10.20.22.5.1.1) 
cda:receivedOrganization
0 … 1This intendedRecipient MAY contain zero or one [0..1] receivedOrganization (CONF:5577).conf‑5577
cda:name
ON1 … 1RThe receivedOrganization, if present, SHALL contain exactly one [1..1] name (CONF:5578).conf‑5578
cda:legalAuthenticator
0 … 1RSHOULD contain zero or one [0..1] legalAuthenticator (CONF:5579).conf‑5579
cda:time
TS1 … 1MThe legalAuthenticator, if present, SHALL contain exactly one [1..1] time (CONF:5580).

The content SHALL be a conformant US Realm Date and Time (DTM.US.FIELDED) (2.16.840.1.113883.10.20.22.5.4)
conf‑5580
 Schematron assertrolered error 
 teststring-length(@value)>=8 
 MessageThe content SHALL be a conformant US Realm Date and Time (DTM.US.FIELDED) (2.16.840.1.113883.10.20.22.5.4)  
cda:signatureCode
CS1 … 1MThe legalAuthenticator, if present, SHALL contain exactly one [1..1] signatureCode (CONF:5583).conf‑5583
@code
1 … 1FSconf‑5584
@code
CONF1 … 1FS
@codeSystem
1 … 1F2.16.840.1.113883.5.89
cda:assignedEntity
1 … 1MThe legalAuthenticator, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:5585).conf‑5585
cda:id
II1 … *RThis assignedEntity SHALL contain at least one [1..*] id (CONF:5586).conf‑5586
@root
uid0 … 1 confdots6823
cda:code
CE0 … 1This assignedEntity MAY contain zero or one [0..1] code, which SHOULD be selected from ValueSet Healthcare Provider Taxonomy (HIPAA) 2.16.840.1.114222.4.11.1066 STATIC (CONF:17000).confdots7000
 CONF
The value of @code shall be drawn from value set 2.16.840.1.114222.4.11.1066 Healthcare Provider Taxonomy (DYNAMIC)
cda:addr
AD1 … *RThis assignedEntity SHALL contain at least one [1..*] addr (CONF:5589).

The content of addr SHALL be a conformant US Realm Address (AD.US.FIELDED) (2.16.840.1.113883.10.20.22.5.2)
conf‑5589
 Schematron assertrolered error 
 testcda:streetAddressLine and cda:city and ((not(cda:country) or cda:country!='US') or (cda:country='US' and cda:state and cda:postalCode)) 
 MessageThe content of addr SHALL be a conformant US Realm Address (AD.US.FIELDED) (2.16.840.1.113883.10.20.22.5.2) 
cda:telecom
TEL1 … *RThis assignedEntity SHALL contain at least one [1..*] telecom (CONF:5595).conf‑5595
@use
set_cs0 … 1 conf‑7999
 CONF
The value of @use shall be drawn from value set 2.16.840.1.113883.11.20.9.20 Telecom Use (US Realm Header) (DYNAMIC)
cda:assignedPerson
1 … 1MThis assignedEntity SHALL contain exactly one [1..1] assignedPerson (CONF:5597).conf‑5597
cda:name
PN1 … *MThis assignedPerson SHALL contain at least one [1..*] name (CONF:5598).

The content of name SHALL be a conformant US Realm Person Name (PN.US.FIELDED) (2.16.840.1.113883.10.20.22.5.1.1)
conf‑5598
 Schematron assertrolered error 
 test(cda:given and cda:family) or (not(*) and string-length(.)!=0) 
 MessageThe content of name SHALL be a conformant US Realm Person Name (PN.US.FIELDED) (2.16.840.1.113883.10.20.22.5.1.1) 
cda:authenticator
0 … *MAY contain zero or more [0..*] authenticator (CONF:5607).conf‑5607
cda:time
TS1 … 1MThe authenticator, if present, SHALL contain exactly one [1..1] time (CONF:5608).

The content SHALL be a conformant US Realm Date and Time (DTM.US.FIELDED) (2.16.840.1.113883.10.20.22.5.4)
conf‑5608
 Schematron assertrolered error 
 teststring-length(@value)>=8 
 MessageThe content SHALL be a conformant US Realm Date and Time (DTM.US.FIELDED) (2.16.840.1.113883.10.20.22.5.4) 
cda:signatureCode
CS1 … 1MThe authenticator, if present, SHALL contain exactly one [1..1] signatureCode (CONF:5610).conf‑5610
@code
1 … 1FSconf‑5611
@code
CONF1 … 1FS
@codeSystem
1 … 1F2.16.840.1.113883.5.89
cda:assignedEntity
1 … 1MThe authenticator, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:5612).conf‑5612
cda:id
II1 … *RThis assignedEntity SHALL contain at least one [1..*] id (CONF:5613).conf‑5613
@root
uid0 … 1 confdots6824
cda:code
CE0 … 1This assignedEntity MAY contain zero or one [0..1] code (CONF:16825).confdots6825
cda:addr
AD1 … *MThis assignedEntity SHALL contain at least one [1..*] addr (CONF:5616).

The content of addr SHALL be a conformant US Realm Address (AD.US.FIELDED) (2.16.840.1.113883.10.20.22.5.2)
conf‑5616
 Schematron assertrolered error 
 testcda:streetAddressLine and cda:city and ((not(cda:country) or cda:country!='US') or (cda:country='US' and cda:state and cda:postalCode)) 
 MessageThe content of addr SHALL be a conformant US Realm Address (AD.US.FIELDED) (2.16.840.1.113883.10.20.22.5.2) 
cda:telecom
TEL1 … *RThis assignedEntity SHALL contain at least one [1..*] telecom (CONF:5622).conf‑5622
@use
set_cs0 … 1 conf‑8000
 CONF
The value of @use shall be drawn from value set 2.16.840.1.113883.11.20.9.20 Telecom Use (US Realm Header) (DYNAMIC)
cda:assignedPerson
1 … 1MThis assignedEntity SHALL contain exactly one [1..1] assignedPerson (CONF:5624).conf‑5624
cda:name
PN1 … *MThis assignedPerson SHALL contain at least one [1..*] name (CONF:5625).

The content of name SHALL be a conformant US Realm Person Name (PN.US.FIELDED) (2.16.840.1.113883.10.20.22.5.1.1)
conf‑5625
 Schematron assertrolered error 
 test(cda:given and cda:family) or (not(*) and string-length(.)!=0) 
 MessageThe content of name SHALL be a conformant US Realm Person Name (PN.US.FIELDED) (2.16.840.1.113883.10.20.22.5.1.1) 
cda:participant
0 … *MAY contain zero or more [0..*] participant (CONF:10003) such that it

Such participants, if present, SHALL contain associatedEntity/associatedPerson or associatedEntity/scopingOrganization.

Unless otherwise specified by the document specific header constraints, when participant/@typeCode is IND, associatedEntity/@classCode SHALL be selected from ValueSet 2.16.840.1.113883.11.20.9.33 INDRoleclassCodes STATIC 2011-09-30
confdots0003
cda:time
IVL_TS0 … 1MAY contain zero or one [0..1] time (CONF:10004).confdots0004
hl7:associatedEntity
1 … 1RSuch participants, if present, SHALL contain associatedEntity/associatedPerson or associatedEntity/scopingOrganization.confdots0003
Choice1 … Elements to choose from:
  • hl7:associatedPerson
  • hl7:scopingOrganization
hl7:associatedPerson
0 … 1confdots0003
hl7:scopingOrganization
0 … 1confdots0003
cda:inFulfillmentOf
0 … *MAY contain zero or more [0..*] inFulfillmentOf (CONF:9952).conf‑9952
cda:order
1 … 1MThe inFulfillmentOf, if present, SHALL contain exactly one [1..1] order (CONF:9953).conf‑9953
cda:id
II1 … *RThis order SHALL contain at least one [1..*] id (CONF:9954).conf‑9954
cda:documentationOf
0 … *MAY contain zero or more [0..*] documentationOf (CONF:14835).confdots4835
cda:serviceEvent
1 … 1MThe documentationOf, if present, SHALL contain exactly one [1..1] serviceEvent (CONF:14836).confdots4836
cda:effectiveTime
IVL_TS1 … 1RThis serviceEvent SHALL contain exactly one [1..1] effectiveTime (CONF:14837).confdots4837
cda:low
TS1 … 1RThis effectiveTime SHALL contain exactly one [1..1] low (CONF:14838).confdots4838
cda:performer
0 … *RThis serviceEvent SHOULD contain zero or more [0..*] performer (CONF:14839).

The performer participant represents clinicians who actually and principally carry out the serviceEvent. In a transfer of care this represents the healthcare providers involved in the current or pertinent historical care of the patient. Preferably, the patient’s key healthcare care team members would be listed, particularly their primary physician and any active consulting physicians, therapists, and counselors
confdots4839
@typeCode
cs1 … 1Rconfdots4840
cda:functionCode
CE0 … 1The performer, if present, MAY contain zero or one [0..1] functionCode (CONF:16818).confdots6818
@codeSystem
0 … 1 confdots6819
cda:assignedEntity
1 … 1RThe performer, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:14841).confdots4841
cda:id
II1 … *RThis assignedEntity SHALL contain at least one [1..*] id (CONF:14846).confdots4846
@root
uid0 … 1 confdots4847
cda:code
CE0 … 1This assignedEntity SHOULD contain zero or one [0..1] code, which SHOULD be selected from CodeSystem Healthcare Provider Taxonomy (HIPAA) (urn:oid:2.16.840.1.113883.6.101) DYNAMIC (CONF:14842).
confdots4842
 ConstraintThis assignedEntity SHOULD contain zero or one [0..1] code, which SHOULD be selected from CodeSystem Healthcare Provider Taxonomy (HIPAA)
 CONF
The value of @code shall be drawn from value set 2.16.840.1.114222.4.11.1066 Healthcare Provider Taxonomy (DYNAMIC)
cda:authorization
0 … *MAY contain zero or more [0..*] authorization (CONF:16792) such that itconfdots6792
cda:consent
1 … 1MSHALL contain exactly one [1..1] consent (CONF:16793).confdots6793
cda:id
II0 … *This consent MAY contain zero or more [0..*] id (CONF:16794).confdots6794
cda:code
CE0 … 1This consent MAY contain zero or one [0..1] code (CONF:16795).confdots6795
cda:statusCode
CS1 … 1MThis consent SHALL contain exactly one [1..1] statusCode (CONF:16797).confdots6797
@code
CONF1 … 1Fcompleted
cda:componentOf
0 … 1MAY contain zero or one [0..1] componentOf (CONF:9955).conf‑9955
cda:encompassingEncounter
1 … 1MThe componentOf, if present, SHALL contain exactly one [1..1] encompassingEncounter (CONF:9956).conf‑9956
cda:id
II1 … *RThis encompassingEncounter SHALL contain at least one [1..*] id (CONF:9959).conf‑9959
cda:effectiveTime
IVL_TS1 … 1RThis encompassingEncounter SHALL contain exactly one [1..1] effectiveTime (CONF:9958).conf‑9958