Templates

Show index

Template US Realm Header (V3) 2015‑08‑01

Id2.16.840.1.113883.10.20.22.1.1
ref
ccda-
Effective Date2015‑08‑01
Statusdraft DraftVersion Label2.1
NameUSRealmHeaderV3Display NameUS Realm Header (V3)
Description
This template defines constraints that represent common administrative and demographic concepts for US Realm CDA documents. Further specification, such as ClinicalDocument/code, are provided in document templates that conform to this template.
ContextPathname //
ClassificationCDA Document Level Template
Open/ClosedOpen (other than defined elements are allowed)
Used by / Uses
Used by 1 transaction and 0 templates, Uses 4 templates
Used by as NameVersion
2.16.840.1.113883.3.1937.99.3.4.33Transactionfinal US Realm Header (V3)2015‑08‑01
Uses as NameVersion
2.16.840.1.113883.10.20.22.5.1Includedraft US Realm Patient Name (PTN.US.FIELDED) (2.1)DYNAMIC
2.16.840.1.113883.10.20.22.5.1.1Containmentdraft US Realm Person Name (PN.US.FIELDED) (2.1)2015‑08‑13
2.16.840.1.113883.10.20.22.5.2Includedraft US Realm Address (AD.US.FIELDED) (2.1)2015‑08‑13
2.16.840.1.113883.10.20.22.5.4Containmentdraft US Realm Date and Time (DTM.US.FIELDED) (2.1)2015‑08‑13
RelationshipSpecialization: template 2.16.840.1.113883.10.12.1 CDA ClinicalDocument (2005‑09‑07)
ref
ad1bbr-

Version: template 2.16.840.1.113883.10.20.22.1.1 US Realm Header (2013‑01‑31)
ref
ccda-
ItemDTCardConfDescriptionLabel
cda:ClinicalDocument
USRedotserV3
cda:realmCode
CS1 … 1RSHALL contain exactly one [1..1] realmCode="US" (CONF:1198-16791).CONFdots6791
cda:typeId
II1 … 1SHALL contain exactly one [1..1] typeId (CONF:1198-5361).CONFdots5361
@root
uid1 … 1F2.16.840.1.113883.1.3CONFdots5250
 This typeId SHALL contain exactly one [1..1] @root="2.16.840.1.113883.1.3" (CONF:1198-5250).
@extension
st1 … 1FPOCD_HD000040CONFdots5251
 This typeId SHALL contain exactly one [1..1] @extension="POCD_HD000040" (CONF:1198-5251).
cda:templateId
II1 … 1MC-CDA R1.1 templateId root without an extensionCONFdots2936
@root
uid1 … 1F2.16.840.1.113883.10.20.22.1.1
cda:templateId
II1 … 1MSHALL contain exactly one [1..1] templateId (CONF:1198-5252) such that itCONFdots5252
@root
uid1 … 1F2.16.840.1.113883.10.20.22.1.1CONFdots0036
 SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.1.1" (CONF:1198-10036).
@extension
st1 … 1F2015-08-01CONFdots2503
 SHALL contain exactly one [1..1] @extension="2015-08-01" (CONF:1198-32503).
 ConstraintWhen asserting this templateId, all document, section, and entry templates *SHALL* include a templateId root without an extension. See C-CDA R2.1 Volume 1 - Design Considerations for additional detail.
cda:id
II1 … 1SHALL contain exactly one [1..1] id (CONF:1198-5363).CONFdots5363
 ConstraintThis id *SHALL* be a globally unique identifier for the document.
cda:code
CE1 … 1SHALL contain exactly one [1..1] code (CONF:1198-5253).

a. This code SHALL specify the particular kind of document (e.g., History and Physical, Discharge Summary, Progress Note) (CONF:1198-9992).

b. This code SHALL be drawn from the LOINC document type ontology (LOINC codes where SCALE = DOC) (CONF:1198-32948).

CONFdots5253
 Schematron assertrolered error 
 testcda:code/@codeSystem='2.16.840.1.113883.6.1' 
 MessageThis code SHALL be drawn from the LOINC document type ontology (LOINC codes where SCALE = DOC) (CONF:1198-32948). 
cda:title
ST1 … 1SHALL contain exactly one [1..1] title (CONF:1198-5254).CONFdots5254
cda:effectiveTime
TS1 … 1Contains 2.16.840.1.113883.10.20.22.5.4 US Realm Date and Time (DTM.US.FIELDED) (2015‑08‑13)CONFdots5256
 ConstraintSHALL contain exactly one [1..1] US Realm Date and Time (DTM.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.4) (CONF:1198-5256).
cda:confidentialityCode
CE1 … 1SHALL contain exactly one [1..1] confidentialityCode, which SHOULD be selected from ValueSet HL7 BasicConfidentialityKind urn:oid:2.16.840.1.113883.1.11.16926 STATIC (CONF:1198-5259).CONFdots5259
 CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.1.11.16926 HL7 BasicConfidentialityKind (DYNAMIC)
cda:languageCode
CS1 … 1MSHALL contain exactly one [1..1] languageCode, which SHALL be selected from ValueSet Language urn:oid:2.16.840.1.113883.1.11.11526 DYNAMIC (CONF:1198-5372).CONFdots5372
 CONF
The value of @code shall 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:1198-5261).CONFdots5261
cda:versionNumber
INT0 … 1MAY contain zero or one [0..1] versionNumber (CONF:1198-5264).CONFdots5264
cda:recordTarget
1 … *MSHALL contain at least one [1..*] recordTarget (CONF:1198-5266).

The recordTarget records the administrative and demographic data of the patient whose health information is described by the clinical document; each recordTarget must contain at least one patientRole element

CONFdots5266
cda:patientRole
1 … 1CONFdots5267
cda:id
II1 … *This patientRole SHALL contain at least one [1..*] id (CONF:1198-5268).CONFdots5268
Included1 … * from 2.16.840.1.113883.10.20.22.5.2 US Realm Address (AD.US.FIELDED) (2015‑08‑13)
cda:addr
1 … *USRedotsLDED
@nullFlavor
cs0 … 1 
@use
set_cs0 … 1 SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet PostalAddressUse urn:oid:2.16.840.1.113883.1.11.10637 STATIC 2005-05-01 (CONF:81-7290).CONFdots7290
 CONF
The value of @use shall be drawn from value set 2.16.840.1.113883.1.11.10637 PostalAddressUse (DYNAMIC)
 Constraint*SHALL NOT* have mixed content except for white space
 ConstraintIf the country is US, the state element is required 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).
cda:country
ADXP0 … 1RSHOULD contain zero or one [0..1] country, which SHALL be selected from ValueSet Country urn:oid:2.16.840.1.113883.3.88.12.80.63 DYNAMIC (CONF:81-7295).CONFdots7295
 CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.3.88.12.80.63 Country (DYNAMIC)
cda:state
ADXP0 … 1RSHOULD contain zero or one [0..1] state (ValueSet: StateValueSet urn:oid:2.16.840.1.113883.3.88.12.80.1 DYNAMIC) (CONF:81-7293).CONFdots7293
 ConstraintState is required if the country is US. 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).
 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 
 test@nullFlavor or (cda:country='US' and cda:state) or (cda:country!='US') or (not(cda:country) and cda:state) 
 MessageState is required if the country is US. 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. 
cda:city
ADXP1 … 1RSHALL contain exactly one [1..1] city (CONF:81-7292).CONFdots7292
cda:postalCode
ADXP0 … 1RSHOULD contain zero or one [0..1] postalCode, which SHOULD be selected from ValueSet PostalCode urn:oid:2.16.840.1.113883.3.88.12.80.2 DYNAMIC (CONF:81-7294). 
CONFdots7294
 ConstraintIf 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).
 CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.3.88.12.80.2 PostalCode (DYNAMIC)
 Schematron assertrolered error 
 test@nullFlavor or (cda:country='US' and cda:postalCode) or (cda:country!='US') or (not(cda:country) and cda:postalCode) 
 MessageIf 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). 
cda:streetAddressLine
ADXP1 … 4RCONFdots7291
 Schematron assertrolered error 
 test@nullFlavor or (count(cda:streetAddressLine) > 0 and count(cda:streetAddressLine) < 5) 
 MessageSHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291) 
 Schematron assertrolered error 
 test@nullFlavor or (cda:city and cda:streetAddressLine)  
 Message 
cda:telecom
TEL1 … *This patientRole SHALL contain at least one [1..*] telecom (CONF:1198-5280).CONFdots5280
@use
set_cs0 … 1 Such telecoms SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet Telecom Use (US Realm Header) urn:oid:2.16.840.1.113883.11.20.9.20 DYNAMIC (CONF:1198-5375).CONFdots5375
 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 … 1This patientRole SHALL contain exactly one [1..1] patient (CONF:1198-5283).

This patient SHALL contain at least one [1..*] US Realm Patient Name (PTN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1) STATIC 2015-08-13 (CONF:1198-5284).

If the patient carries a nullFlavor, the elements of the US Realm Patient Name SHALL NOT be populated.
CONFdots5283
Included from 2.16.840.1.113883.10.20.22.5.1 US Realm Patient Name (PTN.US.FIELDED) (DYNAMIC)
cda:name
USRedotsLDED
@nullFlavor
cs0 … 1 
@use
set_cs0 … 1 MAY contain zero or one [0..1] @use, which SHALL be selected from ValueSet EntityNameUse urn:oid:2.16.840.1.113883.1.11.15913 STATIC 2005-05-01 (CONF:81-7154).CONFdots7154
 CONF
The value of @use shall be drawn from value set 2.16.840.1.113883.1.11.15913 EntityNameUse (DYNAMIC)
 Constraint*SHALL NOT* have mixed content except for white space
cda:family
ST0 … 1CSHALL contain exactly one [1..1] family (CONF:81-7159).CONFdots7159
@qualifier
set_cs0 … 1 This family MAY contain zero or one [0..1] @qualifier, which SHALL be selected from ValueSet EntityPersonNamePartQualifier urn:oid:2.16.840.1.113883.11.20.9.26 STATIC 2011-09-30 (CONF:81-7160).CONFdots7160
 CONF
The value of @qualifier shall be drawn from value set 2.16.840.1.113883.11.20.9.26 EntityPersonNamePartQualifier (DYNAMIC)
cda:given
ST0 … *CSHALL contain at least one [1..*] given (CONF:81-7157).CONFdots7157
@qualifier
set_cs0 … 1 Such givens MAY contain zero or one [0..1] @qualifier, which SHALL be selected from ValueSet EntityPersonNamePartQualifier urn:oid:2.16.840.1.113883.11.20.9.26 STATIC 2011-09-30 (CONF:81-7158).CONFdots7158
 CONF
The value of @qualifier shall be drawn from value set 2.16.840.1.113883.11.20.9.26 EntityPersonNamePartQualifier (DYNAMIC)
 ConstraintThe second occurrence of given (given[2]) if provided, SHALL include middle name or middle initial
cda:prefix
ST0 … *MAY contain zero or more [0..*] prefix (CONF:81-7155).CONFdots7155
@qualifier
set_cs0 … 1 The prefix, if present, MAY contain zero or one [0..1] @qualifier, which SHALL be selected from ValueSet EntityPersonNamePartQualifier urn:oid:2.16.840.1.113883.11.20.9.26 STATIC 2011-09-30 (CONF:81-7156).CONFdots7156
 CONF
The value of @qualifier shall be drawn from value set 2.16.840.1.113883.11.20.9.26 EntityPersonNamePartQualifier (DYNAMIC)
cda:suffix
ST0 … 1MAY contain zero or one [0..1] suffix (CONF:81-7161).CONFdots7161
@qualifier
set_cs0 … 1 The suffix, if present, MAY contain zero or one [0..1] @qualifier, which SHALL be selected from ValueSet EntityPersonNamePartQualifier urn:oid:2.16.840.1.113883.11.20.9.26 STATIC 2011-09-30 (CONF:81-7162).CONFdots7162
 CONF
The value of @qualifier shall be drawn from value set 2.16.840.1.113883.11.20.9.26 EntityPersonNamePartQualifier (DYNAMIC)
 Schematron assertrolered error 
 test@nullFlavor or (cda:family and cda:given)  
 Messageif name is not null, then family and given elements are both required. 
cda:administrativeGenderCode
CE1 … 1RThis patient SHALL contain exactly one [1..1] administrativeGenderCode, which SHALL be selected from ValueSet Administrative Gender (HL7 V3) urn:oid:2.16.840.1.113883.1.11.1 DYNAMIC (CONF:1198-6394).CONFdots6394
 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:1198-5298).

*MAY* be precise to the minute.

CONFdots5298
 Schematron assertrolered error 
 teststring-length(@value) >= 4 
 Message*SHALL* be precise to year. 
 Schematron assertroleorange warning 
 teststring-length(@value) >= 8 
 Message*SHOULD* 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 urn:oid:2.16.840.1.113883.1.11.12212 DYNAMIC (CONF:1198-5303).CONFdots5303
 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 urn:oid:2.16.840.1.113883.1.11.19185 DYNAMIC (CONF:1198-5317).CONFdots5317
 CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.1.11.19185 Religious Affiliation (DYNAMIC)
cda:raceCode
CE1 … 1MThis patient SHALL contain exactly one [1..1] raceCode, which SHALL be selected from ValueSet Race Category Excluding Nulls urn:oid:2.16.840.1.113883.3.2074.1.1.3 DYNAMIC (CONF:1198-5322).CONFdots5322
 CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.3.2074.1.1.3 Race Category Excluding Nulls (DYNAMIC)
sdtc:raceCode
CE0 … *This patient MAY contain zero or more [0..*] sdtc:raceCode, which SHALL be selected from ValueSet Race urn:oid:2.16.840.1.113883.1.11.14914 DYNAMIC (CONF:1198-7263).CONFdots7263
 CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.1.11.14914 Race (DYNAMIC)
 Schematron assertrolered error 
 testcount(../cda:raceCode)=1 
 MessageIf sdtc:raceCode is present, then the patient *SHALL* contain [[]1..1[]] raceCode. 
cda:ethnicGroupCode
CE1 … 1MThis patient SHALL contain exactly one [1..1] ethnicGroupCode, which SHALL be selected from ValueSet Ethnicity urn:oid:2.16.840.1.114222.4.11.837 DYNAMIC (CONF:1198-5323).CONFdots5323
 CONF
The value of @code shall be drawn from value set 2.16.840.1.114222.4.11.837 Ethnicity (DYNAMIC)
sdtc:ethnicGroupCode
CE0 … *This patient MAY contain zero or more [0..*] sdtc:ethnicGroupCode, which SHALL be selected from ValueSet Detailed Ethnicity urn:oid:2.16.840.1.114222.4.11.877 DYNAMIC (CONF:1198-32901).CONFdots2901
 CONF
The value of @code shall be drawn from value set 2.16.840.1.114222.4.11.877 Detailed Ethnicity (DYNAMIC)
cda:guardian
0 … *CONFdots5325
cda:code
CE0 … 1RThe guardian, if present, SHOULD contain zero or one [0..1] code, which SHALL be selected from ValueSet Personal And Legal Relationship Role Type urn:oid:2.16.840.1.113883.11.20.12.1 DYNAMIC (CONF:1198-5326).CONFdots5326
 CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.11.20.12.1 Personal And Legal Relationship Role Type (DYNAMIC)
cda:addr
AD0 … *RThe guardian, if present, SHOULD contain zero or more [0..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:1198-5359).CONFdots5359
Included from 2.16.840.1.113883.10.20.22.5.2 US Realm Address (AD.US.FIELDED) (2015‑08‑13)
cda:addr
USRedotsLDED
@nullFlavor
cs0 … 1 
@use
set_cs0 … 1 SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet PostalAddressUse urn:oid:2.16.840.1.113883.1.11.10637 STATIC 2005-05-01 (CONF:81-7290).CONFdots7290
 CONF
The value of @use shall be drawn from value set 2.16.840.1.113883.1.11.10637 PostalAddressUse (DYNAMIC)
 Constraint*SHALL NOT* have mixed content except for white space
 ConstraintIf the country is US, the state element is required 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).
cda:country
ADXP0 … 1RSHOULD contain zero or one [0..1] country, which SHALL be selected from ValueSet Country urn:oid:2.16.840.1.113883.3.88.12.80.63 DYNAMIC (CONF:81-7295).CONFdots7295
 CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.3.88.12.80.63 Country (DYNAMIC)
cda:state
ADXP0 … 1RSHOULD contain zero or one [0..1] state (ValueSet: StateValueSet urn:oid:2.16.840.1.113883.3.88.12.80.1 DYNAMIC) (CONF:81-7293).CONFdots7293
 ConstraintState is required if the country is US. 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).
 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 
 test@nullFlavor or (cda:country='US' and cda:state) or (cda:country!='US') or (not(cda:country) and cda:state) 
 MessageState is required if the country is US. 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. 
cda:city
ADXP1 … 1RSHALL contain exactly one [1..1] city (CONF:81-7292).CONFdots7292
cda:postalCode
ADXP0 … 1RSHOULD contain zero or one [0..1] postalCode, which SHOULD be selected from ValueSet PostalCode urn:oid:2.16.840.1.113883.3.88.12.80.2 DYNAMIC (CONF:81-7294). 
CONFdots7294
 ConstraintIf 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).
 CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.3.88.12.80.2 PostalCode (DYNAMIC)
 Schematron assertrolered error 
 test@nullFlavor or (cda:country='US' and cda:postalCode) or (cda:country!='US') or (not(cda:country) and cda:postalCode) 
 MessageIf 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). 
cda:streetAddressLine
ADXP1 … 4RCONFdots7291
 Schematron assertrolered error 
 test@nullFlavor or (count(cda:streetAddressLine) > 0 and count(cda:streetAddressLine) < 5) 
 MessageSHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291) 
 Schematron assertrolered error 
 test@nullFlavor or (cda:city and cda:streetAddressLine)  
 Message 
cda:telecom
TEL0 … *RThe guardian, if present, SHOULD contain zero or more [0..*] telecom (CONF:1198-5382).CONFdots5382
@use
set_cs0 … 1 The telecom, if present, SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet Telecom Use (US Realm Header) urn:oid:2.16.840.1.113883.11.20.9.20 DYNAMIC (CONF:1198-7993).CONFdots7993
 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 … 1Contains 2.16.840.1.113883.10.20.22.5.1.1 US Realm Person Name (PN.US.FIELDED) (2015‑08‑13)CONFdots5385
cda:birthplace
0 … 1This patient MAY contain zero or one [0..1] birthplace (CONF:1198-5395).CONFdots5395
cda:place
1 … 1MThe birthplace, if present, SHALL contain exactly one [1..1] place (CONF:1198-5396).CONFdots5396
cda:addr
AD1 … 1MThis place SHALL contain exactly one [1..1] addr (CONF:1198-5397).CONFdots5397
cda:country
ADXP0 … 1RThis addr SHOULD contain zero or one [0..1] country, which SHALL be selected from ValueSet Country urn:oid:2.16.840.1.113883.3.88.12.80.63 DYNAMIC (CONF:1198-5404).CONFdots5404
 CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.3.88.12.80.63 Country (DYNAMIC)
 Schematron assertrolered error 
 teststring-length(text())=2 
 MessageThe length of country text SHALL be equal to two digit 
cda:postalCode
ADXP0 … 1This addr MAY contain zero or one [0..1] postalCode, which SHALL be selected from ValueSet PostalCode urn:oid:2.16.840.1.113883.3.88.12.80.2 DYNAMIC (CONF:1198-5403).CONFdots5403
 CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.3.88.12.80.2 PostalCode (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 StateValueSet 2.16.840.1.113883.3.88.12.80.1 *DYNAMIC* 
cda:languageCommunication
0 … *RThis patient SHOULD contain zero or more [0..*] languageCommunication (CONF:1198-5406).CONFdots5406
cda:languageCode
CE1 … 1The languageCommunication, if present, SHALL contain exactly one [1..1] languageCode, which SHALL be selected from ValueSet Language urn:oid:2.16.840.1.113883.1.11.11526 DYNAMIC (CONF:1198-5407).CONFdots5407
 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 urn:oid:2.16.840.1.113883.1.11.12249 DYNAMIC (CONF:1198-5409).CONFdots5409
 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 urn:oid:2.16.840.1.113883.1.11.12199 DYNAMIC (CONF:1198-9965).CONFdots9965
 CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.1.11.12199 LanguageAbilityProficiency (DYNAMIC)
cda:preferenceInd
BL0 … 1RThe languageCommunication, if present, SHOULD contain zero or one [0..1] preferenceInd (CONF:1198-5414).CONFdots5414
Included from 2.16.840.1.113883.10.20.22.5.1 US Realm Patient Name (PTN.US.FIELDED) (DYNAMIC)
cda:name
USRedotsLDED
@nullFlavor
cs0 … 1 
@use
set_cs0 … 1 MAY contain zero or one [0..1] @use, which SHALL be selected from ValueSet EntityNameUse urn:oid:2.16.840.1.113883.1.11.15913 STATIC 2005-05-01 (CONF:81-7154).CONFdots7154
 CONF
The value of @use shall be drawn from value set 2.16.840.1.113883.1.11.15913 EntityNameUse (DYNAMIC)
 Constraint*SHALL NOT* have mixed content except for white space
cda:family
ST0 … 1CSHALL contain exactly one [1..1] family (CONF:81-7159).CONFdots7159
@qualifier
set_cs0 … 1 This family MAY contain zero or one [0..1] @qualifier, which SHALL be selected from ValueSet EntityPersonNamePartQualifier urn:oid:2.16.840.1.113883.11.20.9.26 STATIC 2011-09-30 (CONF:81-7160).CONFdots7160
 CONF
The value of @qualifier shall be drawn from value set 2.16.840.1.113883.11.20.9.26 EntityPersonNamePartQualifier (DYNAMIC)
cda:given
ST0 … *CSHALL contain at least one [1..*] given (CONF:81-7157).CONFdots7157
@qualifier
set_cs0 … 1 Such givens MAY contain zero or one [0..1] @qualifier, which SHALL be selected from ValueSet EntityPersonNamePartQualifier urn:oid:2.16.840.1.113883.11.20.9.26 STATIC 2011-09-30 (CONF:81-7158).CONFdots7158
 CONF
The value of @qualifier shall be drawn from value set 2.16.840.1.113883.11.20.9.26 EntityPersonNamePartQualifier (DYNAMIC)
 ConstraintThe second occurrence of given (given[2]) if provided, SHALL include middle name or middle initial
cda:prefix
ST0 … *MAY contain zero or more [0..*] prefix (CONF:81-7155).CONFdots7155
@qualifier
set_cs0 … 1 The prefix, if present, MAY contain zero or one [0..1] @qualifier, which SHALL be selected from ValueSet EntityPersonNamePartQualifier urn:oid:2.16.840.1.113883.11.20.9.26 STATIC 2011-09-30 (CONF:81-7156).CONFdots7156
 CONF
The value of @qualifier shall be drawn from value set 2.16.840.1.113883.11.20.9.26 EntityPersonNamePartQualifier (DYNAMIC)
cda:suffix
ST0 … 1MAY contain zero or one [0..1] suffix (CONF:81-7161).CONFdots7161
@qualifier
set_cs0 … 1 The suffix, if present, MAY contain zero or one [0..1] @qualifier, which SHALL be selected from ValueSet EntityPersonNamePartQualifier urn:oid:2.16.840.1.113883.11.20.9.26 STATIC 2011-09-30 (CONF:81-7162).CONFdots7162
 CONF
The value of @qualifier shall be drawn from value set 2.16.840.1.113883.11.20.9.26 EntityPersonNamePartQualifier (DYNAMIC)
 Schematron assertrolered error 
 test@nullFlavor or (cda:family and cda:given)  
 Messageif name is not null, then family and given elements are both required. 
Included from 2.16.840.1.113883.10.20.22.5.1 US Realm Patient Name (PTN.US.FIELDED) (DYNAMIC)
cda:name
USRedotsLDED
@nullFlavor
cs0 … 1 
@use
set_cs0 … 1 MAY contain zero or one [0..1] @use, which SHALL be selected from ValueSet EntityNameUse urn:oid:2.16.840.1.113883.1.11.15913 STATIC 2005-05-01 (CONF:81-7154).CONFdots7154
 CONF
The value of @use shall be drawn from value set 2.16.840.1.113883.1.11.15913 EntityNameUse (DYNAMIC)
 Constraint*SHALL NOT* have mixed content except for white space
cda:family
ST0 … 1CSHALL contain exactly one [1..1] family (CONF:81-7159).CONFdots7159
@qualifier
set_cs0 … 1 This family MAY contain zero or one [0..1] @qualifier, which SHALL be selected from ValueSet EntityPersonNamePartQualifier urn:oid:2.16.840.1.113883.11.20.9.26 STATIC 2011-09-30 (CONF:81-7160).CONFdots7160
 CONF
The value of @qualifier shall be drawn from value set 2.16.840.1.113883.11.20.9.26 EntityPersonNamePartQualifier (DYNAMIC)
cda:given
ST0 … *CSHALL contain at least one [1..*] given (CONF:81-7157).CONFdots7157
@qualifier
set_cs0 … 1 Such givens MAY contain zero or one [0..1] @qualifier, which SHALL be selected from ValueSet EntityPersonNamePartQualifier urn:oid:2.16.840.1.113883.11.20.9.26 STATIC 2011-09-30 (CONF:81-7158).CONFdots7158
 CONF
The value of @qualifier shall be drawn from value set 2.16.840.1.113883.11.20.9.26 EntityPersonNamePartQualifier (DYNAMIC)
 ConstraintThe second occurrence of given (given[2]) if provided, SHALL include middle name or middle initial
cda:prefix
ST0 … *MAY contain zero or more [0..*] prefix (CONF:81-7155).CONFdots7155
@qualifier
set_cs0 … 1 The prefix, if present, MAY contain zero or one [0..1] @qualifier, which SHALL be selected from ValueSet EntityPersonNamePartQualifier urn:oid:2.16.840.1.113883.11.20.9.26 STATIC 2011-09-30 (CONF:81-7156).CONFdots7156
 CONF
The value of @qualifier shall be drawn from value set 2.16.840.1.113883.11.20.9.26 EntityPersonNamePartQualifier (DYNAMIC)
cda:suffix
ST0 … 1MAY contain zero or one [0..1] suffix (CONF:81-7161).CONFdots7161
@qualifier
set_cs0 … 1 The suffix, if present, MAY contain zero or one [0..1] @qualifier, which SHALL be selected from ValueSet EntityPersonNamePartQualifier urn:oid:2.16.840.1.113883.11.20.9.26 STATIC 2011-09-30 (CONF:81-7162).CONFdots7162
 CONF
The value of @qualifier shall be drawn from value set 2.16.840.1.113883.11.20.9.26 EntityPersonNamePartQualifier (DYNAMIC)
 Schematron assertrolered error 
 test@nullFlavor or (cda:family and cda:given)  
 Messageif name is not null, then family and given elements are both required. 
cda:providerOrganization
0 … 1CONFdots5416
cda:id
II1 … *The providerOrganization, if present, SHALL contain at least one [1..*] id (CONF:1198-5417).CONFdots5417
@root
uid0 … 1 Such ids SHOULD contain zero or one [0..1] @root="2.16.840.1.113883.4.6" National Provider Identifier (CONF:1198-16820).CONFdots6820
cda:name
ON1 … *RThe providerOrganization, if present, SHALL contain at least one [1..*] name (CONF:1198-5419).CONFdots5419
cda:telecom
TEL1 … *The providerOrganization, if present, SHALL contain at least one [1..*] telecom (CONF:1198-5420).CONFdots5420
@use
set_cs0 … 1 Such telecoms SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet Telecom Use (US Realm Header) urn:oid:2.16.840.1.113883.11.20.9.20 DYNAMIC (CONF:1198-7994).CONFdots7994
 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 … *RThis providerOrganization, if present, SHALL contain at least one [1..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:1198-5422).CONFdots5422
Included from 2.16.840.1.113883.10.20.22.5.2 US Realm Address (AD.US.FIELDED) (2015‑08‑13)
cda:addr
USRedotsLDED
@nullFlavor
cs0 … 1 
@use
set_cs0 … 1 SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet PostalAddressUse urn:oid:2.16.840.1.113883.1.11.10637 STATIC 2005-05-01 (CONF:81-7290).CONFdots7290
 CONF
The value of @use shall be drawn from value set 2.16.840.1.113883.1.11.10637 PostalAddressUse (DYNAMIC)
 Constraint*SHALL NOT* have mixed content except for white space
 ConstraintIf the country is US, the state element is required 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).
cda:country
ADXP0 … 1RSHOULD contain zero or one [0..1] country, which SHALL be selected from ValueSet Country urn:oid:2.16.840.1.113883.3.88.12.80.63 DYNAMIC (CONF:81-7295).CONFdots7295
 CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.3.88.12.80.63 Country (DYNAMIC)
cda:state
ADXP0 … 1RSHOULD contain zero or one [0..1] state (ValueSet: StateValueSet urn:oid:2.16.840.1.113883.3.88.12.80.1 DYNAMIC) (CONF:81-7293).CONFdots7293
 ConstraintState is required if the country is US. 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).
 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 
 test@nullFlavor or (cda:country='US' and cda:state) or (cda:country!='US') or (not(cda:country) and cda:state) 
 MessageState is required if the country is US. 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. 
cda:city
ADXP1 … 1RSHALL contain exactly one [1..1] city (CONF:81-7292).CONFdots7292
cda:postalCode
ADXP0 … 1RSHOULD contain zero or one [0..1] postalCode, which SHOULD be selected from ValueSet PostalCode urn:oid:2.16.840.1.113883.3.88.12.80.2 DYNAMIC (CONF:81-7294). 
CONFdots7294
 ConstraintIf 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).
 CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.3.88.12.80.2 PostalCode (DYNAMIC)
 Schematron assertrolered error 
 test@nullFlavor or (cda:country='US' and cda:postalCode) or (cda:country!='US') or (not(cda:country) and cda:postalCode) 
 MessageIf 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). 
cda:streetAddressLine
ADXP1 … 4RCONFdots7291
 Schematron assertrolered error 
 test@nullFlavor or (count(cda:streetAddressLine) > 0 and count(cda:streetAddressLine) < 5) 
 MessageSHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291) 
 Schematron assertrolered error 
 test@nullFlavor or (cda:city and cda:streetAddressLine)  
 Message 
cda:author
1 … *MThe author element represents the creator of the clinical document. The author may be a device or a person. CONFdots5444
cda:assignedAuthor
1 … 1MCONFdots5448
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
CE0 … 1RThis assignedAuthor SHOULD contain zero or one [0..1] code (CONF:1198-16787).

Only if this assignedAuthor is an assignedPerson should the assignedAuthor contain a code.

CONFdots6787
cda:addr
AD1 … *This assignedAuthor SHALL contain at least one [1..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:1198-5452).CONFdots5452
Included from 2.16.840.1.113883.10.20.22.5.2 US Realm Address (AD.US.FIELDED) (2015‑08‑13)
cda:addr
USRedotsLDED
@nullFlavor
cs0 … 1 
@use
set_cs0 … 1 SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet PostalAddressUse urn:oid:2.16.840.1.113883.1.11.10637 STATIC 2005-05-01 (CONF:81-7290).CONFdots7290
 CONF
The value of @use shall be drawn from value set 2.16.840.1.113883.1.11.10637 PostalAddressUse (DYNAMIC)
 Constraint*SHALL NOT* have mixed content except for white space
 ConstraintIf the country is US, the state element is required 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).
cda:country
ADXP0 … 1RSHOULD contain zero or one [0..1] country, which SHALL be selected from ValueSet Country urn:oid:2.16.840.1.113883.3.88.12.80.63 DYNAMIC (CONF:81-7295).CONFdots7295
 CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.3.88.12.80.63 Country (DYNAMIC)
cda:state
ADXP0 … 1RSHOULD contain zero or one [0..1] state (ValueSet: StateValueSet urn:oid:2.16.840.1.113883.3.88.12.80.1 DYNAMIC) (CONF:81-7293).CONFdots7293
 ConstraintState is required if the country is US. 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).
 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 
 test@nullFlavor or (cda:country='US' and cda:state) or (cda:country!='US') or (not(cda:country) and cda:state) 
 MessageState is required if the country is US. 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. 
cda:city
ADXP1 … 1RSHALL contain exactly one [1..1] city (CONF:81-7292).CONFdots7292
cda:postalCode
ADXP0 … 1RSHOULD contain zero or one [0..1] postalCode, which SHOULD be selected from ValueSet PostalCode urn:oid:2.16.840.1.113883.3.88.12.80.2 DYNAMIC (CONF:81-7294). 
CONFdots7294
 ConstraintIf 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).
 CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.3.88.12.80.2 PostalCode (DYNAMIC)
 Schematron assertrolered error 
 test@nullFlavor or (cda:country='US' and cda:postalCode) or (cda:country!='US') or (not(cda:country) and cda:postalCode) 
 MessageIf 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). 
cda:streetAddressLine
ADXP1 … 4RCONFdots7291
 Schematron assertrolered error 
 test@nullFlavor or (count(cda:streetAddressLine) > 0 and count(cda:streetAddressLine) < 5) 
 MessageSHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291) 
 Schematron assertrolered error 
 test@nullFlavor or (cda:city and cda:streetAddressLine)  
 Message 
cda:telecom
TEL1 … *This assignedAuthor SHALL contain at least one [1..*] telecom (CONF:1198-5428).CONFdots5428
@use
set_cs0 … 1 Such telecoms SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet Telecom Use (US Realm Header) urn:oid:2.16.840.1.113883.11.20.9.20 DYNAMIC (CONF:1198-7995).CONFdots7995
 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
0 … 1RContains 2.16.840.1.113883.10.20.22.5.1.1 US Realm Person Name (PN.US.FIELDED) (2015‑08‑13)CONFdots5430
 ConstraintThis assignedAuthor SHOULD contain zero or one [0..1] assignedPerson (CONF:1198-5430).
cda:assignedAuthoringDevice
0 … 1RCONFdots6783
 ConstraintThis assignedAuthor SHOULD contain zero or one [0..1] assignedAuthoringDevice (CONF:1198-16783).
cda:manufacturerModelName
SC1 … 1RThe assignedAuthoringDevice, if present, SHALL contain exactly one [1..1] manufacturerModelName (CONF:1198-16784).CONFdots6784
cda:softwareName
SC1 … 1RThe assignedAuthoringDevice, if present, SHALL contain exactly one [1..1] softwareName (CONF:1198-16785).CONFdots6785
 Schematron assertrolered error 
 testcda:assignedPerson |cda:assignedAuthoringDevice 
 MessageThere *SHALL* be exactly one assignedAuthor/assignedPerson or exactly one assignedAuthor/assignedAuthoringDevice. 
cda:dataEnterer
0 … 1MAY contain zero or one [0..1] dataEnterer (CONF:1198-5441).

The dataEnterer element represents the person who transferred the content, written or dictated, into the clinical document. To clarify, an author provides the content found within the header or body of a document, subject to their own interpretation; a dataEnterer adds an author's information to the electronic system.

CONFdots5441
cda:assignedEntity
1 … 1MCONFdots5442
Choice1 … *
The assignedEntity SHALL contain at least one [1..*] id (CONF:1198-5417).
Elements to choose from:
  • cda:id
  • cda:id
cda:id
II0 … *CONFdots5417
cda:id
II0 … 1RCONFdots5417
@root
uid1 … 1F2.16.840.1.113883.4.6CONFdots6820
 Such ids SHOULD contain zero or one [0..1] @root="2.16.840.1.113883.4.6" National Provider Identifier (CONF:1198-16820).
cda:code
CE (extensible)0 … 1This assignedEntity MAY contain zero or one [0..1] code, which SHOULD be selected from ValueSet Healthcare Provider Taxonomy (HIPAA) urn:oid:2.16.840.1.114222.4.11.1066 DYNAMIC (CONF:1198-32173).CONFdots2173
 CONF
The value of @code should be drawn from value set 2.16.840.1.114222.4.11.1066 Healthcare Provider Taxonomy (DYNAMIC)
cda:addr
AD1 … *This assignedEntity SHALL contain at least one [1..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:1198-5460).CONFdots5460
Included from 2.16.840.1.113883.10.20.22.5.2 US Realm Address (AD.US.FIELDED) (2015‑08‑13)
cda:addr
USRedotsLDED
@nullFlavor
cs0 … 1 
@use
set_cs0 … 1 SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet PostalAddressUse urn:oid:2.16.840.1.113883.1.11.10637 STATIC 2005-05-01 (CONF:81-7290).CONFdots7290
 CONF
The value of @use shall be drawn from value set 2.16.840.1.113883.1.11.10637 PostalAddressUse (DYNAMIC)
 Constraint*SHALL NOT* have mixed content except for white space
 ConstraintIf the country is US, the state element is required 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).
cda:country
ADXP0 … 1RSHOULD contain zero or one [0..1] country, which SHALL be selected from ValueSet Country urn:oid:2.16.840.1.113883.3.88.12.80.63 DYNAMIC (CONF:81-7295).CONFdots7295
 CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.3.88.12.80.63 Country (DYNAMIC)
cda:state
ADXP0 … 1RSHOULD contain zero or one [0..1] state (ValueSet: StateValueSet urn:oid:2.16.840.1.113883.3.88.12.80.1 DYNAMIC) (CONF:81-7293).CONFdots7293
 ConstraintState is required if the country is US. 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).
 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 
 test@nullFlavor or (cda:country='US' and cda:state) or (cda:country!='US') or (not(cda:country) and cda:state) 
 MessageState is required if the country is US. 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. 
cda:city
ADXP1 … 1RSHALL contain exactly one [1..1] city (CONF:81-7292).CONFdots7292
cda:postalCode
ADXP0 … 1RSHOULD contain zero or one [0..1] postalCode, which SHOULD be selected from ValueSet PostalCode urn:oid:2.16.840.1.113883.3.88.12.80.2 DYNAMIC (CONF:81-7294). 
CONFdots7294
 ConstraintIf 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).
 CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.3.88.12.80.2 PostalCode (DYNAMIC)
 Schematron assertrolered error 
 test@nullFlavor or (cda:country='US' and cda:postalCode) or (cda:country!='US') or (not(cda:country) and cda:postalCode) 
 MessageIf 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). 
cda:streetAddressLine
ADXP1 … 4RCONFdots7291
 Schematron assertrolered error 
 test@nullFlavor or (count(cda:streetAddressLine) > 0 and count(cda:streetAddressLine) < 5) 
 MessageSHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291) 
 Schematron assertrolered error 
 test@nullFlavor or (cda:city and cda:streetAddressLine)  
 Message 
cda:telecom
TEL1 … *This assignedEntity SHALL contain at least one [1..*] telecom (CONF:1198-5466).CONFdots5466
@use
set_cs0 … 1 Such telecoms SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet Telecom Use (US Realm Header) urn:oid:2.16.840.1.113883.11.20.9.20 DYNAMIC (CONF:1198-7996).CONFdots7996
 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 … 1Contains 2.16.840.1.113883.10.20.22.5.1.1 US Realm Person Name (PN.US.FIELDED) (2015‑08‑13)CONFdots5469
cda:informant
0 … *MAY contain zero or more [0..*] informant (CONF:1198-8001) such that it

The informant element describes an information source for any content within the clinical document. This informant is constrained for use when the source of information is an assigned health care provider for the patient.

CONFdots8001
where [cda:assignedEntity]
cda:assignedEntity
1 … 1MCONFdots8002
cda:id
II1 … *This assignedEntity SHALL contain at least one [1..*] id (CONF:1198-9945).CONFdots9945
 ConstraintIf 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.
cda:code
CE (extensible)0 … 1This assignedEntity MAY contain zero or one [0..1] code, which SHOULD be selected from ValueSet Healthcare Provider Taxonomy (HIPAA) urn:oid:2.16.840.1.114222.4.11.1066 DYNAMIC (CONF:1198-32174).CONFdots2174
 CONF
The value of @code should be drawn from value set 2.16.840.1.114222.4.11.1066 Healthcare Provider Taxonomy (DYNAMIC)
cda:addr
AD1 … *This assignedEntity SHALL contain at least one [1..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:1198-8220).CONFdots8220
Included from 2.16.840.1.113883.10.20.22.5.2 US Realm Address (AD.US.FIELDED) (2015‑08‑13)
cda:addr
USRedotsLDED
@nullFlavor
cs0 … 1 
@use
set_cs0 … 1 SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet PostalAddressUse urn:oid:2.16.840.1.113883.1.11.10637 STATIC 2005-05-01 (CONF:81-7290).CONFdots7290
 CONF
The value of @use shall be drawn from value set 2.16.840.1.113883.1.11.10637 PostalAddressUse (DYNAMIC)
 Constraint*SHALL NOT* have mixed content except for white space
 ConstraintIf the country is US, the state element is required 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).
cda:country
ADXP0 … 1RSHOULD contain zero or one [0..1] country, which SHALL be selected from ValueSet Country urn:oid:2.16.840.1.113883.3.88.12.80.63 DYNAMIC (CONF:81-7295).CONFdots7295
 CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.3.88.12.80.63 Country (DYNAMIC)
cda:state
ADXP0 … 1RSHOULD contain zero or one [0..1] state (ValueSet: StateValueSet urn:oid:2.16.840.1.113883.3.88.12.80.1 DYNAMIC) (CONF:81-7293).CONFdots7293
 ConstraintState is required if the country is US. 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).
 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 
 test@nullFlavor or (cda:country='US' and cda:state) or (cda:country!='US') or (not(cda:country) and cda:state) 
 MessageState is required if the country is US. 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. 
cda:city
ADXP1 … 1RSHALL contain exactly one [1..1] city (CONF:81-7292).CONFdots7292
cda:postalCode
ADXP0 … 1RSHOULD contain zero or one [0..1] postalCode, which SHOULD be selected from ValueSet PostalCode urn:oid:2.16.840.1.113883.3.88.12.80.2 DYNAMIC (CONF:81-7294). 
CONFdots7294
 ConstraintIf 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).
 CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.3.88.12.80.2 PostalCode (DYNAMIC)
 Schematron assertrolered error 
 test@nullFlavor or (cda:country='US' and cda:postalCode) or (cda:country!='US') or (not(cda:country) and cda:postalCode) 
 MessageIf 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). 
cda:streetAddressLine
ADXP1 … 4RCONFdots7291
 Schematron assertrolered error 
 test@nullFlavor or (count(cda:streetAddressLine) > 0 and count(cda:streetAddressLine) < 5) 
 MessageSHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291) 
 Schematron assertrolered error 
 test@nullFlavor or (cda:city and cda:streetAddressLine)  
 Message 
cda:assignedPerson
1 … 1This assignedEntity SHALL contain exactly one [1..1] assignedPerson (CONF:1198-8221).
Contains 2.16.840.1.113883.10.20.22.5.1.1 US Realm Person Name (PN.US.FIELDED) (2015‑08‑13)
CONFdots8221
cda:informant
0 … *MAY contain zero or more [0..*] informant (CONF:1198-31355) such that it

The informant element describes an information source (who is not a provider) for any content within the clinical document. This informant would be used when the source of information has a personal relationship with the patient or is the patient.

CONFdots1355
where [cda:relatedEntity]
cda:relatedEntity
1 … 1SHALL contain exactly one [1..1] relatedEntity (CONF:1198-31356).CONFdots1356
cda:custodian
1 … 1MSHALL contain exactly one [1..1] custodian (CONF:1198-5519).

The custodian element represents the organization that is in charge of maintaining and is entrusted with the care of the document. There is only one custodian per CDA document. Allowing that a CDA document may not represent the original form of the authenticated document, the custodian represents the steward of the original source document. The custodian may be the document originator, a health information exchange, or other responsible party.

CONFdots5519
cda:assignedCustodian
1 … 1MThis custodian SHALL contain exactly one [1..1] assignedCustodian (CONF:1198-5520).CONFdots5520
cda:representedCustodianOrganization
1 … 1MCONFdots5521
cda:id
II1 … *This representedCustodianOrganization SHALL contain at least one [1..*] id (CONF:1198-5522).CONFdots5522
@root
uid0 … 1 Such ids SHOULD contain zero or one [0..1] @root="2.16.840.1.113883.4.6" National Provider Identifier (CONF:1198-16822).CONFdots6822
cda:name
ON1 … 1RThis representedCustodianOrganization SHALL contain exactly one [1..1] name (CONF:1198-5524).CONFdots5524
cda:telecom
TEL1 … 1This representedCustodianOrganization SHALL contain exactly one [1..1] telecom (CONF:1198-5525).CONFdots5525
@use
set_cs0 … 1 This telecom SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet Telecom Use (US Realm Header) urn:oid:2.16.840.1.113883.11.20.9.20 DYNAMIC (CONF:1198-7998).CONFdots7998
 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 … 1This representedCustodianOrganization SHALL contain exactly one [1..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:1198-5559).CONFdots5559
Included from 2.16.840.1.113883.10.20.22.5.2 US Realm Address (AD.US.FIELDED) (2015‑08‑13)
cda:addr
USRedotsLDED
@nullFlavor
cs0 … 1 
@use
set_cs0 … 1 SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet PostalAddressUse urn:oid:2.16.840.1.113883.1.11.10637 STATIC 2005-05-01 (CONF:81-7290).CONFdots7290
 CONF
The value of @use shall be drawn from value set 2.16.840.1.113883.1.11.10637 PostalAddressUse (DYNAMIC)
 Constraint*SHALL NOT* have mixed content except for white space
 ConstraintIf the country is US, the state element is required 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).
cda:country
ADXP0 … 1RSHOULD contain zero or one [0..1] country, which SHALL be selected from ValueSet Country urn:oid:2.16.840.1.113883.3.88.12.80.63 DYNAMIC (CONF:81-7295).CONFdots7295
 CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.3.88.12.80.63 Country (DYNAMIC)
cda:state
ADXP0 … 1RSHOULD contain zero or one [0..1] state (ValueSet: StateValueSet urn:oid:2.16.840.1.113883.3.88.12.80.1 DYNAMIC) (CONF:81-7293).CONFdots7293
 ConstraintState is required if the country is US. 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).
 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 
 test@nullFlavor or (cda:country='US' and cda:state) or (cda:country!='US') or (not(cda:country) and cda:state) 
 MessageState is required if the country is US. 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. 
cda:city
ADXP1 … 1RSHALL contain exactly one [1..1] city (CONF:81-7292).CONFdots7292
cda:postalCode
ADXP0 … 1RSHOULD contain zero or one [0..1] postalCode, which SHOULD be selected from ValueSet PostalCode urn:oid:2.16.840.1.113883.3.88.12.80.2 DYNAMIC (CONF:81-7294). 
CONFdots7294
 ConstraintIf 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).
 CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.3.88.12.80.2 PostalCode (DYNAMIC)
 Schematron assertrolered error 
 test@nullFlavor or (cda:country='US' and cda:postalCode) or (cda:country!='US') or (not(cda:country) and cda:postalCode) 
 MessageIf 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). 
cda:streetAddressLine
ADXP1 … 4RCONFdots7291
 Schematron assertrolered error 
 test@nullFlavor or (count(cda:streetAddressLine) > 0 and count(cda:streetAddressLine) < 5) 
 MessageSHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291) 
 Schematron assertrolered error 
 test@nullFlavor or (cda:city and cda:streetAddressLine)  
 Message 
cda:informationRecipient
0 … *MAY contain zero or more [0..*] informationRecipient (CONF:1198-5565).

The informationRecipient element records the intended recipient of the information at the time the document was created. In cases where the intended recipient of the document is the patient's health chart, set the receivedOrganization to the scoping organization for that chart.

CONFdots5565
cda:intendedRecipient
1 … 1MThe informationRecipient, if present, SHALL contain exactly one [1..1] intendedRecipient (CONF:1198-5566).CONFdots5566
cda:id
II0 … *This intendedRecipient MAY contain zero or more [0..*] id (CONF:1198-32399).CONFdots2399
cda:informationRecipient
0 … 1Contains 2.16.840.1.113883.10.20.22.5.1.1 US Realm Person Name (PN.US.FIELDED) (2015‑08‑13)CONFdots5567
cda:receivedOrganization
0 … 1This intendedRecipient MAY contain zero or one [0..1] receivedOrganization (CONF:1198-5577).CONFdots5577
cda:name
ON1 … 1RThe receivedOrganization, if present, SHALL contain exactly one [1..1] name (CONF:1198-5578).CONFdots5578
cda:legalAuthenticator
0 … 1RThe legalAuthenticator identifies the single person legally responsible for the document and must be present if the document has been legally authenticated. A clinical document that does not contain this element has not been legally authenticated. The act of legal authentication requires a certain privilege be granted to the legal authenticator depending upon local policy. Based on local practice, clinical documents may be released before legal authentication. All clinical documents have the potential for legal authentication, given the appropriate credentials. Local policies MAY choose to delegate the function of legal authentication to a device or system that generates the clinical document. In these cases, the legal authenticator is a person accepting responsibility for the document, not the generating device or system. Note that the legal authenticator, if present, must be a person.
Contains 2.16.840.1.113883.10.20.22.5.4 US Realm Date and Time (DTM.US.FIELDED) (2015‑08‑13)
CONFdots5579
cda:signatureCode
CS1 … 1MThe legalAuthenticator, if present, SHALL contain exactly one [1..1] signatureCode (CONF:1198-5583).CONFdots5583
@code
1 … 1FSCONFdots5584
 This signatureCode SHALL contain exactly one [1..1] @code="S" (CodeSystem: Participationsignature urn:oid:2.16.840.1.113883.5.89 STATIC) (CONF:1198-5584).
sdtc:signatureText
0 … 1The legalAuthenticator, if present, MAY contain zero or one [0..1] sdtc:signatureText (CONF:1198-30810).

The sdtc:signatureText extension provides a location in CDA for a textual or multimedia depiction of the signature by which the participant endorses and accepts responsibility for his or her participation in the Act as specified in the Participation.typeCode. Details of what goes in the field are described in the HL7 CDA Digital Signature Standard balloted in Fall of 2013.

CONFdots0810
cda:assignedEntity
1 … 1MCONFdots5585
cda:id
II1 … *This assignedEntity SHALL contain at least one [1..*] id (CONF:1198-5586).CONFdots5586
cda:code
CE (extensible)0 … 1This assignedEntity MAY contain zero or one [0..1] code, which SHOULD be selected from ValueSet Healthcare Provider Taxonomy (HIPAA) urn:oid:2.16.840.1.114222.4.11.1066 DYNAMIC (CONF:1198-17000).CONFdots7000
 CONF
The value of @code should be drawn from value set 2.16.840.1.114222.4.11.1066 Healthcare Provider Taxonomy (DYNAMIC)
cda:addr
AD1 … *This assignedEntity SHALL contain at least one [1..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:1198-5589).CONFdots5589
Included from 2.16.840.1.113883.10.20.22.5.2 US Realm Address (AD.US.FIELDED) (2015‑08‑13)
cda:addr
USRedotsLDED
@nullFlavor
cs0 … 1 
@use
set_cs0 … 1 SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet PostalAddressUse urn:oid:2.16.840.1.113883.1.11.10637 STATIC 2005-05-01 (CONF:81-7290).CONFdots7290
 CONF
The value of @use shall be drawn from value set 2.16.840.1.113883.1.11.10637 PostalAddressUse (DYNAMIC)
 Constraint*SHALL NOT* have mixed content except for white space
 ConstraintIf the country is US, the state element is required 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).
cda:country
ADXP0 … 1RSHOULD contain zero or one [0..1] country, which SHALL be selected from ValueSet Country urn:oid:2.16.840.1.113883.3.88.12.80.63 DYNAMIC (CONF:81-7295).CONFdots7295
 CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.3.88.12.80.63 Country (DYNAMIC)
cda:state
ADXP0 … 1RSHOULD contain zero or one [0..1] state (ValueSet: StateValueSet urn:oid:2.16.840.1.113883.3.88.12.80.1 DYNAMIC) (CONF:81-7293).CONFdots7293
 ConstraintState is required if the country is US. 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).
 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 
 test@nullFlavor or (cda:country='US' and cda:state) or (cda:country!='US') or (not(cda:country) and cda:state) 
 MessageState is required if the country is US. 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. 
cda:city
ADXP1 … 1RSHALL contain exactly one [1..1] city (CONF:81-7292).CONFdots7292
cda:postalCode
ADXP0 … 1RSHOULD contain zero or one [0..1] postalCode, which SHOULD be selected from ValueSet PostalCode urn:oid:2.16.840.1.113883.3.88.12.80.2 DYNAMIC (CONF:81-7294). 
CONFdots7294
 ConstraintIf 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).
 CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.3.88.12.80.2 PostalCode (DYNAMIC)
 Schematron assertrolered error 
 test@nullFlavor or (cda:country='US' and cda:postalCode) or (cda:country!='US') or (not(cda:country) and cda:postalCode) 
 MessageIf 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). 
cda:streetAddressLine
ADXP1 … 4RCONFdots7291
 Schematron assertrolered error 
 test@nullFlavor or (count(cda:streetAddressLine) > 0 and count(cda:streetAddressLine) < 5) 
 MessageSHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291) 
 Schematron assertrolered error 
 test@nullFlavor or (cda:city and cda:streetAddressLine)  
 Message 
cda:telecom
TEL1 … *This assignedEntity SHALL contain at least one [1..*] telecom (CONF:1198-5595).CONFdots5595
@use
set_cs0 … 1 Such telecoms SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet Telecom Use (US Realm Header) urn:oid:2.16.840.1.113883.11.20.9.20 DYNAMIC (CONF:1198-7999).CONFdots7999
 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 … 1Contains 2.16.840.1.113883.10.20.22.5.1.1 US Realm Person Name (PN.US.FIELDED) (2015‑08‑13)CONFdots5597
cda:authenticator
0 … *The authenticator identifies a participant or participants who attest to the accuracy of the information in the document.
Contains 2.16.840.1.113883.10.20.22.5.4 US Realm Date and Time (DTM.US.FIELDED) (2015‑08‑13)
CONFdots5607
cda:signatureCode
CS1 … 1MSHALL contain exactly one [1..1] signatureCode (CONF:1198-5610).CONFdots5610
@code
1 … 1FSCONFdots5611
 This signatureCode SHALL contain exactly one [1..1] @code="S" (CodeSystem: Participationsignature urn:oid:2.16.840.1.113883.5.89 STATIC) (CONF:1198-5611).
sdtc:signatureText
0 … 1MAY contain zero or one [0..1] sdtc:signatureText (CONF:1198-30811).

The sdtc:signatureText extension provides a location in CDA for a textual or multimedia depiction of the signature by which the participant endorses and accepts responsibility for his or her participation in the Act as specified in the Participation.typeCode. Details of what goes in the field are described in the HL7 CDA Digital Signature Standard balloted in Fall of 2013.

CONFdots0811
cda:assignedEntity
1 … 1MCONFdots5612
Choice1 … *
The assignedEntity SHALL contain at least one [1..*] id (CONF:1198-5613)
Elements to choose from:
  • cda:id
  • cda:id
cda:id
II0 … *CONFdots5417
cda:id
II0 … 1RCONFdots5417
@root
uid1 … 1F2.16.840.1.113883.4.6CONFdots6820
 Such ids SHOULD contain zero or one [0..1] @root="2.16.840.1.113883.4.6" National Provider Identifier (CONF:1198-16824).
cda:code
CE (extensible)0 … 1This assignedEntity MAY contain zero or one [0..1] code (CONF:1198-16825).CONFdots6825
cda:addr
AD1 … *This assignedEntity SHALL contain at least one [1..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:1198-5616).CONFdots5616
Included from 2.16.840.1.113883.10.20.22.5.2 US Realm Address (AD.US.FIELDED) (2015‑08‑13)
cda:addr
USRedotsLDED
@nullFlavor
cs0 … 1 
@use
set_cs0 … 1 SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet PostalAddressUse urn:oid:2.16.840.1.113883.1.11.10637 STATIC 2005-05-01 (CONF:81-7290).CONFdots7290
 CONF
The value of @use shall be drawn from value set 2.16.840.1.113883.1.11.10637 PostalAddressUse (DYNAMIC)
 Constraint*SHALL NOT* have mixed content except for white space
 ConstraintIf the country is US, the state element is required 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).
cda:country
ADXP0 … 1RSHOULD contain zero or one [0..1] country, which SHALL be selected from ValueSet Country urn:oid:2.16.840.1.113883.3.88.12.80.63 DYNAMIC (CONF:81-7295).CONFdots7295
 CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.3.88.12.80.63 Country (DYNAMIC)
cda:state
ADXP0 … 1RSHOULD contain zero or one [0..1] state (ValueSet: StateValueSet urn:oid:2.16.840.1.113883.3.88.12.80.1 DYNAMIC) (CONF:81-7293).CONFdots7293
 ConstraintState is required if the country is US. 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).
 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 
 test@nullFlavor or (cda:country='US' and cda:state) or (cda:country!='US') or (not(cda:country) and cda:state) 
 MessageState is required if the country is US. 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. 
cda:city
ADXP1 … 1RSHALL contain exactly one [1..1] city (CONF:81-7292).CONFdots7292
cda:postalCode
ADXP0 … 1RSHOULD contain zero or one [0..1] postalCode, which SHOULD be selected from ValueSet PostalCode urn:oid:2.16.840.1.113883.3.88.12.80.2 DYNAMIC (CONF:81-7294). 
CONFdots7294
 ConstraintIf 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).
 CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.3.88.12.80.2 PostalCode (DYNAMIC)
 Schematron assertrolered error 
 test@nullFlavor or (cda:country='US' and cda:postalCode) or (cda:country!='US') or (not(cda:country) and cda:postalCode) 
 MessageIf 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). 
cda:streetAddressLine
ADXP1 … 4RCONFdots7291
 Schematron assertrolered error 
 test@nullFlavor or (count(cda:streetAddressLine) > 0 and count(cda:streetAddressLine) < 5) 
 MessageSHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291) 
 Schematron assertrolered error 
 test@nullFlavor or (cda:city and cda:streetAddressLine)  
 Message 
cda:telecom
TEL1 … *This assignedEntity SHALL contain at least one [1..*] telecom (CONF:1198-5622).CONFdots5622
@use
set_cs0 … 1 Such telecoms SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet Telecom Use (US Realm Header) urn:oid:2.16.840.1.113883.11.20.9.20 DYNAMIC (CONF:1198-8000).CONFdots8000
 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 … 1Contains 2.16.840.1.113883.10.20.22.5.1.1 US Realm Person Name (PN.US.FIELDED) (2015‑08‑13)CONFdots5624
cda:participant
0 … *MAY contain zero or more [0..*] participant (CONF:1198-10003) such that it

The participant element identifies supporting entities, including parents, relatives, caregivers, insurance policyholders, guarantors, and others related in some way to the patient. A supporting person or organization is an individual or an organization with a relationship to the patient. A supporting person who is playing multiple roles would be recorded in multiple participants (e.g., emergency contact and next-of-kin).

CONFdots0003
 ConstraintWhen participant/@typeCode is *IND*, associatedEntity/@classCode *SHOULD* be selected from ValueSet 2.16.840.1.113883.11.20.9.33 INDRoleclassCodes *STATIC 2011-09-30*
cda:time
0 … 1MAY contain zero or one [0..1] time (CONF:1198-10004).CONFdots0004
 Schematron assertrolered error 
 testcda:associatedEntity/cda:associatedPerson | cda:associatedEntity/cda:scopingOrganization 
 Message*SHALL* contain associatedEntity/associatedPerson *AND/OR* associatedEntity/scopingOrganization. 
cda:inFulfillmentOf
0 … *MAY contain zero or more [0..*] inFulfillmentOf (CONF:1198-9952).

The inFulfillmentOf element represents orders that are fulfilled by this document such as a radiologists’ report of an x-ray.

CONFdots9952
cda:order
1 … 1MThe inFulfillmentOf, if present, SHALL contain exactly one [1..1] order (CONF:1198-9953).CONFdots9953
cda:id
II1 … *This order SHALL contain at least one [1..*] id (CONF:1198-9954).CONFdots9954
cda:documentationOf
0 … *MAY contain zero or more [0..*] documentationOf (CONF:1198-14835).CONFdots4835
cda:serviceEvent
1 … 1MThe documentationOf, if present, SHALL contain exactly one [1..1] serviceEvent (CONF:1198-14836).

A serviceEvent represents the main act being documented, such as a colonoscopy or a cardiac stress study. In a provision of healthcare serviceEvent, the care providers, PCP, or other longitudinal providers, are recorded within the serviceEvent. If the document is about a single encounter, the providers associated can be recorded in the componentOf/encompassingEncounter template.

CONFdots4836
cda:effectiveTime
1 … 1MThis serviceEvent SHALL contain exactly one [1..1] effectiveTime (CONF:1198-14837).CONFdots4837
cda:low
1 … 1RThis effectiveTime SHALL contain exactly one [1..1] low (CONF:1198-14838).CONFdots4838
cda:performer
0 … *RThe 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.

2) This serviceEvent SHOULD contain zero or more [0..*] performer (CONF:2212-14839).

1) The performer, if present, SHALL contain exactly one [1..1] @typeCode, which SHALL be selected from ValueSet x_ServiceEventPerformer urn:oid:2.16.840.1.113883.1.11.19601 STATIC (CONF:2212-14840).

2) The performer, if present, MAY contain zero or one [0..1] functionCode (CONF:2212-16818).

1) The functionCode, if present, SHOULD contain zero or one [0..1] @code, which SHOULD be selected from ValueSet ParticipationFunction urn:oid:2.16.840.1.113883.1.11.10267 STATIC (CONF:2212-32889).

3) The performer, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:2212-14841).

1) This assignedEntity SHALL contain at least one [1..*] id (CONF:2212-14846).

1) Such ids SHOULD contain zero or one [0..1] @root="2.16.840.1.113883.4.6" National Provider Identifier (CONF:2212-14847).

2) This assignedEntity SHOULD contain zero or one [0..1] code, which SHOULD be selected from ValueSet Healthcare Provider Taxonomy (HIPAA) urn:oid:2.16.840.1.114222.4.11.1066 DYNAMIC (CONF:2212-14842).
CONFdots4839
@typeCode
cs1 … 1RThe performer, if present, SHALL contain exactly one [1..1] @typeCode, which SHALL be selected from ValueSet x_ServiceEventPerformer urn:oid:2.16.840.1.113883.1.11.19601 STATIC (CONF:1198-14840).CONFdots4840
 CONF
The value of @typeCode shall be drawn from value set 2.16.840.1.113883.1.11.19601 x_ServiceEventPerformer (DYNAMIC)
cda:functionCode
CE (extensible)0 … 1The performer, if present, MAY contain zero or one [0..1] functionCode (CONF:1198-16818).CONFdots6818
@code
0 … 1 The functionCode, if present, SHOULD contain zero or one [0..1] @code, which SHOULD be selected from ValueSet ParticipationFunction urn:oid:2.16.840.1.113762.1.4.1099.30 DYNAMIC (CONF:1198-32889).CONFdots2889
 CONF
The value of @code should be drawn from value set 2.16.840.1.113762.1.4.1099.30 Care Team Member Function (DYNAMIC)
cda:assignedEntity
1 … 1The performer, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:1198-14841).CONFdots4841
cda:id
II1 … *This assignedEntity SHALL contain at least one [1..*] id (CONF:1198-14846).CONFdots4846
@root
uid0 … 1 Such ids SHOULD contain zero or one [0..1] @root="2.16.840.1.113883.4.6" National Provider Identifier (CONF:1198-14847).CONFdots4847
cda:code
CE (extensible)0 … 1RThis assignedEntity SHOULD contain zero or one [0..1] code, which SHOULD be selected from ValueSet Healthcare Provider Taxonomy (HIPAA) urn:oid:2.16.840.1.114222.4.11.1066 DYNAMIC (CONF:1198-14842).CONFdots4842
 CONF
The value of @code should be drawn from value set 2.16.840.1.114222.4.11.1066 Healthcare Provider Taxonomy (DYNAMIC)
 Schematron assertroleorange warning 
 testnot(@codeSystem) or @codeSystem='2.16.840.1.113883.6.101' 
 MessageThis 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) 
cda:authorization
0 … *MAY contain zero or more [0..*] authorization (CONF:1198-16792) such that it

The authorization element represents information about the patient’s consent. The type of consent is conveyed in consent/code. Consents in the header have been finalized (consent/statusCode must equal Completed) and should be on file. This specification does not address how 'Privacy Consent' is represented, but does not preclude the inclusion of ‘Privacy Consent’. The authorization consent is used for referring to consents that are documented elsewhere in the EHR or medical record for a health condition and/or treatment that is described in the CDA document.

CONFdots6792
cda:consent
1 … 1MSHALL contain exactly one [1..1] consent (CONF:1198-16793).CONFdots6793
cda:id
II0 … *This consent MAY contain zero or more [0..*] id (CONF:1198-16794).CONFdots6794
cda:code
0 … 1This consent MAY contain zero or one [0..1] code (CONF:1198-16795).CONFdots6795
cda:statusCode
CS1 … 1MThis consent SHALL contain exactly one [1..1] statusCode (CONF:1198-16797).CONFdots6797
@code
CONF1 … 1Fcompleted
cda:componentOf
0 … 1MAY contain zero or one [0..1] componentOf (CONF:1198-9955).

The encompassing encounter represents the setting of the clinical encounter during which the document act(s) or ServiceEvent(s) occurred. In order to represent providers associated with a specific encounter, they are recorded within the encompassingEncounter as participants. In a CCD, the encompassingEncounter may be used when documenting a specific encounter and its participants. All relevant encounters in a CCD may be listed in the encounters section.

CONFdots9955
cda:encompassingEncounter
1 … 1MThe componentOf, if present, SHALL contain exactly one [1..1] encompassingEncounter (CONF:1198-9956).CONFdots9956
cda:id
II1 … *This encompassingEncounter SHALL contain at least one [1..*] id (CONF:1198-9959).CONFdots9959
cda:effectiveTime
1 … 1This encompassingEncounter SHALL contain exactly one [1..1] effectiveTime (CONF:1198-9958).CONFdots9958

Template US Realm Header 2013‑01‑31

Id2.16.840.1.113883.10.20.22.1.1
ref
ccda-
Effective 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