Template

Show index

Template US Realm Patient Name (PTN.US.FIELDED) 2015‑08‑13

Id2.16.840.1.113883.10.20.22.5.1
ref
ccda-
Effective Date2015‑08‑13
Statusdraft DraftVersion Label2.1
NameUSRealmPatientNamePTNUSFIELDEDDisplay NameUS Realm Patient Name (PTN.US.FIELDED)
Description
The US Realm Patient Name datatype flavor is a set of reusable constraints that can be used for the patient or any other person. It requires a first (given) and last (family) name. If a patient or person has only one name part (e.g., patient with first name only) place the name part in the field required by the organization. Use the appropriate nullFlavor, "Not Applicable" (NA), in the other field. For information on mixed content see the Extensible Markup Language reference (http://www.w3c.org/TR/2008/REC-xml-20081126/).
ClassificationHL7 V2/V3 Datatype Level Template
Open/ClosedOpen (other than defined elements are allowed)
Used by / Uses
Used by 2 transactions and 4 templates, Uses 0 templates
Used by as NameVersion
2.16.840.1.113883.3.1937.99.3.4.33Transactionfinal US Realm Header (V3)2015‑08‑01
2.16.840.1.113883.3.1937.99.3.4.30Transactionfinal Referral Note (V2)2015‑08‑01
2.16.840.1.113883.10.20.22.1.1Includedraft US Realm Header (V3) (2.1)2015‑08‑01
2.16.840.1.113883.10.20.22.1.14Containmentdraft Referral Note (V2) (2.1)2015‑08‑01
2.16.840.1.113883.10.20.22.2.64Containmentdraft Drug Monitoring Act (2.1)2019‑03‑15 14:23:18
2.16.840.1.113883.10.20.22.2.101Containmentdraft BC CDA Referral Note (V2) (2.1)2019‑04‑06 02:03:17
ItemDTCardConfDescriptionLabel
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.