Clinical Document Architecture V2.0.1
2.1.0 - CI Build
Clinical Document Architecture V2.0.1
2.1.0 - CI Build
Clinical Document Architecture V2.0.1, published by Health Level 7. This is not an authorized publication; it is the continuous build for version 2.1.0). This version is based on the current content of https://github.com/HL7/cda-core-2.0/ and changes regularly. See the Directory of published versions
JSON representation of the Patient logical model.
{
"resourceType" : "StructureDefinition",
"id" : "Patient",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n <p>A LivingSubject as a recipient of health care services from a healthcare provider.</p>\n <p>The patient is the player; the provider is the scoper.</p>\n </div>"
},
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace",
"valueUri" : "urn:hl7-org:v3"
}
],
"url" : "http://hl7.org/fhir/cda/StructureDefinition/Patient",
"version" : "2.1.0",
"name" : "CDAR2.Patient",
"title" : "Patient (CDA Class)",
"status" : "active",
"experimental" : false,
"date" : "2021-04-15T20:51:17+00:00",
"publisher" : "Health Level 7",
"description" : "A LivingSubject as a recipient of health care services from a healthcare provider.\nThe patient is the player; the provider is the scoper.",
"fhirVersion" : "4.0.1",
"kind" : "logical",
"abstract" : false,
"type" : "Patient",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/Base",
"derivation" : "specialization",
"snapshot" : {
"element" : [
{
"id" : "Patient",
"path" : "Patient",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Base",
"min" : 0,
"max" : "*"
},
"isModifier" : false
},
{
"id" : "Patient.classCode",
"path" : "Patient.classCode",
"representation" : [
"xmlAttr"
],
"min" : 1,
"max" : "1",
"base" : {
"path" : "Patient.classCode",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"defaultValueCode" : "PSN",
"fixedCode" : "PSN",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject"
}
},
{
"id" : "Patient.determinerCode",
"path" : "Patient.determinerCode",
"representation" : [
"xmlAttr"
],
"min" : 1,
"max" : "1",
"base" : {
"path" : "Patient.determinerCode",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"defaultValueCode" : "INSTANCE",
"fixedCode" : "INSTANCE",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-EntityDeterminer"
}
},
{
"id" : "Patient.templateId",
"path" : "Patient.templateId",
"definition" : "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Patient.templateId",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/II"
}
]
},
{
"id" : "Patient.id",
"path" : "Patient.id",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Patient.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/II"
}
]
},
{
"id" : "Patient.name",
"path" : "Patient.name",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Patient.name",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/EN"
}
]
},
{
"id" : "Patient.desc",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace",
"valueUri" : "urn:hl7-org:sdtc"
}
],
"path" : "Patient.desc",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Patient.desc",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/ED"
}
]
},
{
"id" : "Patient.administrativeGenderCode",
"path" : "Patient.administrativeGenderCode",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Patient.administrativeGenderCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/CE"
}
],
"binding" : {
"strength" : "extensible",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-AdministrativeGender"
}
},
{
"id" : "Patient.birthTime",
"path" : "Patient.birthTime",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Patient.birthTime",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/TS"
}
]
},
{
"id" : "Patient.deceasedInd",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace",
"valueUri" : "urn:hl7-org:sdtc"
}
],
"path" : "Patient.deceasedInd",
"short" : "sdtc:deceasedInd",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Patient.deceasedInd",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/BL"
}
]
},
{
"id" : "Patient.deceasedTime",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace",
"valueUri" : "urn:hl7-org:sdtc"
}
],
"path" : "Patient.deceasedTime",
"short" : "sdtc:deceasedTimed",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Patient.deceasedTime",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/TS"
}
]
},
{
"id" : "Patient.multipleBirthInd",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace",
"valueUri" : "urn:hl7-org:sdtc"
}
],
"path" : "Patient.multipleBirthInd",
"short" : "sdtc:multipleBirthInd",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Patient.multipleBirthInd",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/BL"
}
]
},
{
"id" : "Patient.multipleBirthOrderNumber",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace",
"valueUri" : "urn:hl7-org:sdtc"
}
],
"path" : "Patient.multipleBirthOrderNumber",
"short" : "sdtc:multipleBirthOrderNumber",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Patient.multipleBirthOrderNumber",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/INT-POS"
}
]
},
{
"id" : "Patient.maritalStatusCode",
"path" : "Patient.maritalStatusCode",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Patient.maritalStatusCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/CE"
}
],
"binding" : {
"strength" : "extensible",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-MaritalStatus"
}
},
{
"id" : "Patient.religiousAffiliationCode",
"path" : "Patient.religiousAffiliationCode",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Patient.religiousAffiliationCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/CE"
}
],
"binding" : {
"strength" : "extensible",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-ReligiousAffiliation"
}
},
{
"id" : "Patient.raceCode",
"path" : "Patient.raceCode",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Patient.raceCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/CE"
}
],
"binding" : {
"strength" : "extensible",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-Race"
}
},
{
"id" : "Patient.sdtcRaceCode",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace",
"valueUri" : "urn:hl7-org:sdtc"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-xml-name",
"valueString" : "raceCode"
}
],
"path" : "Patient.sdtcRaceCode",
"short" : "sdtcRaceCode",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Patient.sdtcRaceCode",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/CE"
}
],
"binding" : {
"strength" : "extensible",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-Race"
}
},
{
"id" : "Patient.ethnicGroupCode",
"path" : "Patient.ethnicGroupCode",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Patient.ethnicGroupCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/CE"
}
],
"binding" : {
"strength" : "extensible",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-Ethnicity"
}
},
{
"id" : "Patient.ethnicGroupCode",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace",
"valueUri" : "urn:hl7-org:sdtc"
}
],
"path" : "Patient.ethnicGroupCode",
"short" : "sdtc:ethnicGroupCode",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Patient.ethnicGroupCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/CE"
}
],
"binding" : {
"strength" : "extensible",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-Ethnicity"
}
},
{
"id" : "Patient.guardian",
"path" : "Patient.guardian",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Patient.guardian",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/Guardian"
}
]
},
{
"id" : "Patient.birthplace",
"path" : "Patient.birthplace",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Patient.birthplace",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/Birthplace"
}
]
},
{
"id" : "Patient.languageCommunication",
"path" : "Patient.languageCommunication",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Patient.languageCommunication",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/LanguageCommunication"
}
]
}
]
},
"differential" : {
"element" : [
{
"id" : "Patient",
"path" : "Patient",
"min" : 1,
"max" : "1"
},
{
"id" : "Patient.classCode",
"path" : "Patient.classCode",
"representation" : [
"xmlAttr"
],
"min" : 1,
"max" : "1",
"type" : [
{
"code" : "code"
}
],
"defaultValueCode" : "PSN",
"fixedCode" : "PSN",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject"
}
},
{
"id" : "Patient.determinerCode",
"path" : "Patient.determinerCode",
"representation" : [
"xmlAttr"
],
"min" : 1,
"max" : "1",
"type" : [
{
"code" : "code"
}
],
"defaultValueCode" : "INSTANCE",
"fixedCode" : "INSTANCE",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-EntityDeterminer"
}
},
{
"id" : "Patient.templateId",
"path" : "Patient.templateId",
"definition" : "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question",
"min" : 0,
"max" : "*",
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/II"
}
]
},
{
"id" : "Patient.id",
"path" : "Patient.id",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/II"
}
]
},
{
"id" : "Patient.name",
"path" : "Patient.name",
"min" : 0,
"max" : "*",
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/EN"
}
]
},
{
"id" : "Patient.desc",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace",
"valueUri" : "urn:hl7-org:sdtc"
}
],
"path" : "Patient.desc",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/ED"
}
]
},
{
"id" : "Patient.administrativeGenderCode",
"path" : "Patient.administrativeGenderCode",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/CE"
}
],
"binding" : {
"strength" : "extensible",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-AdministrativeGender"
}
},
{
"id" : "Patient.birthTime",
"path" : "Patient.birthTime",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/TS"
}
]
},
{
"id" : "Patient.deceasedInd",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace",
"valueUri" : "urn:hl7-org:sdtc"
}
],
"path" : "Patient.deceasedInd",
"short" : "sdtc:deceasedInd",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/BL"
}
]
},
{
"id" : "Patient.deceasedTime",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace",
"valueUri" : "urn:hl7-org:sdtc"
}
],
"path" : "Patient.deceasedTime",
"short" : "sdtc:deceasedTimed",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/TS"
}
]
},
{
"id" : "Patient.multipleBirthInd",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace",
"valueUri" : "urn:hl7-org:sdtc"
}
],
"path" : "Patient.multipleBirthInd",
"short" : "sdtc:multipleBirthInd",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/BL"
}
]
},
{
"id" : "Patient.multipleBirthOrderNumber",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace",
"valueUri" : "urn:hl7-org:sdtc"
}
],
"path" : "Patient.multipleBirthOrderNumber",
"short" : "sdtc:multipleBirthOrderNumber",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/INT-POS"
}
]
},
{
"id" : "Patient.maritalStatusCode",
"path" : "Patient.maritalStatusCode",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/CE"
}
],
"binding" : {
"strength" : "extensible",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-MaritalStatus"
}
},
{
"id" : "Patient.religiousAffiliationCode",
"path" : "Patient.religiousAffiliationCode",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/CE"
}
],
"binding" : {
"strength" : "extensible",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-ReligiousAffiliation"
}
},
{
"id" : "Patient.raceCode",
"path" : "Patient.raceCode",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/CE"
}
],
"binding" : {
"strength" : "extensible",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-Race"
}
},
{
"id" : "Patient.sdtcRaceCode",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace",
"valueUri" : "urn:hl7-org:sdtc"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-xml-name",
"valueString" : "raceCode"
}
],
"path" : "Patient.sdtcRaceCode",
"short" : "sdtcRaceCode",
"min" : 0,
"max" : "*",
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/CE"
}
],
"binding" : {
"strength" : "extensible",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-Race"
}
},
{
"id" : "Patient.ethnicGroupCode",
"path" : "Patient.ethnicGroupCode",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/CE"
}
],
"binding" : {
"strength" : "extensible",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-Ethnicity"
}
},
{
"id" : "Patient.ethnicGroupCode",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace",
"valueUri" : "urn:hl7-org:sdtc"
}
],
"path" : "Patient.ethnicGroupCode",
"short" : "sdtc:ethnicGroupCode",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/CE"
}
],
"binding" : {
"strength" : "extensible",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-Ethnicity"
}
},
{
"id" : "Patient.guardian",
"path" : "Patient.guardian",
"min" : 0,
"max" : "*",
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/Guardian"
}
]
},
{
"id" : "Patient.birthplace",
"path" : "Patient.birthplace",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/Birthplace"
}
]
},
{
"id" : "Patient.languageCommunication",
"path" : "Patient.languageCommunication",
"min" : 0,
"max" : "*",
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/LanguageCommunication"
}
]
}
]
}
}
IG © 2019+ Health Level 7. Package hl7.fhir.cda#2.1.0 based on FHIR 4.0.1. Generated 2021-04-15
Links: Table of Contents |
QA Report
| Version History 
|
|
Propose a change