{
"description": "A History and Physical (H&P) note is a medical report that documents the current and past conditions of the patient. It contains essential information that helps determine an individual's health status. \\nThe first portion of the report is a current collection of organized information unique to an individual. This is typically supplied by the patient or the caregiver, concerning the current medical problem or the reason for the patient encounter. This information is followed by a description of any past or ongoing medical issues, including current medications and allergies. Information is also obtained about the patient's lifestyle, habits, and diseases among family members.\\nThe next portion of the report contains information obtained by physically examining the patient and gathering diagnostic information in the form of laboratory tests, imaging, or other diagnostic procedures. \\nThe report ends with the clinician's assessment of the patient's situation and the intended plan to address those issues. \\nA History and Physical Examination is required upon hospital admission as well as before operative procedures. An initial evaluation in an ambulatory setting is often documented in the form of an H&P note.\\n\\n#### Document Sections\\nAlthough document templates may contain any section, the following sections are specifically called out by this template:\\n\\n**Required Sections**\\n- [ChiefComplaintandReasonforVisitSection](StructureDefinition-ChiefComplaintandReasonforVisitSection.html) or both [ChiefComplaintSection](StructureDefinition-ChiefComplaintSection.html) and [ReasonforVisitSection](StructureDefinition-ReasonforVisitSection.html)\\n- [AssessmentandPlanSection](StructureDefinition-AssessmentandPlanSection.html) or both [AssessmentSection](StructureDefinition-AssessmentSection.html) and [PlanofTreatmentSection](StructureDefinition-PlanofTreatmentSection.html)\\n- [AllergiesAndIntolerancesSection](StructureDefinition-AllergiesAndIntolerancesSection.html)\\n- [FamilyHistorySection](StructureDefinition-FamilyHistorySection.html)\\n- [GeneralStatusSection](StructureDefinition-GeneralStatusSection.html)\\n- [PastMedicalHistory](StructureDefinition-PastMedicalHistory.html)\\n- [MedicationsSection](StructureDefinition-MedicationsSection.html)\\n- [PhysicalExamSection](StructureDefinition-PhysicalExamSection.html)\\n- [ResultsSection](StructureDefinition-ResultsSection.html)\\n- [ReviewofSystemsSection](StructureDefinition-ReviewofSystemsSection.html)\\n- [SocialHistorySection](StructureDefinition-SocialHistorySection.html)\\n- [VitalSignsSection](StructureDefinition-VitalSignsSection.html)\\n\\n**Recommended Sections**\\n- [HistoryofPresentIllnessSection](StructureDefinition-HistoryofPresentIllnessSection.html)\\n\\n**Additional Sections**\\n- [ImmunizationsSection](StructureDefinition-ImmunizationsSection.html)\\n- [InstructionsSection](StructureDefinition-InstructionsSection.html)\\n- [ProblemSection](StructureDefinition-ProblemSection.html)\\n- [ProceduresSection](StructureDefinition-ProceduresSection.html)\\n- [AdvanceDirectivesSection](StructureDefinition-AdvanceDirectivesSection.html)",
"_filename": "StructureDefinition-HistoryandPhysical.json",
"package_name": "hl7.cda.us.ccda",
"date": "2024-12-20T09:02:06+11:00",
"derivation": "constraint",
"publisher": "Health Level Seven",
"fhirVersion": "5.0.0",
"jurisdiction": [ {
"coding": [ {
"code": "US",
"system": "urn:iso:std:iso:3166"
} ]
} ],
"name": "HistoryandPhysical",
"mapping": [ {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
} ],
"abstract": false,
"type": "http://hl7.org/cda/stds/core/StructureDefinition/ClinicalDocument",
"experimental": null,
"resourceType": "StructureDefinition",
"title": "History and Physical",
"package_version": "4.0.0-ballot",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/logical-target",
"_valueBoolean": {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
"valueCode": "not-applicable"
} ]
}
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:v3"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "ClinicalDocument"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/type-profile-style",
"valueUri": "cda"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/logical-container",
"valueUri": "http://hl7.org/cda/stds/core/StructureDefinition/ClinicalDocument"
} ],
"snapshot": {
"element": [ {
"constraint": [ {
"key": "4537-6380",
"human": "If setId is present versionNumber **SHALL** be present (CONF:4537-6380).",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader",
"severity": "error",
"expression": "setId.exists() implies versionNumber.exists()"
}, {
"key": "4537-6387",
"human": "If versionNumber is present setId **SHALL** be present (CONF:4537-6387).",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader",
"severity": "error",
"expression": "versionNumber.exists() implies setId.exists()"
}, {
"key": "should-legalAuthenticator",
"human": "SHOULD contain legalAuthenticator",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader",
"severity": "warning",
"expression": "legalAuthenticator.exists()"
}, {
"key": "should-relatedParticipant",
"human": "Documents SHOULD contain a RelatedPerson participant",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader",
"severity": "warning",
"expression": "participant.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/RelatedPersonRelationshipAndNameParticipant').exists()"
}, {
"key": "category-34117-2",
"human": "If category is present, then there shall be a category with LOINC code '34117-2'.",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/HistoryandPhysical",
"severity": "error",
"expression": "sdtcCategory.empty() or sdtcCategory.exists(code = '34117-2' and codeSystem = '2.16.840.1.113883.6.1')"
} ],
"path": "ClinicalDocument",
"min": 1,
"definition": "Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.",
"isModifier": false,
"short": "Base for all types and resources",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"max": "1",
"id": "ClinicalDocument",
"base": {
"max": "*",
"min": 0,
"path": "Base"
}
}, {
"path": "ClinicalDocument.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.classCode",
"fixedCode": "DOCCLIN",
"min": 0,
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDAActClass"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.classCode",
"base": {
"max": "1",
"min": 0,
"path": "ClinicalDocument.classCode"
}
}, {
"path": "ClinicalDocument.moodCode",
"fixedCode": "EVN",
"min": 0,
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDAActMood"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.moodCode",
"base": {
"max": "1",
"min": 0,
"path": "ClinicalDocument.moodCode"
}
}, {
"id": "ClinicalDocument.realmCode",
"max": "1",
"min": 1,
"base": {
"max": "*",
"min": 0,
"path": "ClinicalDocument.realmCode"
},
"path": "ClinicalDocument.realmCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"comment": "SHALL contain exactly one [1..1] realmCode=\"US\" (CONF:4537-16791).",
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question"
}, {
"path": "ClinicalDocument.realmCode.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.realmCode.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.realmCode.code",
"min": 1,
"definition": "The plain code symbol defined by the code system. For example, \"784.0\" is the code symbol of the ICD-9 code \"784.0\" for headache.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"patternCode": "US",
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Code",
"id": "ClinicalDocument.realmCode.code",
"base": {
"max": "1",
"min": 0,
"path": "CD.code"
}
}, {
"path": "ClinicalDocument.realmCode.codeSystem",
"min": 0,
"definition": "Specifies the code system that defines the code.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "0",
"label": "Code System",
"id": "ClinicalDocument.realmCode.codeSystem",
"base": {
"max": "1",
"min": 0,
"path": "CD.codeSystem"
}
}, {
"path": "ClinicalDocument.realmCode.codeSystemName",
"min": 0,
"definition": "The common name of the coding system.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "0",
"label": "Code System Name",
"id": "ClinicalDocument.realmCode.codeSystemName",
"base": {
"max": "1",
"min": 0,
"path": "CD.codeSystemName"
}
}, {
"path": "ClinicalDocument.realmCode.codeSystemVersion",
"min": 0,
"definition": "If applicable, a version descriptor defined specifically for the given code system.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "0",
"label": "Code System Version",
"id": "ClinicalDocument.realmCode.codeSystemVersion",
"base": {
"max": "1",
"min": 0,
"path": "CD.codeSystemVersion"
}
}, {
"path": "ClinicalDocument.realmCode.displayName",
"min": 0,
"definition": "A name or title for the code, under which the sending system shows the code value to its users.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "0",
"label": "Display Name",
"id": "ClinicalDocument.realmCode.displayName",
"base": {
"max": "1",
"min": 0,
"path": "CD.displayName"
}
}, {
"path": "ClinicalDocument.realmCode.sdtcValueSet",
"min": 0,
"definition": "The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid" ]
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "valueSet"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.realmCode.sdtcValueSet",
"base": {
"max": "1",
"min": 0,
"path": "CD.valueSet"
}
}, {
"path": "ClinicalDocument.realmCode.sdtcValueSetVersion",
"min": 0,
"definition": "The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "valueSetVersion"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.realmCode.sdtcValueSetVersion",
"base": {
"max": "1",
"min": 0,
"path": "CD.sdtcValueSetVersion"
}
}, {
"id": "ClinicalDocument.realmCode.originalText",
"max": "0",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "CD.originalText"
},
"path": "ClinicalDocument.realmCode.originalText",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ED"
} ],
"label": "Original Text",
"definition": "The text or phrase used as the basis for the coding."
}, {
"id": "ClinicalDocument.realmCode.qualifier",
"max": "0",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "CD.qualifier"
},
"path": "ClinicalDocument.realmCode.qualifier",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CR"
} ],
"label": "Qualifier",
"definition": "Specifies additional codes that increase the specificity of the the primary code."
}, {
"path": "ClinicalDocument.realmCode.translation",
"min": 0,
"definition": "A set of other concept descriptors that translate this concept descriptor into other code systems.",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CD"
} ],
"representation": [ "typeAttr" ],
"max": "0",
"label": "Translation",
"id": "ClinicalDocument.realmCode.translation",
"base": {
"max": "*",
"min": 0,
"path": "CD.translation"
}
}, {
"constraint": [ {
"key": "II-1",
"human": "An II instance must have either a root or an nullFlavor.",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/ClinicalDocument",
"severity": "error",
"expression": "root.exists() or nullFlavor.exists()"
} ],
"path": "ClinicalDocument.typeId",
"min": 1,
"definition": "ClinicalDocument.typeId is a technology-neutral explicit reference to this CDA, Release Two specification, and must be valued as follows: ClinicalDocument.typeId.root = \"2.16.840.1.113883.1.3\" (which is the OID for HL7 Registered models); ClinicalDocument.typeId.extension = \"POCD_HD000040\" (which is the unique identifier for the CDA, Release Two Hierarchical Description).",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"max": "1",
"id": "ClinicalDocument.typeId",
"comment": "SHALL contain exactly one [1..1] typeId (CONF:4537-5361).",
"base": {
"max": "1",
"min": 0,
"path": "ClinicalDocument.typeId"
}
}, {
"path": "ClinicalDocument.typeId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.typeId.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.typeId.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "ClinicalDocument.typeId.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "ClinicalDocument.typeId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "ClinicalDocument.typeId.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "ClinicalDocument.typeId.root",
"min": 1,
"definition": "Identifies the type as an HL7 Registered model",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "2.16.840.1.113883.1.3",
"label": "Root",
"id": "ClinicalDocument.typeId.root",
"comment": "This typeId SHALL contain exactly one [1..1] @root=\"2.16.840.1.113883.1.3\" (CONF:4537-5250).",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "ClinicalDocument.typeId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "POCD_HD000040",
"label": "Extension",
"id": "ClinicalDocument.typeId.extension",
"comment": "This typeId SHALL contain exactly one [1..1] @extension=\"POCD_HD000040\" (CONF:4537-5251).",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "ClinicalDocument.templateId",
"max": "*",
"min": 2,
"base": {
"max": "*",
"min": 0,
"path": "ClinicalDocument.templateId"
},
"path": "ClinicalDocument.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "root",
"type": "value"
}, {
"path": "extension",
"type": "value"
} ]
},
"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"
}, {
"id": "ClinicalDocument.templateId:us-realm",
"max": "1",
"min": 1,
"base": {
"max": "*",
"min": 0,
"path": "ClinicalDocument.templateId"
},
"path": "ClinicalDocument.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"sliceName": "us-realm",
"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"
}, {
"path": "ClinicalDocument.templateId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.templateId:us-realm.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.templateId.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "ClinicalDocument.templateId:us-realm.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "ClinicalDocument.templateId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "ClinicalDocument.templateId:us-realm.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "ClinicalDocument.templateId.root",
"min": 1,
"definition": "A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"patternString": "2.16.840.1.113883.10.20.22.1.1",
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Root",
"id": "ClinicalDocument.templateId:us-realm.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "ClinicalDocument.templateId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"patternString": "2024-05-01",
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "ClinicalDocument.templateId:us-realm.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "ClinicalDocument.templateId:history-physical",
"max": "1",
"min": 1,
"base": {
"max": "*",
"min": 0,
"path": "ClinicalDocument.templateId"
},
"path": "ClinicalDocument.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"sliceName": "history-physical",
"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"
}, {
"path": "ClinicalDocument.templateId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.templateId:history-physical.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.templateId.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "ClinicalDocument.templateId:history-physical.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "ClinicalDocument.templateId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "ClinicalDocument.templateId:history-physical.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "ClinicalDocument.templateId.root",
"min": 1,
"definition": "A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"patternString": "2.16.840.1.113883.10.20.22.1.3",
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Root",
"id": "ClinicalDocument.templateId:history-physical.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "ClinicalDocument.templateId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"patternString": "2024-05-01",
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "ClinicalDocument.templateId:history-physical.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "ClinicalDocument.id",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "ClinicalDocument.id"
},
"path": "ClinicalDocument.id",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"short": "**SHALL** be a globally unique identifier for the document (CONF:4537-9991).",
"comment": "SHALL contain exactly one [1..1] id (CONF:4537-5363)."
}, {
"id": "ClinicalDocument.sdtcCategory",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "ClinicalDocument.sdtcCategory"
},
"path": "ClinicalDocument.sdtcCategory",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CD"
} ],
"short": "Used to categorize the document as a History and Physical. If present, there SHALL be a category of 34117-2 (History and physical note).",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "category"
} ]
}, {
"path": "ClinicalDocument.code",
"min": 1,
"short": "The H&P Note recommends use of a single document type code, 34117-2 \"History and physical note\", with further specification provided by author or performer, setting, or specialty. When pre-coordinated codes are used, any coded values describing the author or performer of the service act or the practice setting must be consistent with the LOINC document type.",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CE"
} ],
"binding": {
"strength": "required",
"valueSet": "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.20.22"
},
"max": "1",
"id": "ClinicalDocument.code",
"comment": "SHALL contain exactly one [1..1] code (CONF:1198-17185).",
"base": {
"max": "1",
"min": 1,
"path": "ClinicalDocument.code"
}
}, {
"path": "ClinicalDocument.code.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "0",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.code.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.code.code",
"min": 1,
"definition": "The plain code symbol defined by the code system. For example, \"784.0\" is the code symbol of the ICD-9 code \"784.0\" for headache.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Code",
"id": "ClinicalDocument.code.code",
"base": {
"max": "1",
"min": 0,
"path": "CD.code"
}
}, {
"path": "ClinicalDocument.code.codeSystem",
"min": 1,
"definition": "Specifies the code system that defines the code.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"patternString": "2.16.840.1.113883.6.1",
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Code System",
"id": "ClinicalDocument.code.codeSystem",
"base": {
"max": "1",
"min": 0,
"path": "CD.codeSystem"
}
}, {
"path": "ClinicalDocument.code.codeSystemName",
"min": 0,
"definition": "The common name of the coding system.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Code System Name",
"id": "ClinicalDocument.code.codeSystemName",
"base": {
"max": "1",
"min": 0,
"path": "CD.codeSystemName"
}
}, {
"path": "ClinicalDocument.code.codeSystemVersion",
"min": 0,
"definition": "If applicable, a version descriptor defined specifically for the given code system.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Code System Version",
"id": "ClinicalDocument.code.codeSystemVersion",
"base": {
"max": "1",
"min": 0,
"path": "CD.codeSystemVersion"
}
}, {
"path": "ClinicalDocument.code.displayName",
"min": 0,
"definition": "A name or title for the code, under which the sending system shows the code value to its users.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Display Name",
"id": "ClinicalDocument.code.displayName",
"base": {
"max": "1",
"min": 0,
"path": "CD.displayName"
}
}, {
"path": "ClinicalDocument.code.sdtcValueSet",
"min": 0,
"definition": "The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid" ]
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "valueSet"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.code.sdtcValueSet",
"base": {
"max": "1",
"min": 0,
"path": "CD.valueSet"
}
}, {
"path": "ClinicalDocument.code.sdtcValueSetVersion",
"min": 0,
"definition": "The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "valueSetVersion"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.code.sdtcValueSetVersion",
"base": {
"max": "1",
"min": 0,
"path": "CD.sdtcValueSetVersion"
}
}, {
"id": "ClinicalDocument.code.originalText",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "CD.originalText"
},
"path": "ClinicalDocument.code.originalText",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ED"
} ],
"label": "Original Text",
"definition": "The text or phrase used as the basis for the coding."
}, {
"id": "ClinicalDocument.code.qualifier",
"max": "0",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "CD.qualifier"
},
"path": "ClinicalDocument.code.qualifier",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CR"
} ],
"label": "Qualifier",
"definition": "Specifies additional codes that increase the specificity of the the primary code."
}, {
"path": "ClinicalDocument.code.translation",
"min": 0,
"definition": "A set of other concept descriptors that translate this concept descriptor into other code systems.",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CD"
} ],
"representation": [ "typeAttr" ],
"max": "*",
"label": "Translation",
"id": "ClinicalDocument.code.translation",
"base": {
"max": "*",
"min": 0,
"path": "CD.translation"
}
}, {
"id": "ClinicalDocument.title",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 0,
"path": "ClinicalDocument.title"
},
"path": "ClinicalDocument.title",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ST"
} ],
"short": "The title can either be a locally defined name or the displayName corresponding to clinicalDocument/code",
"comment": "SHALL contain exactly one [1..1] title (CONF:4537-5254)."
}, {
"path": "ClinicalDocument.sdtcStatusCode",
"min": 0,
"definition": "The statusCode extension attribute allows the implementer to identify a ClinicalDocument that is in other than the completed state. It was created to support the Structured Form Definition IG to identify that the document itself is an unfinished product currently being completed for a patient.",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "statusCode"
} ],
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-ActStatus"
},
"max": "1",
"id": "ClinicalDocument.sdtcStatusCode",
"base": {
"max": "1",
"min": 0,
"path": "ClinicalDocument.sdtcStatusCode"
}
}, {
"id": "ClinicalDocument.effectiveTime",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "ClinicalDocument.effectiveTime"
},
"path": "ClinicalDocument.effectiveTime",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/TS",
"profile": [ "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmDateTime" ]
} ],
"comment": "SHALL contain exactly one [1..1] US Realm Date and Time (Point in Time) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.4) (CONF:4537-5256)."
}, {
"id": "ClinicalDocument.confidentialityCode",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "ClinicalDocument.confidentialityCode"
},
"path": "ClinicalDocument.confidentialityCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CE"
} ]
}, {
"path": "ClinicalDocument.confidentialityCode.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "0",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.confidentialityCode.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.confidentialityCode.code",
"min": 1,
"definition": "The plain code symbol defined by the code system. For example, \"784.0\" is the code symbol of the ICD-9 code \"784.0\" for headache.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "preferred",
"valueSet": "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.16926"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Code",
"id": "ClinicalDocument.confidentialityCode.code",
"base": {
"max": "1",
"min": 0,
"path": "CD.code"
}
}, {
"path": "ClinicalDocument.confidentialityCode.codeSystem",
"min": 0,
"definition": "Specifies the code system that defines the code.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Code System",
"id": "ClinicalDocument.confidentialityCode.codeSystem",
"base": {
"max": "1",
"min": 0,
"path": "CD.codeSystem"
}
}, {
"path": "ClinicalDocument.confidentialityCode.codeSystemName",
"min": 0,
"definition": "The common name of the coding system.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Code System Name",
"id": "ClinicalDocument.confidentialityCode.codeSystemName",
"base": {
"max": "1",
"min": 0,
"path": "CD.codeSystemName"
}
}, {
"path": "ClinicalDocument.confidentialityCode.codeSystemVersion",
"min": 0,
"definition": "If applicable, a version descriptor defined specifically for the given code system.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Code System Version",
"id": "ClinicalDocument.confidentialityCode.codeSystemVersion",
"base": {
"max": "1",
"min": 0,
"path": "CD.codeSystemVersion"
}
}, {
"path": "ClinicalDocument.confidentialityCode.displayName",
"min": 0,
"definition": "A name or title for the code, under which the sending system shows the code value to its users.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Display Name",
"id": "ClinicalDocument.confidentialityCode.displayName",
"base": {
"max": "1",
"min": 0,
"path": "CD.displayName"
}
}, {
"path": "ClinicalDocument.confidentialityCode.sdtcValueSet",
"min": 0,
"definition": "The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid" ]
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "valueSet"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.confidentialityCode.sdtcValueSet",
"base": {
"max": "1",
"min": 0,
"path": "CD.valueSet"
}
}, {
"path": "ClinicalDocument.confidentialityCode.sdtcValueSetVersion",
"min": 0,
"definition": "The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "valueSetVersion"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.confidentialityCode.sdtcValueSetVersion",
"base": {
"max": "1",
"min": 0,
"path": "CD.sdtcValueSetVersion"
}
}, {
"id": "ClinicalDocument.confidentialityCode.originalText",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "CD.originalText"
},
"path": "ClinicalDocument.confidentialityCode.originalText",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ED"
} ],
"label": "Original Text",
"definition": "The text or phrase used as the basis for the coding."
}, {
"id": "ClinicalDocument.confidentialityCode.qualifier",
"max": "0",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "CD.qualifier"
},
"path": "ClinicalDocument.confidentialityCode.qualifier",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CR"
} ],
"label": "Qualifier",
"definition": "Specifies additional codes that increase the specificity of the the primary code."
}, {
"path": "ClinicalDocument.confidentialityCode.translation",
"min": 0,
"definition": "A set of other concept descriptors that translate this concept descriptor into other code systems.",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CD"
} ],
"representation": [ "typeAttr" ],
"max": "*",
"label": "Translation",
"id": "ClinicalDocument.confidentialityCode.translation",
"base": {
"max": "*",
"min": 0,
"path": "CD.translation"
}
}, {
"id": "ClinicalDocument.languageCode",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 0,
"path": "ClinicalDocument.languageCode"
},
"path": "ClinicalDocument.languageCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/all-languages"
},
"comment": "SHALL contain exactly one [1..1] languageCode, which SHALL be selected from ValueSet AllLanguages https://www.hl7.org/fhir/valueset-all-languages.html (OID 2.16.840.1.113883.4.642.3.21) DYNAMIC."
}, {
"id": "ClinicalDocument.setId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "ClinicalDocument.setId"
},
"path": "ClinicalDocument.setId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"comment": "MAY contain zero or one [0..1] setId (CONF:4537-5261)."
}, {
"id": "ClinicalDocument.versionNumber",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "ClinicalDocument.versionNumber"
},
"path": "ClinicalDocument.versionNumber",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/INT"
} ],
"comment": "MAY contain zero or one [0..1] versionNumber (CONF:4537-5264)."
}, {
"id": "ClinicalDocument.copyTime",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "ClinicalDocument.copyTime"
},
"path": "ClinicalDocument.copyTime",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/TS"
} ]
}, {
"id": "ClinicalDocument.recordTarget",
"max": "*",
"min": 1,
"base": {
"max": "*",
"min": 1,
"path": "ClinicalDocument.recordTarget"
},
"path": "ClinicalDocument.recordTarget",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/RecordTarget"
} ],
"short": "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",
"comment": "SHALL contain at least one [1..*] recordTarget (CONF:4537-5266)."
}, {
"path": "ClinicalDocument.recordTarget.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.recordTarget.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "ClinicalDocument.recordTarget.realmCode",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.realmCode"
},
"path": "ClinicalDocument.recordTarget.realmCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question"
}, {
"id": "ClinicalDocument.recordTarget.typeId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "InfrastructureRoot.typeId"
},
"path": "ClinicalDocument.recordTarget.typeId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"constraint": [ {
"key": "II-1",
"human": "An II instance must have either a root or an nullFlavor.",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot",
"severity": "error",
"expression": "root.exists() or nullFlavor.exists()"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question."
}, {
"path": "ClinicalDocument.recordTarget.typeId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.recordTarget.typeId.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.recordTarget.typeId.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "ClinicalDocument.recordTarget.typeId.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "ClinicalDocument.recordTarget.typeId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "ClinicalDocument.recordTarget.typeId.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "ClinicalDocument.recordTarget.typeId.root",
"min": 1,
"definition": "Identifies the type as an HL7 Registered model",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "2.16.840.1.113883.1.3",
"label": "Root",
"id": "ClinicalDocument.recordTarget.typeId.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "ClinicalDocument.recordTarget.typeId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "ClinicalDocument.recordTarget.typeId.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "ClinicalDocument.recordTarget.templateId",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
},
"path": "ClinicalDocument.recordTarget.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"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"
}, {
"path": "ClinicalDocument.recordTarget.typeCode",
"fixedCode": "RCT",
"min": 0,
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.recordTarget.typeCode",
"base": {
"max": "1",
"min": 0,
"path": "RecordTarget.typeCode"
}
}, {
"path": "ClinicalDocument.recordTarget.contextControlCode",
"fixedCode": "OP",
"min": 0,
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDAContextControl"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.recordTarget.contextControlCode",
"base": {
"max": "1",
"min": 0,
"path": "RecordTarget.contextControlCode"
}
}, {
"id": "ClinicalDocument.recordTarget.patientRole",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "RecordTarget.patientRole"
},
"path": "ClinicalDocument.recordTarget.patientRole",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/PatientRole"
} ],
"comment": "Such recordTargets SHALL contain exactly one [1..1] patientRole (CONF:4537-5267)."
}, {
"path": "ClinicalDocument.recordTarget.patientRole.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.recordTarget.patientRole.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "ClinicalDocument.recordTarget.patientRole.realmCode",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.realmCode"
},
"path": "ClinicalDocument.recordTarget.patientRole.realmCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question"
}, {
"id": "ClinicalDocument.recordTarget.patientRole.typeId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "InfrastructureRoot.typeId"
},
"path": "ClinicalDocument.recordTarget.patientRole.typeId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"constraint": [ {
"key": "II-1",
"human": "An II instance must have either a root or an nullFlavor.",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot",
"severity": "error",
"expression": "root.exists() or nullFlavor.exists()"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question."
}, {
"path": "ClinicalDocument.recordTarget.patientRole.typeId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.recordTarget.patientRole.typeId.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.typeId.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "ClinicalDocument.recordTarget.patientRole.typeId.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.typeId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "ClinicalDocument.recordTarget.patientRole.typeId.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.typeId.root",
"min": 1,
"definition": "Identifies the type as an HL7 Registered model",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "2.16.840.1.113883.1.3",
"label": "Root",
"id": "ClinicalDocument.recordTarget.patientRole.typeId.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.typeId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "ClinicalDocument.recordTarget.patientRole.typeId.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "ClinicalDocument.recordTarget.patientRole.templateId",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
},
"path": "ClinicalDocument.recordTarget.patientRole.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"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"
}, {
"path": "ClinicalDocument.recordTarget.patientRole.classCode",
"fixedCode": "PAT",
"min": 0,
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-RoleClassRelationshipFormal"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.classCode",
"base": {
"max": "1",
"min": 0,
"path": "PatientRole.classCode"
}
}, {
"id": "ClinicalDocument.recordTarget.patientRole.id",
"max": "*",
"min": 1,
"base": {
"max": "*",
"min": 1,
"path": "PatientRole.id"
},
"path": "ClinicalDocument.recordTarget.patientRole.id",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"comment": "This patientRole SHALL contain at least one [1..*] id (CONF:4537-5268)."
}, {
"id": "ClinicalDocument.recordTarget.patientRole.sdtcIdentifiedBy",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "PatientRole.sdtcIdentifiedBy"
},
"path": "ClinicalDocument.recordTarget.patientRole.sdtcIdentifiedBy",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "identifiedBy"
} ]
}, {
"path": "ClinicalDocument.recordTarget.patientRole.addr",
"min": 1,
"short": "𝗨𝗦𝗖𝗗𝗜: Address",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/AD",
"profile": [ "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress" ]
} ],
"extension": [ {
"url": "http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement",
"valueBoolean": true
} ],
"max": "*",
"id": "ClinicalDocument.recordTarget.patientRole.addr",
"comment": "This patientRole 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:4537-5271).",
"base": {
"max": "*",
"min": 0,
"path": "PatientRole.addr"
}
}, {
"constraint": [ {
"key": "should-use",
"human": "SHOULD contain @use",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader",
"severity": "warning",
"expression": "nullFlavor.exists() or use.exists()"
} ],
"path": "ClinicalDocument.recordTarget.patientRole.telecom",
"min": 1,
"short": "𝗨𝗦𝗖𝗗𝗜: Phone Number / Email",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/TEL"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement",
"valueBoolean": true
} ],
"max": "*",
"id": "ClinicalDocument.recordTarget.patientRole.telecom",
"base": {
"max": "*",
"min": 0,
"path": "PatientRole.telecom"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.telecom.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.recordTarget.patientRole.telecom.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "ClinicalDocument.recordTarget.patientRole.telecom.value",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "TEL.value"
},
"path": "ClinicalDocument.recordTarget.patientRole.telecom.value",
"type": [ {
"code": "url",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/url" ]
} ],
"representation": [ "xmlAttr" ]
}, {
"path": "ClinicalDocument.recordTarget.patientRole.telecom.useablePeriod",
"min": 0,
"definition": "Specifies the periods of time during which the telecommunication address can be used. For a telephone number, this can indicate the time of day in which the party can be reached on that telephone. For a web address, it may specify a time range in which the web content is promised to be available under the given address.",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS"
}, {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS"
}, {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS"
}, {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-defaulttype",
"valueCanonical": "http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS"
} ],
"representation": [ "typeAttr" ],
"max": "*",
"label": "Useable Period",
"id": "ClinicalDocument.recordTarget.patientRole.telecom.useablePeriod",
"base": {
"max": "*",
"min": 0,
"path": "TEL.useablePeriod"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.telecom.use",
"min": 0,
"definition": "One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.20"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Use Code",
"id": "ClinicalDocument.recordTarget.patientRole.telecom.use",
"comment": "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:4537-5375).",
"base": {
"max": "*",
"min": 0,
"path": "TEL.use"
}
}, {
"id": "ClinicalDocument.recordTarget.patientRole.patient",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 0,
"path": "PatientRole.patient"
},
"path": "ClinicalDocument.recordTarget.patientRole.patient",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Patient"
} ],
"comment": "This patientRole SHALL contain exactly one [1..1] patient (CONF:4537-5283).",
"constraint": [ {
"key": "4537-32993",
"human": "If sdtc:deceasedInd=\"true\", then sdtc:deceasedTime **SHALL** be present with either a @value or @nullFlavor=UNK (CONF:4537-32993).",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader",
"severity": "error",
"expression": "sdtcDeceasedInd.exists(value='true') implies sdtcDeceasedTime.exists()"
}, {
"key": "4537-21000",
"human": "If sdtc:deceasedTime/@value is present, then sdtc:deceasedInd SHALL be present with value=true",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader",
"severity": "error",
"expression": "sdtcDeceasedTime.value.exists() implies sdtcDeceasedInd.exists(value='true')"
}, {
"key": "should-maritalStatusCode",
"human": "SHOULD contain maritalStatusCode",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader",
"severity": "warning",
"expression": "maritalStatusCode.exists()"
}, {
"key": "should-us-languageCommunication",
"human": "SHOULD contain languageCommunication",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader",
"severity": "warning",
"expression": "languageCommunication.exists()"
} ]
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.recordTarget.patientRole.patient.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "ClinicalDocument.recordTarget.patientRole.patient.realmCode",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.realmCode"
},
"path": "ClinicalDocument.recordTarget.patientRole.patient.realmCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question"
}, {
"id": "ClinicalDocument.recordTarget.patientRole.patient.typeId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "InfrastructureRoot.typeId"
},
"path": "ClinicalDocument.recordTarget.patientRole.patient.typeId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"constraint": [ {
"key": "II-1",
"human": "An II instance must have either a root or an nullFlavor.",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot",
"severity": "error",
"expression": "root.exists() or nullFlavor.exists()"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question."
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.typeId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.recordTarget.patientRole.patient.typeId.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.typeId.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "ClinicalDocument.recordTarget.patientRole.patient.typeId.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.typeId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "ClinicalDocument.recordTarget.patientRole.patient.typeId.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.typeId.root",
"min": 1,
"definition": "Identifies the type as an HL7 Registered model",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "2.16.840.1.113883.1.3",
"label": "Root",
"id": "ClinicalDocument.recordTarget.patientRole.patient.typeId.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.typeId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "ClinicalDocument.recordTarget.patientRole.patient.typeId.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "ClinicalDocument.recordTarget.patientRole.patient.templateId",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
},
"path": "ClinicalDocument.recordTarget.patientRole.patient.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"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"
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.classCode",
"fixedCode": "PSN",
"min": 0,
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.patient.classCode",
"base": {
"max": "1",
"min": 0,
"path": "Patient.classCode"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.determinerCode",
"fixedCode": "INSTANCE",
"min": 0,
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-EntityDeterminer"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.patient.determinerCode",
"base": {
"max": "1",
"min": 0,
"path": "Patient.determinerCode"
}
}, {
"id": "ClinicalDocument.recordTarget.patientRole.patient.id",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "Patient.id"
},
"path": "ClinicalDocument.recordTarget.patientRole.patient.id",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ]
}, {
"id": "ClinicalDocument.recordTarget.patientRole.patient.name",
"max": "*",
"min": 1,
"base": {
"max": "*",
"min": 0,
"path": "Patient.name"
},
"path": "ClinicalDocument.recordTarget.patientRole.patient.name",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/PN",
"profile": [ "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPatientNamePTNUSFIELDED" ]
} ],
"comment": "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) (CONF:4537-5284)."
}, {
"id": "ClinicalDocument.recordTarget.patientRole.patient.sdtcDesc",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "Patient.sdtcDesc"
},
"path": "ClinicalDocument.recordTarget.patientRole.patient.sdtcDesc",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ED"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "desc"
} ],
"definition": "The desc extension allows multimedia depictions of patients, healthcare providers, or other individuals to be included in a CDA document."
}, {
"id": "ClinicalDocument.recordTarget.patientRole.patient.administrativeGenderCode",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 0,
"path": "Patient.administrativeGenderCode"
},
"path": "ClinicalDocument.recordTarget.patientRole.patient.administrativeGenderCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CE"
} ],
"binding": {
"strength": "required",
"valueSet": "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.1"
},
"comment": "This 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:4537-6394)."
}, {
"constraint": [ {
"key": "ts-shall-year",
"human": "**SHALL** be precise to at least the year",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader",
"severity": "error",
"expression": "nullFlavor.exists() or value.toString().length() >= 4"
}, {
"key": "ts-should-day",
"human": "**SHOULD** be precise to at least the day",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader",
"severity": "warning",
"expression": "nullFlavor.exists() or value.toString().length() >= 10"
} ],
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthTime",
"min": 1,
"short": "𝗨𝗦𝗖𝗗𝗜: Date of Birth - **MAY** be precise to the minute (CONF:4537-32418) (For cases where information about newborn's time of birth needs to be captured)",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/TS"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement",
"valueBoolean": true
} ],
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthTime",
"comment": "This patient SHALL contain exactly one [1..1] birthTime (CONF:4537-5298).",
"base": {
"max": "1",
"min": 0,
"path": "Patient.birthTime"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.sdtcDeceasedInd",
"min": 0,
"short": "sdtc:deceasedInd",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/BL"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "deceasedInd"
} ],
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.patient.sdtcDeceasedInd",
"comment": "This patient MAY contain zero or one [0..1] sdtc:deceasedInd (CONF:4537-32990).",
"base": {
"max": "1",
"min": 0,
"path": "Patient.sdtcDeceasedInd"
}
}, {
"constraint": [ {
"key": "should-value-att",
"human": "SHOULD contain @value",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader",
"severity": "warning",
"expression": "value.exists()"
}, {
"key": "ts-shall-year",
"human": "**SHALL** be precise to at least the year",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader",
"severity": "error",
"expression": "nullFlavor.exists() or value.toString().length() >= 4"
}, {
"key": "ts-should-day",
"human": "**SHOULD** be precise to at least the day",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader",
"severity": "warning",
"expression": "nullFlavor.exists() or value.toString().length() >= 10"
} ],
"path": "ClinicalDocument.recordTarget.patientRole.patient.sdtcDeceasedTime",
"min": 0,
"short": "𝗨𝗦𝗖𝗗𝗜: Date of Death",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/TS"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "deceasedTime"
}, {
"url": "http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement",
"valueBoolean": true
} ],
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.patient.sdtcDeceasedTime",
"comment": "This patient MAY contain zero or one [0..1] sdtc:deceasedTime (CONF:4537-32988).",
"base": {
"max": "1",
"min": 0,
"path": "Patient.sdtcDeceasedTime"
}
}, {
"id": "ClinicalDocument.recordTarget.patientRole.patient.sdtcMultipleBirthInd",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "Patient.sdtcMultipleBirthInd"
},
"path": "ClinicalDocument.recordTarget.patientRole.patient.sdtcMultipleBirthInd",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/BL"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "multipleBirthInd"
} ]
}, {
"id": "ClinicalDocument.recordTarget.patientRole.patient.sdtcMultipleBirthOrderNumber",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "Patient.sdtcMultipleBirthOrderNumber"
},
"path": "ClinicalDocument.recordTarget.patientRole.patient.sdtcMultipleBirthOrderNumber",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/INT-POS"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "multipleBirthOrderNumber"
} ]
}, {
"id": "ClinicalDocument.recordTarget.patientRole.patient.maritalStatusCode",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "Patient.maritalStatusCode"
},
"path": "ClinicalDocument.recordTarget.patientRole.patient.maritalStatusCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CE"
} ],
"binding": {
"strength": "required",
"valueSet": "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.12212"
},
"comment": "This 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:4537-5303)."
}, {
"id": "ClinicalDocument.recordTarget.patientRole.patient.religiousAffiliationCode",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "Patient.religiousAffiliationCode"
},
"path": "ClinicalDocument.recordTarget.patientRole.patient.religiousAffiliationCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CE"
} ],
"binding": {
"strength": "required",
"valueSet": "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.19185"
},
"comment": "This 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:4537-5317)."
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.raceCode",
"min": 1,
"short": "𝗨𝗦𝗖𝗗𝗜: Race",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CE"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement",
"valueBoolean": true
} ],
"binding": {
"strength": "required",
"valueSet": "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.2074.1.1.3"
},
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.patient.raceCode",
"comment": "This 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:4537-5322).",
"base": {
"max": "1",
"min": 0,
"path": "Patient.raceCode"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCode",
"min": 0,
"short": "𝗨𝗦𝗖𝗗𝗜: Race - The sdtc:raceCode is only used to record additional values when the patient has indicated multiple races or additional race detail beyond the five categories required for Meaningful Use Stage 2. The prefix sdtc: SHALL be bound to the namespace “urn:hl7-org:sdtc”. The use of the namespace provides a necessary extension to CDA R2 for the use of the additional raceCode elements.",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CE"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "raceCode"
}, {
"url": "http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement",
"valueBoolean": true
} ],
"binding": {
"strength": "required",
"valueSet": "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.14914"
},
"max": "*",
"id": "ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCode",
"comment": "This patient MAY contain zero or more [0..*] sdtc:raceCode, which SHALL be selected from ValueSet Race Value Set urn:oid:2.16.840.1.113883.1.11.14914 DYNAMIC (CONF:4537-7263).",
"base": {
"max": "*",
"min": 0,
"path": "Patient.sdtcRaceCode"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.ethnicGroupCode",
"min": 1,
"short": "𝗨𝗦𝗖𝗗𝗜: Ethnicity",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CE"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement",
"valueBoolean": true
} ],
"binding": {
"strength": "required",
"valueSet": "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.837"
},
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.patient.ethnicGroupCode",
"comment": "This 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:4537-5323).",
"base": {
"max": "1",
"min": 0,
"path": "Patient.ethnicGroupCode"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.sdtcEthnicGroupCode",
"min": 0,
"short": "𝗨𝗦𝗖𝗗𝗜: Ethnicity",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CE"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "ethnicGroupCode"
}, {
"url": "http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement",
"valueBoolean": true
} ],
"binding": {
"strength": "required",
"valueSet": "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.877"
},
"max": "*",
"id": "ClinicalDocument.recordTarget.patientRole.patient.sdtcEthnicGroupCode",
"comment": "This patient MAY contain zero or more [0..*] ethnicGroupCode, which SHALL be selected from ValueSet Detailed Ethnicity urn:oid:2.16.840.1.114222.4.11.877 DYNAMIC (CONF:4537-32901).",
"base": {
"max": "*",
"min": 0,
"path": "Patient.sdtcEthnicGroupCode"
}
}, {
"id": "ClinicalDocument.recordTarget.patientRole.patient.guardian",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "Patient.guardian"
},
"path": "ClinicalDocument.recordTarget.patientRole.patient.guardian",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Guardian"
} ],
"comment": "This patient MAY contain zero or more [0..*] guardian (CONF:4537-5325).",
"constraint": [ {
"key": "should-us-code",
"human": "SHOULD contain code",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader",
"severity": "warning",
"expression": "code.exists()"
}, {
"key": "should-us-addr",
"human": "SHOULD contain addr",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader",
"severity": "warning",
"expression": "addr.exists()"
}, {
"key": "should-us-telecom",
"human": "SHOULD contain telecom",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader",
"severity": "warning",
"expression": "telecom.exists()"
} ]
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.guardian.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.recordTarget.patientRole.patient.guardian.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "ClinicalDocument.recordTarget.patientRole.patient.guardian.realmCode",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.realmCode"
},
"path": "ClinicalDocument.recordTarget.patientRole.patient.guardian.realmCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question"
}, {
"id": "ClinicalDocument.recordTarget.patientRole.patient.guardian.typeId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "InfrastructureRoot.typeId"
},
"path": "ClinicalDocument.recordTarget.patientRole.patient.guardian.typeId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"constraint": [ {
"key": "II-1",
"human": "An II instance must have either a root or an nullFlavor.",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot",
"severity": "error",
"expression": "root.exists() or nullFlavor.exists()"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question."
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.guardian.typeId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.recordTarget.patientRole.patient.guardian.typeId.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.guardian.typeId.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "ClinicalDocument.recordTarget.patientRole.patient.guardian.typeId.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.guardian.typeId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "ClinicalDocument.recordTarget.patientRole.patient.guardian.typeId.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.guardian.typeId.root",
"min": 1,
"definition": "Identifies the type as an HL7 Registered model",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "2.16.840.1.113883.1.3",
"label": "Root",
"id": "ClinicalDocument.recordTarget.patientRole.patient.guardian.typeId.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.guardian.typeId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "ClinicalDocument.recordTarget.patientRole.patient.guardian.typeId.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "ClinicalDocument.recordTarget.patientRole.patient.guardian.templateId",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
},
"path": "ClinicalDocument.recordTarget.patientRole.patient.guardian.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"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"
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.guardian.classCode",
"fixedCode": "GUARD",
"min": 0,
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-RoleClassAgent"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.patient.guardian.classCode",
"base": {
"max": "1",
"min": 0,
"path": "Guardian.classCode"
}
}, {
"id": "ClinicalDocument.recordTarget.patientRole.patient.guardian.id",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "Guardian.id"
},
"path": "ClinicalDocument.recordTarget.patientRole.patient.guardian.id",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ]
}, {
"id": "ClinicalDocument.recordTarget.patientRole.patient.guardian.sdtcIdentifiedBy",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "Guardian.sdtcIdentifiedBy"
},
"path": "ClinicalDocument.recordTarget.patientRole.patient.guardian.sdtcIdentifiedBy",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "identifiedBy"
} ]
}, {
"id": "ClinicalDocument.recordTarget.patientRole.patient.guardian.code",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "Guardian.code"
},
"path": "ClinicalDocument.recordTarget.patientRole.patient.guardian.code",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CE"
} ],
"binding": {
"strength": "required",
"valueSet": "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.12.1"
},
"comment": "The 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:4537-5326)."
}, {
"id": "ClinicalDocument.recordTarget.patientRole.patient.guardian.addr",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "Guardian.addr"
},
"path": "ClinicalDocument.recordTarget.patientRole.patient.guardian.addr",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/AD",
"profile": [ "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress" ]
} ],
"comment": "The 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:4537-5359)."
}, {
"id": "ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "Guardian.telecom"
},
"path": "ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/TEL"
} ],
"comment": "The guardian, if present, SHOULD contain zero or more [0..*] telecom (CONF:4537-5382).",
"constraint": [ {
"key": "should-use",
"human": "SHOULD contain @use",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader",
"severity": "warning",
"expression": "nullFlavor.exists() or use.exists()"
} ]
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom.value",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "TEL.value"
},
"path": "ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom.value",
"type": [ {
"code": "url",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/url" ]
} ],
"representation": [ "xmlAttr" ]
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom.useablePeriod",
"min": 0,
"definition": "Specifies the periods of time during which the telecommunication address can be used. For a telephone number, this can indicate the time of day in which the party can be reached on that telephone. For a web address, it may specify a time range in which the web content is promised to be available under the given address.",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS"
}, {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS"
}, {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS"
}, {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-defaulttype",
"valueCanonical": "http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS"
} ],
"representation": [ "typeAttr" ],
"max": "*",
"label": "Useable Period",
"id": "ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom.useablePeriod",
"base": {
"max": "*",
"min": 0,
"path": "TEL.useablePeriod"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom.use",
"min": 0,
"definition": "One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.20"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Use Code",
"id": "ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom.use",
"comment": "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:4537-7993).",
"base": {
"max": "*",
"min": 0,
"path": "TEL.use"
}
}, {
"id": "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 0,
"path": "Guardian.guardianPerson"
},
"path": "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Person"
} ],
"comment": "The guardian, if present, SHALL contain exactly one [1..1] guardianPerson (CONF:4537-5385)."
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.realmCode",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.realmCode"
},
"path": "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.realmCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question"
}, {
"id": "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.typeId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "InfrastructureRoot.typeId"
},
"path": "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.typeId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"constraint": [ {
"key": "II-1",
"human": "An II instance must have either a root or an nullFlavor.",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot",
"severity": "error",
"expression": "root.exists() or nullFlavor.exists()"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question."
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.typeId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.typeId.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.typeId.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.typeId.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.typeId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.typeId.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.typeId.root",
"min": 1,
"definition": "Identifies the type as an HL7 Registered model",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "2.16.840.1.113883.1.3",
"label": "Root",
"id": "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.typeId.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.typeId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.typeId.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.templateId",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
},
"path": "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"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"
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.classCode",
"fixedCode": "PSN",
"min": 0,
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.classCode",
"base": {
"max": "1",
"min": 0,
"path": "Person.classCode"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.determinerCode",
"fixedCode": "INSTANCE",
"min": 0,
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-EntityDeterminer"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.determinerCode",
"base": {
"max": "1",
"min": 0,
"path": "Person.determinerCode"
}
}, {
"id": "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.name",
"max": "*",
"min": 1,
"base": {
"max": "*",
"min": 0,
"path": "Person.name"
},
"path": "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.name",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/PN",
"profile": [ "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPersonNamePNUSFIELDED" ]
} ],
"comment": "This guardianPerson SHALL contain at least one [1..*] US Realm Person Name (PN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1.1) (CONF:4537-5386)."
}, {
"id": "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcDesc",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "Person.sdtcDesc"
},
"path": "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcDesc",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ED"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "desc"
} ],
"definition": "The desc extension allows multimedia depictions of patients, healthcare providers, or other individuals to be included in a CDA document."
}, {
"id": "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "Person.sdtcAsPatientRelationship"
},
"path": "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "asPatientRelationship"
} ],
"definition": "Each participant role other than an informant/relatedEntity may have zero or more relationship roles with the patient. Each of these roles can be expressed with an asPatientRelationship element which further describes the type of role using a code element."
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.realmCode",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.realmCode"
},
"path": "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.realmCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question"
}, {
"id": "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.typeId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "InfrastructureRoot.typeId"
},
"path": "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.typeId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"constraint": [ {
"key": "II-1",
"human": "An II instance must have either a root or an nullFlavor.",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/ClinicalDocument",
"severity": "error",
"expression": "root.exists() or nullFlavor.exists()"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question."
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.typeId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.typeId.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.typeId.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.typeId.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.typeId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.typeId.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.typeId.root",
"min": 1,
"definition": "Identifies the type as an HL7 Registered model",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "2.16.840.1.113883.1.3",
"label": "Root",
"id": "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.typeId.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.typeId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.typeId.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.templateId",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
},
"path": "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"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"
}, {
"id": "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.classCode",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "Person.sdtcAsPatientRelationship.classCode"
},
"path": "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.classCode",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"fixedCode": "PRS",
"representation": [ "xmlAttr" ]
}, {
"id": "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.determinerCode",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "Person.sdtcAsPatientRelationship.determinerCode"
},
"path": "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.determinerCode",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"fixedCode": "INSTANCE",
"representation": [ "xmlAttr" ]
}, {
"id": "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.code",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "Person.sdtcAsPatientRelationship.code"
},
"path": "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.code",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CE"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
} ]
}, {
"id": "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianOrganization",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "Guardian.guardianOrganization"
},
"path": "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianOrganization",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Organization"
} ]
}, {
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "Patient.birthplace"
},
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Birthplace"
} ],
"comment": "This patient MAY contain zero or one [0..1] birthplace (CONF:4537-5395)."
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.realmCode",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.realmCode"
},
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.realmCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question"
}, {
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.typeId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "InfrastructureRoot.typeId"
},
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.typeId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"constraint": [ {
"key": "II-1",
"human": "An II instance must have either a root or an nullFlavor.",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot",
"severity": "error",
"expression": "root.exists() or nullFlavor.exists()"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question."
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.typeId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.typeId.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.typeId.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.typeId.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.typeId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.typeId.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.typeId.root",
"min": 1,
"definition": "Identifies the type as an HL7 Registered model",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "2.16.840.1.113883.1.3",
"label": "Root",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.typeId.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.typeId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.typeId.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.templateId",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
},
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"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"
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.classCode",
"fixedCode": "BIRTHPL",
"min": 0,
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-RoleClassPassive"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.classCode",
"base": {
"max": "1",
"min": 0,
"path": "Birthplace.classCode"
}
}, {
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "Birthplace.place"
},
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Place"
} ],
"comment": "The birthplace, if present, SHALL contain exactly one [1..1] place (CONF:4537-5396)."
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.realmCode",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.realmCode"
},
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.realmCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question"
}, {
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.typeId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "InfrastructureRoot.typeId"
},
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.typeId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"constraint": [ {
"key": "II-1",
"human": "An II instance must have either a root or an nullFlavor.",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot",
"severity": "error",
"expression": "root.exists() or nullFlavor.exists()"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question."
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.typeId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.typeId.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.typeId.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.typeId.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.typeId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.typeId.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.typeId.root",
"min": 1,
"definition": "Identifies the type as an HL7 Registered model",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "2.16.840.1.113883.1.3",
"label": "Root",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.typeId.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.typeId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.typeId.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.templateId",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
},
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"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"
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.classCode",
"fixedCode": "PLC",
"min": 0,
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-EntityClassPlace"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.classCode",
"base": {
"max": "1",
"min": 0,
"path": "Place.classCode"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.determinerCode",
"fixedCode": "INSTANCE",
"min": 0,
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-EntityDeterminer"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.determinerCode",
"base": {
"max": "1",
"min": 0,
"path": "Place.determinerCode"
}
}, {
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.name",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "Place.name"
},
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.name",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/EN"
} ]
}, {
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 0,
"path": "Place.addr"
},
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/AD"
} ],
"comment": "This place SHALL contain exactly one [1..1] addr (CONF:4537-5397).",
"constraint": [ {
"key": "4537-5402",
"human": "If country is US, this addr **SHALL** contain exactly one [1..1] state, which **SHALL** be selected from ValueSet US Core USPS State *DYNAMIC* (CONF:4537-5402).",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader",
"severity": "error",
"expression": "nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state'))"
}, {
"key": "4537-5403",
"human": "If country is US, this 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:4537-5403).",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader",
"severity": "warning",
"expression": "nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.empty() or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?'))"
}, {
"key": "should-country",
"human": "SHOULD contain country",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader",
"severity": "warning",
"expression": "nullFlavor.exists() or item.country.exists()"
} ]
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.isNotOrdered",
"min": 0,
"definition": "A boolean value specifying whether the order of the address parts is known or not. While the address parts are always a Sequence, the order in which they are presented may or may not be known. Where this matters, the isNotOrdered property can be used to convey this information.",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Is Not Ordered",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.isNotOrdered",
"base": {
"max": "1",
"min": 0,
"path": "AD.isNotOrdered"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.use",
"min": 0,
"definition": "A set of codes advising a system or user which address in a set of like addresses to select for a given purpose.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDAPostalAddressUse"
},
"representation": [ "xmlAttr" ],
"max": "*",
"label": "Use Code",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.use",
"base": {
"max": "*",
"min": 0,
"path": "AD.use"
}
}, {
"constraint": [ {
"key": "AD-1",
"human": "Can only have only one of the possible item elements in each choice",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/ClinicalDocument",
"severity": "error",
"expression": "(delimiter | country | state | county | city | postalCode | streetAddressLine | houseNumber | houseNumberNumeric | direction | streetName | streetNameBase | streetNameType | additionalLocator | unitID | unitType | careOf | censusTract | deliveryAddressLine | deliveryInstallationType | deliveryInstallationArea | deliveryInstallationQualifier | deliveryMode | deliveryModeIdentifier | buildingNumberSuffix | postBox | precinct | xmlText).count() = 1"
} ],
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item",
"min": 0,
"definition": "A series of items that constitute the address.",
"type": [ {
"code": "http://hl7.org/fhir/StructureDefinition/Base"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-choice-group",
"valueBoolean": true
} ],
"max": "*",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item",
"base": {
"max": "*",
"min": 0,
"path": "AD.item"
}
}, {
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.delimiter",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "AD.item.delimiter"
},
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.delimiter",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ADXP"
} ],
"constraint": [ {
"key": "text-null",
"human": "xmlText and nullFlavor are mutually exclusive (one must be present)",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/ST",
"severity": "error",
"expression": "(xmlText | nullFlavor).count() = 1"
} ],
"definition": "Delimiters are printed without framing white space. If no value component is provided, the delimiter appears as a line break."
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.delimiter.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.delimiter.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.delimiter.representation",
"fixedCode": "TXT",
"min": 0,
"definition": "Specifies the representation of the binary data that is the content of the binary data value",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.delimiter.representation",
"base": {
"max": "1",
"min": 0,
"path": "ST.representation"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.delimiter.mediaType",
"fixedCode": "text/plain",
"min": 0,
"definition": "Identifies the type of the encapsulated data and identifies a method to interpret or render the data.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Media Type",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.delimiter.mediaType",
"base": {
"max": "1",
"min": 0,
"path": "ST.mediaType"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.delimiter.language",
"min": 0,
"definition": "For character based information the language property specifies the human language of the text.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Language",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.delimiter.language",
"base": {
"max": "1",
"min": 0,
"path": "ST.language"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.delimiter.xmlText",
"min": 0,
"short": "Allows for mixed text content",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlText" ],
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.delimiter.xmlText",
"comment": "This element is represented in XML as textual content. The actual name \"xmlText\" will not appear in a CDA instance.",
"base": {
"max": "1",
"min": 0,
"path": "ST.xmlText"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.delimiter.partType",
"fixedCode": "DEL",
"min": 0,
"definition": "Specifies the type of the address part",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.delimiter.partType",
"base": {
"max": "1",
"min": 0,
"path": "ADXP.partType"
}
}, {
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.country",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "AD.item.country"
},
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.country",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ADXP"
} ],
"constraint": [ {
"key": "text-null",
"human": "xmlText and nullFlavor are mutually exclusive (one must be present)",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/ST",
"severity": "error",
"expression": "(xmlText | nullFlavor).count() = 1"
} ],
"definition": "Country"
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.country.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.country.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.country.representation",
"fixedCode": "TXT",
"min": 0,
"definition": "Specifies the representation of the binary data that is the content of the binary data value",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.country.representation",
"base": {
"max": "1",
"min": 0,
"path": "ST.representation"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.country.mediaType",
"fixedCode": "text/plain",
"min": 0,
"definition": "Identifies the type of the encapsulated data and identifies a method to interpret or render the data.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Media Type",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.country.mediaType",
"base": {
"max": "1",
"min": 0,
"path": "ST.mediaType"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.country.language",
"min": 0,
"definition": "For character based information the language property specifies the human language of the text.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Language",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.country.language",
"base": {
"max": "1",
"min": 0,
"path": "ST.language"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.country.xmlText",
"min": 0,
"short": "Allows for mixed text content",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlText" ],
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.country.xmlText",
"comment": "This element is represented in XML as textual content. The actual name \"xmlText\" will not appear in a CDA instance.",
"base": {
"max": "1",
"min": 0,
"path": "ST.xmlText"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.country.partType",
"fixedCode": "CNT",
"min": 0,
"definition": "Specifies the type of the address part",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.country.partType",
"base": {
"max": "1",
"min": 0,
"path": "ADXP.partType"
}
}, {
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.state",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "AD.item.state"
},
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.state",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ADXP"
} ],
"constraint": [ {
"key": "text-null",
"human": "xmlText and nullFlavor are mutually exclusive (one must be present)",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/ST",
"severity": "error",
"expression": "(xmlText | nullFlavor).count() = 1"
} ],
"definition": "A sub-unit of a country with limited sovereignty in a federally organized country."
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.state.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.state.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.state.representation",
"fixedCode": "TXT",
"min": 0,
"definition": "Specifies the representation of the binary data that is the content of the binary data value",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.state.representation",
"base": {
"max": "1",
"min": 0,
"path": "ST.representation"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.state.mediaType",
"fixedCode": "text/plain",
"min": 0,
"definition": "Identifies the type of the encapsulated data and identifies a method to interpret or render the data.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Media Type",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.state.mediaType",
"base": {
"max": "1",
"min": 0,
"path": "ST.mediaType"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.state.language",
"min": 0,
"definition": "For character based information the language property specifies the human language of the text.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Language",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.state.language",
"base": {
"max": "1",
"min": 0,
"path": "ST.language"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.state.xmlText",
"min": 0,
"short": "Allows for mixed text content",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlText" ],
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.state.xmlText",
"comment": "This element is represented in XML as textual content. The actual name \"xmlText\" will not appear in a CDA instance.",
"base": {
"max": "1",
"min": 0,
"path": "ST.xmlText"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.state.partType",
"fixedCode": "STA",
"min": 0,
"definition": "Specifies the type of the address part",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.state.partType",
"base": {
"max": "1",
"min": 0,
"path": "ADXP.partType"
}
}, {
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.county",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "AD.item.county"
},
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.county",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ADXP"
} ],
"constraint": [ {
"key": "text-null",
"human": "xmlText and nullFlavor are mutually exclusive (one must be present)",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/ST",
"severity": "error",
"expression": "(xmlText | nullFlavor).count() = 1"
} ],
"definition": "A sub-unit of a state or province. (49 of the United States of America use the term \"county;\" Louisiana uses the term \"parish\".)"
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.county.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.county.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.county.representation",
"fixedCode": "TXT",
"min": 0,
"definition": "Specifies the representation of the binary data that is the content of the binary data value",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.county.representation",
"base": {
"max": "1",
"min": 0,
"path": "ST.representation"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.county.mediaType",
"fixedCode": "text/plain",
"min": 0,
"definition": "Identifies the type of the encapsulated data and identifies a method to interpret or render the data.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Media Type",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.county.mediaType",
"base": {
"max": "1",
"min": 0,
"path": "ST.mediaType"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.county.language",
"min": 0,
"definition": "For character based information the language property specifies the human language of the text.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Language",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.county.language",
"base": {
"max": "1",
"min": 0,
"path": "ST.language"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.county.xmlText",
"min": 0,
"short": "Allows for mixed text content",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlText" ],
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.county.xmlText",
"comment": "This element is represented in XML as textual content. The actual name \"xmlText\" will not appear in a CDA instance.",
"base": {
"max": "1",
"min": 0,
"path": "ST.xmlText"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.county.partType",
"fixedCode": "CPA",
"min": 0,
"definition": "Specifies the type of the address part",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.county.partType",
"base": {
"max": "1",
"min": 0,
"path": "ADXP.partType"
}
}, {
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.city",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "AD.item.city"
},
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.city",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ADXP"
} ],
"constraint": [ {
"key": "text-null",
"human": "xmlText and nullFlavor are mutually exclusive (one must be present)",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/ST",
"severity": "error",
"expression": "(xmlText | nullFlavor).count() = 1"
} ],
"definition": "The name of the city, town, village, or other community or delivery center"
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.city.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.city.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.city.representation",
"fixedCode": "TXT",
"min": 0,
"definition": "Specifies the representation of the binary data that is the content of the binary data value",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.city.representation",
"base": {
"max": "1",
"min": 0,
"path": "ST.representation"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.city.mediaType",
"fixedCode": "text/plain",
"min": 0,
"definition": "Identifies the type of the encapsulated data and identifies a method to interpret or render the data.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Media Type",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.city.mediaType",
"base": {
"max": "1",
"min": 0,
"path": "ST.mediaType"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.city.language",
"min": 0,
"definition": "For character based information the language property specifies the human language of the text.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Language",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.city.language",
"base": {
"max": "1",
"min": 0,
"path": "ST.language"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.city.xmlText",
"min": 0,
"short": "Allows for mixed text content",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlText" ],
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.city.xmlText",
"comment": "This element is represented in XML as textual content. The actual name \"xmlText\" will not appear in a CDA instance.",
"base": {
"max": "1",
"min": 0,
"path": "ST.xmlText"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.city.partType",
"fixedCode": "CTY",
"min": 0,
"definition": "Specifies the type of the address part",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.city.partType",
"base": {
"max": "1",
"min": 0,
"path": "ADXP.partType"
}
}, {
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postalCode",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "AD.item.postalCode"
},
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postalCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ADXP"
} ],
"constraint": [ {
"key": "text-null",
"human": "xmlText and nullFlavor are mutually exclusive (one must be present)",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/ST",
"severity": "error",
"expression": "(xmlText | nullFlavor).count() = 1"
} ],
"definition": "A postal code designating a region defined by the postal service."
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postalCode.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postalCode.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postalCode.representation",
"fixedCode": "TXT",
"min": 0,
"definition": "Specifies the representation of the binary data that is the content of the binary data value",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postalCode.representation",
"base": {
"max": "1",
"min": 0,
"path": "ST.representation"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postalCode.mediaType",
"fixedCode": "text/plain",
"min": 0,
"definition": "Identifies the type of the encapsulated data and identifies a method to interpret or render the data.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Media Type",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postalCode.mediaType",
"base": {
"max": "1",
"min": 0,
"path": "ST.mediaType"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postalCode.language",
"min": 0,
"definition": "For character based information the language property specifies the human language of the text.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Language",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postalCode.language",
"base": {
"max": "1",
"min": 0,
"path": "ST.language"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postalCode.xmlText",
"min": 0,
"short": "Allows for mixed text content",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlText" ],
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postalCode.xmlText",
"comment": "This element is represented in XML as textual content. The actual name \"xmlText\" will not appear in a CDA instance.",
"base": {
"max": "1",
"min": 0,
"path": "ST.xmlText"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postalCode.partType",
"fixedCode": "ZIP",
"min": 0,
"definition": "Specifies the type of the address part",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postalCode.partType",
"base": {
"max": "1",
"min": 0,
"path": "ADXP.partType"
}
}, {
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetAddressLine",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "AD.item.streetAddressLine"
},
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetAddressLine",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ADXP"
} ],
"constraint": [ {
"key": "text-null",
"human": "xmlText and nullFlavor are mutually exclusive (one must be present)",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/ST",
"severity": "error",
"expression": "(xmlText | nullFlavor).count() = 1"
} ],
"definition": "Street address line"
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetAddressLine.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetAddressLine.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetAddressLine.representation",
"fixedCode": "TXT",
"min": 0,
"definition": "Specifies the representation of the binary data that is the content of the binary data value",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetAddressLine.representation",
"base": {
"max": "1",
"min": 0,
"path": "ST.representation"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetAddressLine.mediaType",
"fixedCode": "text/plain",
"min": 0,
"definition": "Identifies the type of the encapsulated data and identifies a method to interpret or render the data.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Media Type",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetAddressLine.mediaType",
"base": {
"max": "1",
"min": 0,
"path": "ST.mediaType"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetAddressLine.language",
"min": 0,
"definition": "For character based information the language property specifies the human language of the text.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Language",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetAddressLine.language",
"base": {
"max": "1",
"min": 0,
"path": "ST.language"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetAddressLine.xmlText",
"min": 0,
"short": "Allows for mixed text content",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlText" ],
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetAddressLine.xmlText",
"comment": "This element is represented in XML as textual content. The actual name \"xmlText\" will not appear in a CDA instance.",
"base": {
"max": "1",
"min": 0,
"path": "ST.xmlText"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetAddressLine.partType",
"fixedCode": "SAL",
"min": 0,
"definition": "Specifies the type of the address part",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetAddressLine.partType",
"base": {
"max": "1",
"min": 0,
"path": "ADXP.partType"
}
}, {
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumber",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "AD.item.houseNumber"
},
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumber",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ADXP"
} ],
"constraint": [ {
"key": "text-null",
"human": "xmlText and nullFlavor are mutually exclusive (one must be present)",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/ST",
"severity": "error",
"expression": "(xmlText | nullFlavor).count() = 1"
} ],
"definition": "The number of a building, house or lot alongside the street. Also known as \"primary street number\". This does not number the street but rather the building."
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumber.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumber.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumber.representation",
"fixedCode": "TXT",
"min": 0,
"definition": "Specifies the representation of the binary data that is the content of the binary data value",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumber.representation",
"base": {
"max": "1",
"min": 0,
"path": "ST.representation"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumber.mediaType",
"fixedCode": "text/plain",
"min": 0,
"definition": "Identifies the type of the encapsulated data and identifies a method to interpret or render the data.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Media Type",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumber.mediaType",
"base": {
"max": "1",
"min": 0,
"path": "ST.mediaType"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumber.language",
"min": 0,
"definition": "For character based information the language property specifies the human language of the text.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Language",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumber.language",
"base": {
"max": "1",
"min": 0,
"path": "ST.language"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumber.xmlText",
"min": 0,
"short": "Allows for mixed text content",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlText" ],
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumber.xmlText",
"comment": "This element is represented in XML as textual content. The actual name \"xmlText\" will not appear in a CDA instance.",
"base": {
"max": "1",
"min": 0,
"path": "ST.xmlText"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumber.partType",
"fixedCode": "BNR",
"min": 0,
"definition": "Specifies the type of the address part",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumber.partType",
"base": {
"max": "1",
"min": 0,
"path": "ADXP.partType"
}
}, {
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumberNumeric",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "AD.item.houseNumberNumeric"
},
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumberNumeric",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ADXP"
} ],
"constraint": [ {
"key": "text-null",
"human": "xmlText and nullFlavor are mutually exclusive (one must be present)",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/ST",
"severity": "error",
"expression": "(xmlText | nullFlavor).count() = 1"
} ],
"definition": "The numeric portion of a building number"
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumberNumeric.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumberNumeric.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumberNumeric.representation",
"fixedCode": "TXT",
"min": 0,
"definition": "Specifies the representation of the binary data that is the content of the binary data value",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumberNumeric.representation",
"base": {
"max": "1",
"min": 0,
"path": "ST.representation"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumberNumeric.mediaType",
"fixedCode": "text/plain",
"min": 0,
"definition": "Identifies the type of the encapsulated data and identifies a method to interpret or render the data.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Media Type",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumberNumeric.mediaType",
"base": {
"max": "1",
"min": 0,
"path": "ST.mediaType"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumberNumeric.language",
"min": 0,
"definition": "For character based information the language property specifies the human language of the text.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Language",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumberNumeric.language",
"base": {
"max": "1",
"min": 0,
"path": "ST.language"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumberNumeric.xmlText",
"min": 0,
"short": "Allows for mixed text content",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlText" ],
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumberNumeric.xmlText",
"comment": "This element is represented in XML as textual content. The actual name \"xmlText\" will not appear in a CDA instance.",
"base": {
"max": "1",
"min": 0,
"path": "ST.xmlText"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumberNumeric.partType",
"fixedCode": "BNN",
"min": 0,
"definition": "Specifies the type of the address part",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumberNumeric.partType",
"base": {
"max": "1",
"min": 0,
"path": "ADXP.partType"
}
}, {
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.direction",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "AD.item.direction"
},
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.direction",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ADXP"
} ],
"constraint": [ {
"key": "text-null",
"human": "xmlText and nullFlavor are mutually exclusive (one must be present)",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/ST",
"severity": "error",
"expression": "(xmlText | nullFlavor).count() = 1"
} ],
"definition": "Direction (e.g., N, S, W, E)"
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.direction.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.direction.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.direction.representation",
"fixedCode": "TXT",
"min": 0,
"definition": "Specifies the representation of the binary data that is the content of the binary data value",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.direction.representation",
"base": {
"max": "1",
"min": 0,
"path": "ST.representation"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.direction.mediaType",
"fixedCode": "text/plain",
"min": 0,
"definition": "Identifies the type of the encapsulated data and identifies a method to interpret or render the data.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Media Type",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.direction.mediaType",
"base": {
"max": "1",
"min": 0,
"path": "ST.mediaType"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.direction.language",
"min": 0,
"definition": "For character based information the language property specifies the human language of the text.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Language",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.direction.language",
"base": {
"max": "1",
"min": 0,
"path": "ST.language"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.direction.xmlText",
"min": 0,
"short": "Allows for mixed text content",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlText" ],
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.direction.xmlText",
"comment": "This element is represented in XML as textual content. The actual name \"xmlText\" will not appear in a CDA instance.",
"base": {
"max": "1",
"min": 0,
"path": "ST.xmlText"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.direction.partType",
"fixedCode": "DIR",
"min": 0,
"definition": "Specifies the type of the address part",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.direction.partType",
"base": {
"max": "1",
"min": 0,
"path": "ADXP.partType"
}
}, {
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetName",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "AD.item.streetName"
},
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetName",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ADXP"
} ],
"constraint": [ {
"key": "text-null",
"human": "xmlText and nullFlavor are mutually exclusive (one must be present)",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/ST",
"severity": "error",
"expression": "(xmlText | nullFlavor).count() = 1"
} ],
"definition": "Name of a roadway or artery recognized by a municipality (including street type and direction)"
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetName.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetName.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetName.representation",
"fixedCode": "TXT",
"min": 0,
"definition": "Specifies the representation of the binary data that is the content of the binary data value",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetName.representation",
"base": {
"max": "1",
"min": 0,
"path": "ST.representation"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetName.mediaType",
"fixedCode": "text/plain",
"min": 0,
"definition": "Identifies the type of the encapsulated data and identifies a method to interpret or render the data.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Media Type",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetName.mediaType",
"base": {
"max": "1",
"min": 0,
"path": "ST.mediaType"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetName.language",
"min": 0,
"definition": "For character based information the language property specifies the human language of the text.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Language",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetName.language",
"base": {
"max": "1",
"min": 0,
"path": "ST.language"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetName.xmlText",
"min": 0,
"short": "Allows for mixed text content",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlText" ],
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetName.xmlText",
"comment": "This element is represented in XML as textual content. The actual name \"xmlText\" will not appear in a CDA instance.",
"base": {
"max": "1",
"min": 0,
"path": "ST.xmlText"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetName.partType",
"fixedCode": "STR",
"min": 0,
"definition": "Specifies the type of the address part",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetName.partType",
"base": {
"max": "1",
"min": 0,
"path": "ADXP.partType"
}
}, {
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameBase",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "AD.item.streetNameBase"
},
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameBase",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ADXP"
} ],
"constraint": [ {
"key": "text-null",
"human": "xmlText and nullFlavor are mutually exclusive (one must be present)",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/ST",
"severity": "error",
"expression": "(xmlText | nullFlavor).count() = 1"
} ],
"definition": "The base name of a roadway or artery recognized by a municipality (excluding street type and direction)"
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameBase.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameBase.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameBase.representation",
"fixedCode": "TXT",
"min": 0,
"definition": "Specifies the representation of the binary data that is the content of the binary data value",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameBase.representation",
"base": {
"max": "1",
"min": 0,
"path": "ST.representation"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameBase.mediaType",
"fixedCode": "text/plain",
"min": 0,
"definition": "Identifies the type of the encapsulated data and identifies a method to interpret or render the data.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Media Type",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameBase.mediaType",
"base": {
"max": "1",
"min": 0,
"path": "ST.mediaType"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameBase.language",
"min": 0,
"definition": "For character based information the language property specifies the human language of the text.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Language",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameBase.language",
"base": {
"max": "1",
"min": 0,
"path": "ST.language"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameBase.xmlText",
"min": 0,
"short": "Allows for mixed text content",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlText" ],
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameBase.xmlText",
"comment": "This element is represented in XML as textual content. The actual name \"xmlText\" will not appear in a CDA instance.",
"base": {
"max": "1",
"min": 0,
"path": "ST.xmlText"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameBase.partType",
"fixedCode": "STB",
"min": 0,
"definition": "Specifies the type of the address part",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameBase.partType",
"base": {
"max": "1",
"min": 0,
"path": "ADXP.partType"
}
}, {
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameType",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "AD.item.streetNameType"
},
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameType",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ADXP"
} ],
"constraint": [ {
"key": "text-null",
"human": "xmlText and nullFlavor are mutually exclusive (one must be present)",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/ST",
"severity": "error",
"expression": "(xmlText | nullFlavor).count() = 1"
} ],
"definition": "The designation given to the street. (e.g. Street, Avenue, Crescent, etc.)"
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameType.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameType.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameType.representation",
"fixedCode": "TXT",
"min": 0,
"definition": "Specifies the representation of the binary data that is the content of the binary data value",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameType.representation",
"base": {
"max": "1",
"min": 0,
"path": "ST.representation"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameType.mediaType",
"fixedCode": "text/plain",
"min": 0,
"definition": "Identifies the type of the encapsulated data and identifies a method to interpret or render the data.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Media Type",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameType.mediaType",
"base": {
"max": "1",
"min": 0,
"path": "ST.mediaType"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameType.language",
"min": 0,
"definition": "For character based information the language property specifies the human language of the text.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Language",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameType.language",
"base": {
"max": "1",
"min": 0,
"path": "ST.language"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameType.xmlText",
"min": 0,
"short": "Allows for mixed text content",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlText" ],
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameType.xmlText",
"comment": "This element is represented in XML as textual content. The actual name \"xmlText\" will not appear in a CDA instance.",
"base": {
"max": "1",
"min": 0,
"path": "ST.xmlText"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameType.partType",
"fixedCode": "STTYP",
"min": 0,
"definition": "Specifies the type of the address part",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameType.partType",
"base": {
"max": "1",
"min": 0,
"path": "ADXP.partType"
}
}, {
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.additionalLocator",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "AD.item.additionalLocator"
},
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.additionalLocator",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ADXP"
} ],
"constraint": [ {
"key": "text-null",
"human": "xmlText and nullFlavor are mutually exclusive (one must be present)",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/ST",
"severity": "error",
"expression": "(xmlText | nullFlavor).count() = 1"
} ],
"definition": "This can be a unit designator, such as apartment number, suite number, or floor. There may be several unit designators in an address (e.g., \"3rd floor, Appt. 342\"). This can also be a designator pointing away from the location, rather than specifying a smaller location within some larger one (e.g., Dutch \"t.o.\" means \"opposite to\" for house boats located across the street facing houses)."
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.additionalLocator.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.additionalLocator.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.additionalLocator.representation",
"fixedCode": "TXT",
"min": 0,
"definition": "Specifies the representation of the binary data that is the content of the binary data value",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.additionalLocator.representation",
"base": {
"max": "1",
"min": 0,
"path": "ST.representation"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.additionalLocator.mediaType",
"fixedCode": "text/plain",
"min": 0,
"definition": "Identifies the type of the encapsulated data and identifies a method to interpret or render the data.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Media Type",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.additionalLocator.mediaType",
"base": {
"max": "1",
"min": 0,
"path": "ST.mediaType"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.additionalLocator.language",
"min": 0,
"definition": "For character based information the language property specifies the human language of the text.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Language",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.additionalLocator.language",
"base": {
"max": "1",
"min": 0,
"path": "ST.language"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.additionalLocator.xmlText",
"min": 0,
"short": "Allows for mixed text content",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlText" ],
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.additionalLocator.xmlText",
"comment": "This element is represented in XML as textual content. The actual name \"xmlText\" will not appear in a CDA instance.",
"base": {
"max": "1",
"min": 0,
"path": "ST.xmlText"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.additionalLocator.partType",
"fixedCode": "ADL",
"min": 0,
"definition": "Specifies the type of the address part",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.additionalLocator.partType",
"base": {
"max": "1",
"min": 0,
"path": "ADXP.partType"
}
}, {
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitID",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "AD.item.unitID"
},
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitID",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ADXP"
} ],
"constraint": [ {
"key": "text-null",
"human": "xmlText and nullFlavor are mutually exclusive (one must be present)",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/ST",
"severity": "error",
"expression": "(xmlText | nullFlavor).count() = 1"
} ],
"definition": "The number or name of a specific unit contained within a building or complex, as assigned by that building or complex."
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitID.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitID.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitID.representation",
"fixedCode": "TXT",
"min": 0,
"definition": "Specifies the representation of the binary data that is the content of the binary data value",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitID.representation",
"base": {
"max": "1",
"min": 0,
"path": "ST.representation"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitID.mediaType",
"fixedCode": "text/plain",
"min": 0,
"definition": "Identifies the type of the encapsulated data and identifies a method to interpret or render the data.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Media Type",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitID.mediaType",
"base": {
"max": "1",
"min": 0,
"path": "ST.mediaType"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitID.language",
"min": 0,
"definition": "For character based information the language property specifies the human language of the text.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Language",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitID.language",
"base": {
"max": "1",
"min": 0,
"path": "ST.language"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitID.xmlText",
"min": 0,
"short": "Allows for mixed text content",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlText" ],
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitID.xmlText",
"comment": "This element is represented in XML as textual content. The actual name \"xmlText\" will not appear in a CDA instance.",
"base": {
"max": "1",
"min": 0,
"path": "ST.xmlText"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitID.partType",
"fixedCode": "UNID",
"min": 0,
"definition": "Specifies the type of the address part",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitID.partType",
"base": {
"max": "1",
"min": 0,
"path": "ADXP.partType"
}
}, {
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitType",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "AD.item.unitType"
},
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitType",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ADXP"
} ],
"constraint": [ {
"key": "text-null",
"human": "xmlText and nullFlavor are mutually exclusive (one must be present)",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/ST",
"severity": "error",
"expression": "(xmlText | nullFlavor).count() = 1"
} ],
"definition": "Indicates the type of specific unit contained within a building or complex. E.g. Appartment, Floor"
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitType.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitType.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitType.representation",
"fixedCode": "TXT",
"min": 0,
"definition": "Specifies the representation of the binary data that is the content of the binary data value",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitType.representation",
"base": {
"max": "1",
"min": 0,
"path": "ST.representation"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitType.mediaType",
"fixedCode": "text/plain",
"min": 0,
"definition": "Identifies the type of the encapsulated data and identifies a method to interpret or render the data.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Media Type",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitType.mediaType",
"base": {
"max": "1",
"min": 0,
"path": "ST.mediaType"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitType.language",
"min": 0,
"definition": "For character based information the language property specifies the human language of the text.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Language",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitType.language",
"base": {
"max": "1",
"min": 0,
"path": "ST.language"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitType.xmlText",
"min": 0,
"short": "Allows for mixed text content",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlText" ],
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitType.xmlText",
"comment": "This element is represented in XML as textual content. The actual name \"xmlText\" will not appear in a CDA instance.",
"base": {
"max": "1",
"min": 0,
"path": "ST.xmlText"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitType.partType",
"fixedCode": "UNIT",
"min": 0,
"definition": "Specifies the type of the address part",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitType.partType",
"base": {
"max": "1",
"min": 0,
"path": "ADXP.partType"
}
}, {
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.careOf",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "AD.item.careOf"
},
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.careOf",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ADXP"
} ],
"constraint": [ {
"key": "text-null",
"human": "xmlText and nullFlavor are mutually exclusive (one must be present)",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/ST",
"severity": "error",
"expression": "(xmlText | nullFlavor).count() = 1"
} ],
"definition": "The name of the party who will take receipt at the specified address, and will take on responsibility for ensuring delivery to the target recipient"
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.careOf.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.careOf.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.careOf.representation",
"fixedCode": "TXT",
"min": 0,
"definition": "Specifies the representation of the binary data that is the content of the binary data value",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.careOf.representation",
"base": {
"max": "1",
"min": 0,
"path": "ST.representation"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.careOf.mediaType",
"fixedCode": "text/plain",
"min": 0,
"definition": "Identifies the type of the encapsulated data and identifies a method to interpret or render the data.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Media Type",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.careOf.mediaType",
"base": {
"max": "1",
"min": 0,
"path": "ST.mediaType"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.careOf.language",
"min": 0,
"definition": "For character based information the language property specifies the human language of the text.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Language",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.careOf.language",
"base": {
"max": "1",
"min": 0,
"path": "ST.language"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.careOf.xmlText",
"min": 0,
"short": "Allows for mixed text content",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlText" ],
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.careOf.xmlText",
"comment": "This element is represented in XML as textual content. The actual name \"xmlText\" will not appear in a CDA instance.",
"base": {
"max": "1",
"min": 0,
"path": "ST.xmlText"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.careOf.partType",
"fixedCode": "CAR",
"min": 0,
"definition": "Specifies the type of the address part",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.careOf.partType",
"base": {
"max": "1",
"min": 0,
"path": "ADXP.partType"
}
}, {
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.censusTract",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "AD.item.censusTract"
},
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.censusTract",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ADXP"
} ],
"constraint": [ {
"key": "text-null",
"human": "xmlText and nullFlavor are mutually exclusive (one must be present)",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/ST",
"severity": "error",
"expression": "(xmlText | nullFlavor).count() = 1"
} ],
"definition": "A geographic sub-unit delineated for demographic purposes."
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.censusTract.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.censusTract.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.censusTract.representation",
"fixedCode": "TXT",
"min": 0,
"definition": "Specifies the representation of the binary data that is the content of the binary data value",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.censusTract.representation",
"base": {
"max": "1",
"min": 0,
"path": "ST.representation"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.censusTract.mediaType",
"fixedCode": "text/plain",
"min": 0,
"definition": "Identifies the type of the encapsulated data and identifies a method to interpret or render the data.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Media Type",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.censusTract.mediaType",
"base": {
"max": "1",
"min": 0,
"path": "ST.mediaType"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.censusTract.language",
"min": 0,
"definition": "For character based information the language property specifies the human language of the text.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Language",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.censusTract.language",
"base": {
"max": "1",
"min": 0,
"path": "ST.language"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.censusTract.xmlText",
"min": 0,
"short": "Allows for mixed text content",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlText" ],
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.censusTract.xmlText",
"comment": "This element is represented in XML as textual content. The actual name \"xmlText\" will not appear in a CDA instance.",
"base": {
"max": "1",
"min": 0,
"path": "ST.xmlText"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.censusTract.partType",
"fixedCode": "CEN",
"min": 0,
"definition": "Specifies the type of the address part",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.censusTract.partType",
"base": {
"max": "1",
"min": 0,
"path": "ADXP.partType"
}
}, {
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryAddressLine",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "AD.item.deliveryAddressLine"
},
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryAddressLine",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ADXP"
} ],
"constraint": [ {
"key": "text-null",
"human": "xmlText and nullFlavor are mutually exclusive (one must be present)",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/ST",
"severity": "error",
"expression": "(xmlText | nullFlavor).count() = 1"
} ],
"definition": "A delivery address line is frequently used instead of breaking out delivery mode, delivery installation, etc. An address generally has only a delivery address line or a street address line, but not both."
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryAddressLine.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryAddressLine.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryAddressLine.representation",
"fixedCode": "TXT",
"min": 0,
"definition": "Specifies the representation of the binary data that is the content of the binary data value",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryAddressLine.representation",
"base": {
"max": "1",
"min": 0,
"path": "ST.representation"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryAddressLine.mediaType",
"fixedCode": "text/plain",
"min": 0,
"definition": "Identifies the type of the encapsulated data and identifies a method to interpret or render the data.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Media Type",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryAddressLine.mediaType",
"base": {
"max": "1",
"min": 0,
"path": "ST.mediaType"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryAddressLine.language",
"min": 0,
"definition": "For character based information the language property specifies the human language of the text.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Language",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryAddressLine.language",
"base": {
"max": "1",
"min": 0,
"path": "ST.language"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryAddressLine.xmlText",
"min": 0,
"short": "Allows for mixed text content",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlText" ],
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryAddressLine.xmlText",
"comment": "This element is represented in XML as textual content. The actual name \"xmlText\" will not appear in a CDA instance.",
"base": {
"max": "1",
"min": 0,
"path": "ST.xmlText"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryAddressLine.partType",
"fixedCode": "DAL",
"min": 0,
"definition": "Specifies the type of the address part",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryAddressLine.partType",
"base": {
"max": "1",
"min": 0,
"path": "ADXP.partType"
}
}, {
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationType",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "AD.item.deliveryInstallationType"
},
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationType",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ADXP"
} ],
"constraint": [ {
"key": "text-null",
"human": "xmlText and nullFlavor are mutually exclusive (one must be present)",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/ST",
"severity": "error",
"expression": "(xmlText | nullFlavor).count() = 1"
} ],
"definition": "Indicates the type of delivery installation (the facility to which the mail will be delivered prior to final shipping via the delivery mode.) Example: post office, letter carrier depot, community mail center, station, etc."
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationType.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationType.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationType.representation",
"fixedCode": "TXT",
"min": 0,
"definition": "Specifies the representation of the binary data that is the content of the binary data value",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationType.representation",
"base": {
"max": "1",
"min": 0,
"path": "ST.representation"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationType.mediaType",
"fixedCode": "text/plain",
"min": 0,
"definition": "Identifies the type of the encapsulated data and identifies a method to interpret or render the data.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Media Type",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationType.mediaType",
"base": {
"max": "1",
"min": 0,
"path": "ST.mediaType"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationType.language",
"min": 0,
"definition": "For character based information the language property specifies the human language of the text.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Language",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationType.language",
"base": {
"max": "1",
"min": 0,
"path": "ST.language"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationType.xmlText",
"min": 0,
"short": "Allows for mixed text content",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlText" ],
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationType.xmlText",
"comment": "This element is represented in XML as textual content. The actual name \"xmlText\" will not appear in a CDA instance.",
"base": {
"max": "1",
"min": 0,
"path": "ST.xmlText"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationType.partType",
"fixedCode": "DINST",
"min": 0,
"definition": "Specifies the type of the address part",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationType.partType",
"base": {
"max": "1",
"min": 0,
"path": "ADXP.partType"
}
}, {
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationArea",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "AD.item.deliveryInstallationArea"
},
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationArea",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ADXP"
} ],
"constraint": [ {
"key": "text-null",
"human": "xmlText and nullFlavor are mutually exclusive (one must be present)",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/ST",
"severity": "error",
"expression": "(xmlText | nullFlavor).count() = 1"
} ],
"definition": "The location of the delivery installation, usually a town or city, and is only required if the area is different from the municipality. Area to which mail delivery service is provided from any postal facility or service such as an individual letter carrier, rural route, or postal route."
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationArea.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationArea.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationArea.representation",
"fixedCode": "TXT",
"min": 0,
"definition": "Specifies the representation of the binary data that is the content of the binary data value",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationArea.representation",
"base": {
"max": "1",
"min": 0,
"path": "ST.representation"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationArea.mediaType",
"fixedCode": "text/plain",
"min": 0,
"definition": "Identifies the type of the encapsulated data and identifies a method to interpret or render the data.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Media Type",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationArea.mediaType",
"base": {
"max": "1",
"min": 0,
"path": "ST.mediaType"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationArea.language",
"min": 0,
"definition": "For character based information the language property specifies the human language of the text.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Language",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationArea.language",
"base": {
"max": "1",
"min": 0,
"path": "ST.language"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationArea.xmlText",
"min": 0,
"short": "Allows for mixed text content",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlText" ],
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationArea.xmlText",
"comment": "This element is represented in XML as textual content. The actual name \"xmlText\" will not appear in a CDA instance.",
"base": {
"max": "1",
"min": 0,
"path": "ST.xmlText"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationArea.partType",
"fixedCode": "DINSTA",
"min": 0,
"definition": "Specifies the type of the address part",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationArea.partType",
"base": {
"max": "1",
"min": 0,
"path": "ADXP.partType"
}
}, {
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationQualifier",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "AD.item.deliveryInstallationQualifier"
},
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationQualifier",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ADXP"
} ],
"constraint": [ {
"key": "text-null",
"human": "xmlText and nullFlavor are mutually exclusive (one must be present)",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/ST",
"severity": "error",
"expression": "(xmlText | nullFlavor).count() = 1"
} ],
"definition": "A number, letter or name identifying a delivery installation. E.g., for Station A, the delivery installation qualifier would be 'A'."
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationQualifier.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationQualifier.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationQualifier.representation",
"fixedCode": "TXT",
"min": 0,
"definition": "Specifies the representation of the binary data that is the content of the binary data value",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationQualifier.representation",
"base": {
"max": "1",
"min": 0,
"path": "ST.representation"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationQualifier.mediaType",
"fixedCode": "text/plain",
"min": 0,
"definition": "Identifies the type of the encapsulated data and identifies a method to interpret or render the data.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Media Type",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationQualifier.mediaType",
"base": {
"max": "1",
"min": 0,
"path": "ST.mediaType"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationQualifier.language",
"min": 0,
"definition": "For character based information the language property specifies the human language of the text.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Language",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationQualifier.language",
"base": {
"max": "1",
"min": 0,
"path": "ST.language"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationQualifier.xmlText",
"min": 0,
"short": "Allows for mixed text content",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlText" ],
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationQualifier.xmlText",
"comment": "This element is represented in XML as textual content. The actual name \"xmlText\" will not appear in a CDA instance.",
"base": {
"max": "1",
"min": 0,
"path": "ST.xmlText"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationQualifier.partType",
"fixedCode": "DINSTQ",
"min": 0,
"definition": "Specifies the type of the address part",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationQualifier.partType",
"base": {
"max": "1",
"min": 0,
"path": "ADXP.partType"
}
}, {
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryMode",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "AD.item.deliveryMode"
},
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryMode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ADXP"
} ],
"constraint": [ {
"key": "text-null",
"human": "xmlText and nullFlavor are mutually exclusive (one must be present)",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/ST",
"severity": "error",
"expression": "(xmlText | nullFlavor).count() = 1"
} ],
"definition": "Indicates the type of service offered, method of delivery. For example: post office box, rural route, general delivery, etc."
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryMode.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryMode.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryMode.representation",
"fixedCode": "TXT",
"min": 0,
"definition": "Specifies the representation of the binary data that is the content of the binary data value",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryMode.representation",
"base": {
"max": "1",
"min": 0,
"path": "ST.representation"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryMode.mediaType",
"fixedCode": "text/plain",
"min": 0,
"definition": "Identifies the type of the encapsulated data and identifies a method to interpret or render the data.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Media Type",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryMode.mediaType",
"base": {
"max": "1",
"min": 0,
"path": "ST.mediaType"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryMode.language",
"min": 0,
"definition": "For character based information the language property specifies the human language of the text.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Language",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryMode.language",
"base": {
"max": "1",
"min": 0,
"path": "ST.language"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryMode.xmlText",
"min": 0,
"short": "Allows for mixed text content",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlText" ],
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryMode.xmlText",
"comment": "This element is represented in XML as textual content. The actual name \"xmlText\" will not appear in a CDA instance.",
"base": {
"max": "1",
"min": 0,
"path": "ST.xmlText"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryMode.partType",
"fixedCode": "DMOD",
"min": 0,
"definition": "Specifies the type of the address part",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryMode.partType",
"base": {
"max": "1",
"min": 0,
"path": "ADXP.partType"
}
}, {
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryModeIdentifier",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "AD.item.deliveryModeIdentifier"
},
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryModeIdentifier",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ADXP"
} ],
"constraint": [ {
"key": "text-null",
"human": "xmlText and nullFlavor are mutually exclusive (one must be present)",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/ST",
"severity": "error",
"expression": "(xmlText | nullFlavor).count() = 1"
} ],
"definition": "Represents the routing information such as a letter carrier route number. It is the identifying number of the designator (the box number or rural route number)."
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryModeIdentifier.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryModeIdentifier.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryModeIdentifier.representation",
"fixedCode": "TXT",
"min": 0,
"definition": "Specifies the representation of the binary data that is the content of the binary data value",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryModeIdentifier.representation",
"base": {
"max": "1",
"min": 0,
"path": "ST.representation"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryModeIdentifier.mediaType",
"fixedCode": "text/plain",
"min": 0,
"definition": "Identifies the type of the encapsulated data and identifies a method to interpret or render the data.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Media Type",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryModeIdentifier.mediaType",
"base": {
"max": "1",
"min": 0,
"path": "ST.mediaType"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryModeIdentifier.language",
"min": 0,
"definition": "For character based information the language property specifies the human language of the text.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Language",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryModeIdentifier.language",
"base": {
"max": "1",
"min": 0,
"path": "ST.language"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryModeIdentifier.xmlText",
"min": 0,
"short": "Allows for mixed text content",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlText" ],
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryModeIdentifier.xmlText",
"comment": "This element is represented in XML as textual content. The actual name \"xmlText\" will not appear in a CDA instance.",
"base": {
"max": "1",
"min": 0,
"path": "ST.xmlText"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryModeIdentifier.partType",
"fixedCode": "DMODID",
"min": 0,
"definition": "Specifies the type of the address part",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryModeIdentifier.partType",
"base": {
"max": "1",
"min": 0,
"path": "ADXP.partType"
}
}, {
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.buildingNumberSuffix",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "AD.item.buildingNumberSuffix"
},
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.buildingNumberSuffix",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ADXP"
} ],
"constraint": [ {
"key": "text-null",
"human": "xmlText and nullFlavor are mutually exclusive (one must be present)",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/ST",
"severity": "error",
"expression": "(xmlText | nullFlavor).count() = 1"
} ],
"definition": "Any alphabetic character, fraction or other text that may appear after the numeric portion of a building number"
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.buildingNumberSuffix.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.buildingNumberSuffix.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.buildingNumberSuffix.representation",
"fixedCode": "TXT",
"min": 0,
"definition": "Specifies the representation of the binary data that is the content of the binary data value",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.buildingNumberSuffix.representation",
"base": {
"max": "1",
"min": 0,
"path": "ST.representation"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.buildingNumberSuffix.mediaType",
"fixedCode": "text/plain",
"min": 0,
"definition": "Identifies the type of the encapsulated data and identifies a method to interpret or render the data.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Media Type",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.buildingNumberSuffix.mediaType",
"base": {
"max": "1",
"min": 0,
"path": "ST.mediaType"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.buildingNumberSuffix.language",
"min": 0,
"definition": "For character based information the language property specifies the human language of the text.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Language",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.buildingNumberSuffix.language",
"base": {
"max": "1",
"min": 0,
"path": "ST.language"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.buildingNumberSuffix.xmlText",
"min": 0,
"short": "Allows for mixed text content",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlText" ],
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.buildingNumberSuffix.xmlText",
"comment": "This element is represented in XML as textual content. The actual name \"xmlText\" will not appear in a CDA instance.",
"base": {
"max": "1",
"min": 0,
"path": "ST.xmlText"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.buildingNumberSuffix.partType",
"fixedCode": "BNS",
"min": 0,
"definition": "Specifies the type of the address part",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.buildingNumberSuffix.partType",
"base": {
"max": "1",
"min": 0,
"path": "ADXP.partType"
}
}, {
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postBox",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "AD.item.postBox"
},
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postBox",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ADXP"
} ],
"constraint": [ {
"key": "text-null",
"human": "xmlText and nullFlavor are mutually exclusive (one must be present)",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/ST",
"severity": "error",
"expression": "(xmlText | nullFlavor).count() = 1"
} ],
"definition": "A numbered box located in a post station."
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postBox.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postBox.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postBox.representation",
"fixedCode": "TXT",
"min": 0,
"definition": "Specifies the representation of the binary data that is the content of the binary data value",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postBox.representation",
"base": {
"max": "1",
"min": 0,
"path": "ST.representation"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postBox.mediaType",
"fixedCode": "text/plain",
"min": 0,
"definition": "Identifies the type of the encapsulated data and identifies a method to interpret or render the data.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Media Type",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postBox.mediaType",
"base": {
"max": "1",
"min": 0,
"path": "ST.mediaType"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postBox.language",
"min": 0,
"definition": "For character based information the language property specifies the human language of the text.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Language",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postBox.language",
"base": {
"max": "1",
"min": 0,
"path": "ST.language"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postBox.xmlText",
"min": 0,
"short": "Allows for mixed text content",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlText" ],
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postBox.xmlText",
"comment": "This element is represented in XML as textual content. The actual name \"xmlText\" will not appear in a CDA instance.",
"base": {
"max": "1",
"min": 0,
"path": "ST.xmlText"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postBox.partType",
"fixedCode": "POB",
"min": 0,
"definition": "Specifies the type of the address part",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postBox.partType",
"base": {
"max": "1",
"min": 0,
"path": "ADXP.partType"
}
}, {
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.precinct",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "AD.item.precinct"
},
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.precinct",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ADXP"
} ],
"constraint": [ {
"key": "text-null",
"human": "xmlText and nullFlavor are mutually exclusive (one must be present)",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/ST",
"severity": "error",
"expression": "(xmlText | nullFlavor).count() = 1"
} ],
"definition": "A subsection of a municipality"
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.precinct.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.precinct.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.precinct.representation",
"fixedCode": "TXT",
"min": 0,
"definition": "Specifies the representation of the binary data that is the content of the binary data value",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.precinct.representation",
"base": {
"max": "1",
"min": 0,
"path": "ST.representation"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.precinct.mediaType",
"fixedCode": "text/plain",
"min": 0,
"definition": "Identifies the type of the encapsulated data and identifies a method to interpret or render the data.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Media Type",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.precinct.mediaType",
"base": {
"max": "1",
"min": 0,
"path": "ST.mediaType"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.precinct.language",
"min": 0,
"definition": "For character based information the language property specifies the human language of the text.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Language",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.precinct.language",
"base": {
"max": "1",
"min": 0,
"path": "ST.language"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.precinct.xmlText",
"min": 0,
"short": "Allows for mixed text content",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlText" ],
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.precinct.xmlText",
"comment": "This element is represented in XML as textual content. The actual name \"xmlText\" will not appear in a CDA instance.",
"base": {
"max": "1",
"min": 0,
"path": "ST.xmlText"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.precinct.partType",
"fixedCode": "PRE",
"min": 0,
"definition": "Specifies the type of the address part",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.precinct.partType",
"base": {
"max": "1",
"min": 0,
"path": "ADXP.partType"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.xmlText",
"min": 0,
"short": "Allows for mixed text content",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlText" ],
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.xmlText",
"comment": "This element is represented in XML as textual content. The actual name \"xmlText\" will not appear in a CDA instance.",
"base": {
"max": "1",
"min": 0,
"path": "AD.item.xmlText"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.useablePeriod",
"min": 0,
"definition": "A General Timing Specification (GTS) specifying the periods of time during which the address can be used. This is used to specify different addresses for different times of the week or year.",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS"
}, {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS"
}, {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS"
}, {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-defaulttype",
"valueCanonical": "http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS"
} ],
"representation": [ "typeAttr" ],
"max": "*",
"label": "Useable Period",
"id": "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.useablePeriod",
"base": {
"max": "*",
"min": 0,
"path": "AD.useablePeriod"
}
}, {
"constraint": [ {
"key": "should-proficiencyLevelCode",
"human": "SHOULD contain proficiencyLevelCode",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader",
"severity": "warning",
"expression": "proficiencyLevelCode.exists()"
}, {
"key": "should-preferenceInd",
"human": "SHOULD contain preferenceInd",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader",
"severity": "warning",
"expression": "preferenceInd.exists()"
} ],
"path": "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication",
"min": 0,
"short": "𝗨𝗦𝗖𝗗𝗜: Preferred Language",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/LanguageCommunication"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement",
"valueBoolean": true
} ],
"max": "*",
"id": "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication",
"base": {
"max": "*",
"min": 0,
"path": "Patient.languageCommunication"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.realmCode",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.realmCode"
},
"path": "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.realmCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question"
}, {
"id": "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.typeId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "InfrastructureRoot.typeId"
},
"path": "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.typeId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"constraint": [ {
"key": "II-1",
"human": "An II instance must have either a root or an nullFlavor.",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot",
"severity": "error",
"expression": "root.exists() or nullFlavor.exists()"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question."
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.typeId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.typeId.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.typeId.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.typeId.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.typeId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.typeId.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.typeId.root",
"min": 1,
"definition": "Identifies the type as an HL7 Registered model",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "2.16.840.1.113883.1.3",
"label": "Root",
"id": "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.typeId.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.typeId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.typeId.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.templateId",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
},
"path": "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"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"
}, {
"id": "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.languageCode",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 0,
"path": "LanguageCommunication.languageCode"
},
"path": "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.languageCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/us/core/ValueSet/simple-language"
}
}, {
"id": "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.modeCode",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "LanguageCommunication.modeCode"
},
"path": "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.modeCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CE"
} ],
"binding": {
"strength": "required",
"valueSet": "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.12249"
},
"comment": "The 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:4537-5409)."
}, {
"id": "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.proficiencyLevelCode",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "LanguageCommunication.proficiencyLevelCode"
},
"path": "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.proficiencyLevelCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CE"
} ],
"binding": {
"strength": "required",
"valueSet": "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.12199"
},
"comment": "The 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:4537-9965)."
}, {
"id": "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.preferenceInd",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "LanguageCommunication.preferenceInd"
},
"path": "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.preferenceInd",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/BL"
} ],
"comment": "The languageCommunication, if present, SHOULD contain zero or one [0..1] preferenceInd (CONF:4537-5414)."
}, {
"id": "ClinicalDocument.recordTarget.patientRole.providerOrganization",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "PatientRole.providerOrganization"
},
"path": "ClinicalDocument.recordTarget.patientRole.providerOrganization",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Organization"
} ],
"comment": "This patientRole MAY contain zero or one [0..1] providerOrganization (CONF:4537-5416)."
}, {
"path": "ClinicalDocument.recordTarget.patientRole.providerOrganization.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.recordTarget.patientRole.providerOrganization.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "ClinicalDocument.recordTarget.patientRole.providerOrganization.realmCode",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.realmCode"
},
"path": "ClinicalDocument.recordTarget.patientRole.providerOrganization.realmCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question"
}, {
"id": "ClinicalDocument.recordTarget.patientRole.providerOrganization.typeId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "InfrastructureRoot.typeId"
},
"path": "ClinicalDocument.recordTarget.patientRole.providerOrganization.typeId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"constraint": [ {
"key": "II-1",
"human": "An II instance must have either a root or an nullFlavor.",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot",
"severity": "error",
"expression": "root.exists() or nullFlavor.exists()"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question."
}, {
"path": "ClinicalDocument.recordTarget.patientRole.providerOrganization.typeId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.recordTarget.patientRole.providerOrganization.typeId.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.providerOrganization.typeId.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "ClinicalDocument.recordTarget.patientRole.providerOrganization.typeId.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.providerOrganization.typeId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "ClinicalDocument.recordTarget.patientRole.providerOrganization.typeId.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.providerOrganization.typeId.root",
"min": 1,
"definition": "Identifies the type as an HL7 Registered model",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "2.16.840.1.113883.1.3",
"label": "Root",
"id": "ClinicalDocument.recordTarget.patientRole.providerOrganization.typeId.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.providerOrganization.typeId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "ClinicalDocument.recordTarget.patientRole.providerOrganization.typeId.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "ClinicalDocument.recordTarget.patientRole.providerOrganization.templateId",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
},
"path": "ClinicalDocument.recordTarget.patientRole.providerOrganization.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"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"
}, {
"path": "ClinicalDocument.recordTarget.patientRole.providerOrganization.classCode",
"fixedCode": "ORG",
"min": 0,
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-EntityClassOrganization"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.providerOrganization.classCode",
"base": {
"max": "1",
"min": 0,
"path": "Organization.classCode"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.providerOrganization.determinerCode",
"fixedCode": "INSTANCE",
"min": 0,
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-EntityDeterminer"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.recordTarget.patientRole.providerOrganization.determinerCode",
"base": {
"max": "1",
"min": 0,
"path": "Organization.determinerCode"
}
}, {
"id": "ClinicalDocument.recordTarget.patientRole.providerOrganization.id",
"max": "*",
"min": 1,
"base": {
"max": "*",
"min": 0,
"path": "Organization.id"
},
"path": "ClinicalDocument.recordTarget.patientRole.providerOrganization.id",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"comment": "The providerOrganization, if present, SHALL contain at least one [1..*] id (CONF:4537-5417)."
}, {
"path": "ClinicalDocument.recordTarget.patientRole.providerOrganization.id.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.recordTarget.patientRole.providerOrganization.id.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.providerOrganization.id.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "ClinicalDocument.recordTarget.patientRole.providerOrganization.id.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.providerOrganization.id.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "ClinicalDocument.recordTarget.patientRole.providerOrganization.id.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"constraint": [ {
"key": "should-npi",
"human": "SHOULD be NPI",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader",
"severity": "warning",
"expression": "$this = '2.16.840.1.113883.4.6'"
} ],
"path": "ClinicalDocument.recordTarget.patientRole.providerOrganization.id.root",
"min": 0,
"definition": "A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Root",
"id": "ClinicalDocument.recordTarget.patientRole.providerOrganization.id.root",
"comment": "Such ids SHOULD contain zero or one [0..1] @root=\"2.16.840.1.113883.4.6\" National Provider Identifier (CONF:4537-16820).",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.providerOrganization.id.extension",
"min": 0,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "ClinicalDocument.recordTarget.patientRole.providerOrganization.id.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "ClinicalDocument.recordTarget.patientRole.providerOrganization.name",
"max": "*",
"min": 1,
"base": {
"max": "*",
"min": 0,
"path": "Organization.name"
},
"path": "ClinicalDocument.recordTarget.patientRole.providerOrganization.name",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ON"
} ],
"comment": "The providerOrganization, if present, SHALL contain at least one [1..*] name (CONF:4537-5419)."
}, {
"id": "ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom",
"max": "*",
"min": 1,
"base": {
"max": "*",
"min": 0,
"path": "Organization.telecom"
},
"path": "ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/TEL"
} ],
"comment": "The providerOrganization, if present, SHALL contain at least one [1..*] telecom (CONF:4537-5420).",
"constraint": [ {
"key": "should-use",
"human": "SHOULD contain @use",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader",
"severity": "warning",
"expression": "nullFlavor.exists() or use.exists()"
} ]
}, {
"path": "ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom.value",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "TEL.value"
},
"path": "ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom.value",
"type": [ {
"code": "url",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/url" ]
} ],
"representation": [ "xmlAttr" ]
}, {
"path": "ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom.useablePeriod",
"min": 0,
"definition": "Specifies the periods of time during which the telecommunication address can be used. For a telephone number, this can indicate the time of day in which the party can be reached on that telephone. For a web address, it may specify a time range in which the web content is promised to be available under the given address.",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS"
}, {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS"
}, {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS"
}, {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-defaulttype",
"valueCanonical": "http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS"
} ],
"representation": [ "typeAttr" ],
"max": "*",
"label": "Useable Period",
"id": "ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom.useablePeriod",
"base": {
"max": "*",
"min": 0,
"path": "TEL.useablePeriod"
}
}, {
"path": "ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom.use",
"min": 0,
"definition": "One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.20"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Use Code",
"id": "ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom.use",
"comment": "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:4537-7994).",
"base": {
"max": "*",
"min": 0,
"path": "TEL.use"
}
}, {
"id": "ClinicalDocument.recordTarget.patientRole.providerOrganization.addr",
"max": "*",
"min": 1,
"base": {
"max": "*",
"min": 0,
"path": "Organization.addr"
},
"path": "ClinicalDocument.recordTarget.patientRole.providerOrganization.addr",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/AD",
"profile": [ "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress" ]
} ],
"comment": "The 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:4537-5422)."
}, {
"id": "ClinicalDocument.recordTarget.patientRole.providerOrganization.standardIndustryClassCode",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "Organization.standardIndustryClassCode"
},
"path": "ClinicalDocument.recordTarget.patientRole.providerOrganization.standardIndustryClassCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CE"
} ],
"binding": {
"strength": "example",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-OrganizationIndustryClassNAICS"
}
}, {
"id": "ClinicalDocument.recordTarget.patientRole.providerOrganization.asOrganizationPartOf",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "Organization.asOrganizationPartOf"
},
"path": "ClinicalDocument.recordTarget.patientRole.providerOrganization.asOrganizationPartOf",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/OrganizationPartOf"
} ]
}, {
"id": "ClinicalDocument.author",
"max": "*",
"min": 1,
"base": {
"max": "*",
"min": 1,
"path": "ClinicalDocument.author"
},
"path": "ClinicalDocument.author",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Author"
} ],
"short": "The author element represents the creator of the clinical document. The author may be a device or a person.",
"comment": "SHALL contain at least one [1..*] author (CONF:4537-5444)."
}, {
"path": "ClinicalDocument.author.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.author.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "ClinicalDocument.author.realmCode",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.realmCode"
},
"path": "ClinicalDocument.author.realmCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question"
}, {
"id": "ClinicalDocument.author.typeId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "InfrastructureRoot.typeId"
},
"path": "ClinicalDocument.author.typeId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"constraint": [ {
"key": "II-1",
"human": "An II instance must have either a root or an nullFlavor.",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot",
"severity": "error",
"expression": "root.exists() or nullFlavor.exists()"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question."
}, {
"path": "ClinicalDocument.author.typeId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.author.typeId.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.author.typeId.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "ClinicalDocument.author.typeId.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "ClinicalDocument.author.typeId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "ClinicalDocument.author.typeId.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "ClinicalDocument.author.typeId.root",
"min": 1,
"definition": "Identifies the type as an HL7 Registered model",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "2.16.840.1.113883.1.3",
"label": "Root",
"id": "ClinicalDocument.author.typeId.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "ClinicalDocument.author.typeId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "ClinicalDocument.author.typeId.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "ClinicalDocument.author.templateId",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
},
"path": "ClinicalDocument.author.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"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"
}, {
"path": "ClinicalDocument.author.typeCode",
"fixedCode": "AUT",
"min": 0,
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.author.typeCode",
"base": {
"max": "1",
"min": 0,
"path": "Author.typeCode"
}
}, {
"path": "ClinicalDocument.author.contextControlCode",
"fixedCode": "OP",
"min": 0,
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDAContextControl"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.author.contextControlCode",
"base": {
"max": "1",
"min": 0,
"path": "Author.contextControlCode"
}
}, {
"id": "ClinicalDocument.author.functionCode",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "Author.functionCode"
},
"path": "ClinicalDocument.author.functionCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CE"
} ]
}, {
"id": "ClinicalDocument.author.time",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "Author.time"
},
"path": "ClinicalDocument.author.time",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/TS",
"profile": [ "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmDateTime" ]
} ],
"comment": "Such authors SHALL contain exactly one [1..1] US Realm Date and Time (Point in Time) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.4) (CONF:4537-5445)."
}, {
"id": "ClinicalDocument.author.assignedAuthor",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "Author.assignedAuthor"
},
"path": "ClinicalDocument.author.assignedAuthor",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/AssignedAuthor"
} ],
"comment": "Such authors SHALL contain exactly one [1..1] assignedAuthor (CONF:4537-5448).",
"constraint": [ {
"key": "4537-16790",
"human": "There **SHALL** be exactly one assignedAuthor/assignedPerson or exactly one assignedAuthor/assignedAuthoringDevice (CONF:4537-16790).",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader",
"severity": "error",
"expression": "(assignedPerson | assignedAuthoringDevice).count() = 1"
}, {
"key": "should-id-npi",
"human": "SHOULD contain an id with root='2.16.840.1.113883.4.6' (NPI)",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader",
"severity": "warning",
"expression": "id.where(root = '2.16.840.1.113883.4.6')"
}, {
"key": "should-us-code",
"human": "SHOULD contain code",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader",
"severity": "warning",
"expression": "code.exists()"
} ]
}, {
"path": "ClinicalDocument.author.assignedAuthor.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.author.assignedAuthor.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "ClinicalDocument.author.assignedAuthor.realmCode",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.realmCode"
},
"path": "ClinicalDocument.author.assignedAuthor.realmCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question"
}, {
"id": "ClinicalDocument.author.assignedAuthor.typeId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "InfrastructureRoot.typeId"
},
"path": "ClinicalDocument.author.assignedAuthor.typeId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"constraint": [ {
"key": "II-1",
"human": "An II instance must have either a root or an nullFlavor.",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot",
"severity": "error",
"expression": "root.exists() or nullFlavor.exists()"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question."
}, {
"path": "ClinicalDocument.author.assignedAuthor.typeId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.author.assignedAuthor.typeId.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.author.assignedAuthor.typeId.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "ClinicalDocument.author.assignedAuthor.typeId.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "ClinicalDocument.author.assignedAuthor.typeId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "ClinicalDocument.author.assignedAuthor.typeId.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "ClinicalDocument.author.assignedAuthor.typeId.root",
"min": 1,
"definition": "Identifies the type as an HL7 Registered model",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "2.16.840.1.113883.1.3",
"label": "Root",
"id": "ClinicalDocument.author.assignedAuthor.typeId.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "ClinicalDocument.author.assignedAuthor.typeId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "ClinicalDocument.author.assignedAuthor.typeId.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "ClinicalDocument.author.assignedAuthor.templateId",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
},
"path": "ClinicalDocument.author.assignedAuthor.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"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"
}, {
"path": "ClinicalDocument.author.assignedAuthor.classCode",
"fixedCode": "ASSIGNED",
"min": 0,
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-RoleClassAssignedEntity"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.author.assignedAuthor.classCode",
"base": {
"max": "1",
"min": 0,
"path": "AssignedAuthor.classCode"
}
}, {
"id": "ClinicalDocument.author.assignedAuthor.id",
"max": "*",
"min": 1,
"base": {
"max": "*",
"min": 1,
"path": "AssignedAuthor.id"
},
"path": "ClinicalDocument.author.assignedAuthor.id",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"comment": "This assignedAuthor SHOULD contain zero or one [0..1] id (CONF:4537-32882) such that it, This assignedAuthor SHALL contain at least one [1..*] id (CONF:4537-5449).",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "root",
"type": "value"
} ]
}
}, {
"id": "ClinicalDocument.author.assignedAuthor.id:npi",
"max": "1",
"min": 0,
"base": {
"max": "*",
"min": 1,
"path": "AssignedAuthor.id"
},
"path": "ClinicalDocument.author.assignedAuthor.id",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"sliceName": "npi",
"constraint": [ {
"key": "should-extension",
"human": "SHOULD contain extension",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader",
"severity": "warning",
"expression": "extension.exists()"
} ]
}, {
"path": "ClinicalDocument.author.assignedAuthor.id.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"short": "If NPI is unknown, set @nullFlavor to UNK",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.author.assignedAuthor.id:npi.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.author.assignedAuthor.id.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "ClinicalDocument.author.assignedAuthor.id:npi.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "ClinicalDocument.author.assignedAuthor.id.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "ClinicalDocument.author.assignedAuthor.id:npi.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "ClinicalDocument.author.assignedAuthor.id.root",
"min": 1,
"definition": "A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"patternString": "2.16.840.1.113883.4.6",
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Root",
"id": "ClinicalDocument.author.assignedAuthor.id:npi.root",
"comment": "SHALL contain exactly one [1..1] @root=\"2.16.840.1.113883.4.6\" National Provider Identifier (CONF:4537-32884).",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "ClinicalDocument.author.assignedAuthor.id.extension",
"min": 0,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "ClinicalDocument.author.assignedAuthor.id:npi.extension",
"comment": "SHOULD contain zero or one [0..1] @extension (CONF:4537-32885).",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "ClinicalDocument.author.assignedAuthor.sdtcIdentifiedBy",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "AssignedAuthor.sdtcIdentifiedBy"
},
"path": "ClinicalDocument.author.assignedAuthor.sdtcIdentifiedBy",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "identifiedBy"
} ]
}, {
"path": "ClinicalDocument.author.assignedAuthor.code",
"min": 0,
"short": "Only if this assignedAuthor is an assignedPerson should the assignedAuthor contain a code.",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CE"
} ],
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDARoleCode"
},
"max": "1",
"id": "ClinicalDocument.author.assignedAuthor.code",
"comment": "This assignedAuthor SHOULD contain zero or one [0..1] code (CONF:4537-16787).",
"base": {
"max": "1",
"min": 0,
"path": "AssignedAuthor.code"
}
}, {
"path": "ClinicalDocument.author.assignedAuthor.code.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "0",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.author.assignedAuthor.code.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.author.assignedAuthor.code.code",
"min": 1,
"definition": "The plain code symbol defined by the code system. For example, \"784.0\" is the code symbol of the ICD-9 code \"784.0\" for headache.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "preferred",
"valueSet": "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Code",
"id": "ClinicalDocument.author.assignedAuthor.code.code",
"base": {
"max": "1",
"min": 0,
"path": "CD.code"
}
}, {
"path": "ClinicalDocument.author.assignedAuthor.code.codeSystem",
"min": 0,
"definition": "Specifies the code system that defines the code.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Code System",
"id": "ClinicalDocument.author.assignedAuthor.code.codeSystem",
"base": {
"max": "1",
"min": 0,
"path": "CD.codeSystem"
}
}, {
"path": "ClinicalDocument.author.assignedAuthor.code.codeSystemName",
"min": 0,
"definition": "The common name of the coding system.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Code System Name",
"id": "ClinicalDocument.author.assignedAuthor.code.codeSystemName",
"base": {
"max": "1",
"min": 0,
"path": "CD.codeSystemName"
}
}, {
"path": "ClinicalDocument.author.assignedAuthor.code.codeSystemVersion",
"min": 0,
"definition": "If applicable, a version descriptor defined specifically for the given code system.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Code System Version",
"id": "ClinicalDocument.author.assignedAuthor.code.codeSystemVersion",
"base": {
"max": "1",
"min": 0,
"path": "CD.codeSystemVersion"
}
}, {
"path": "ClinicalDocument.author.assignedAuthor.code.displayName",
"min": 0,
"definition": "A name or title for the code, under which the sending system shows the code value to its users.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Display Name",
"id": "ClinicalDocument.author.assignedAuthor.code.displayName",
"base": {
"max": "1",
"min": 0,
"path": "CD.displayName"
}
}, {
"path": "ClinicalDocument.author.assignedAuthor.code.sdtcValueSet",
"min": 0,
"definition": "The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid" ]
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "valueSet"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.author.assignedAuthor.code.sdtcValueSet",
"base": {
"max": "1",
"min": 0,
"path": "CD.valueSet"
}
}, {
"path": "ClinicalDocument.author.assignedAuthor.code.sdtcValueSetVersion",
"min": 0,
"definition": "The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "valueSetVersion"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.author.assignedAuthor.code.sdtcValueSetVersion",
"base": {
"max": "1",
"min": 0,
"path": "CD.sdtcValueSetVersion"
}
}, {
"id": "ClinicalDocument.author.assignedAuthor.code.originalText",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "CD.originalText"
},
"path": "ClinicalDocument.author.assignedAuthor.code.originalText",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ED"
} ],
"label": "Original Text",
"definition": "The text or phrase used as the basis for the coding."
}, {
"id": "ClinicalDocument.author.assignedAuthor.code.qualifier",
"max": "0",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "CD.qualifier"
},
"path": "ClinicalDocument.author.assignedAuthor.code.qualifier",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CR"
} ],
"label": "Qualifier",
"definition": "Specifies additional codes that increase the specificity of the the primary code."
}, {
"path": "ClinicalDocument.author.assignedAuthor.code.translation",
"min": 0,
"definition": "A set of other concept descriptors that translate this concept descriptor into other code systems.",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CD"
} ],
"representation": [ "typeAttr" ],
"max": "*",
"label": "Translation",
"id": "ClinicalDocument.author.assignedAuthor.code.translation",
"base": {
"max": "*",
"min": 0,
"path": "CD.translation"
}
}, {
"id": "ClinicalDocument.author.assignedAuthor.addr",
"max": "*",
"min": 1,
"base": {
"max": "*",
"min": 0,
"path": "AssignedAuthor.addr"
},
"path": "ClinicalDocument.author.assignedAuthor.addr",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/AD",
"profile": [ "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress" ]
} ],
"comment": "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:4537-5452)."
}, {
"id": "ClinicalDocument.author.assignedAuthor.telecom",
"max": "*",
"min": 1,
"base": {
"max": "*",
"min": 0,
"path": "AssignedAuthor.telecom"
},
"path": "ClinicalDocument.author.assignedAuthor.telecom",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/TEL"
} ],
"comment": "This assignedAuthor SHALL contain at least one [1..*] telecom (CONF:4537-5428).",
"constraint": [ {
"key": "should-use",
"human": "SHOULD contain @use",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader",
"severity": "warning",
"expression": "nullFlavor.exists() or use.exists()"
} ]
}, {
"path": "ClinicalDocument.author.assignedAuthor.telecom.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.author.assignedAuthor.telecom.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "ClinicalDocument.author.assignedAuthor.telecom.value",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "TEL.value"
},
"path": "ClinicalDocument.author.assignedAuthor.telecom.value",
"type": [ {
"code": "url",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/url" ]
} ],
"representation": [ "xmlAttr" ]
}, {
"path": "ClinicalDocument.author.assignedAuthor.telecom.useablePeriod",
"min": 0,
"definition": "Specifies the periods of time during which the telecommunication address can be used. For a telephone number, this can indicate the time of day in which the party can be reached on that telephone. For a web address, it may specify a time range in which the web content is promised to be available under the given address.",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS"
}, {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS"
}, {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS"
}, {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-defaulttype",
"valueCanonical": "http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS"
} ],
"representation": [ "typeAttr" ],
"max": "*",
"label": "Useable Period",
"id": "ClinicalDocument.author.assignedAuthor.telecom.useablePeriod",
"base": {
"max": "*",
"min": 0,
"path": "TEL.useablePeriod"
}
}, {
"path": "ClinicalDocument.author.assignedAuthor.telecom.use",
"min": 0,
"definition": "One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.20"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Use Code",
"id": "ClinicalDocument.author.assignedAuthor.telecom.use",
"comment": "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:4537-7995).",
"base": {
"max": "*",
"min": 0,
"path": "TEL.use"
}
}, {
"id": "ClinicalDocument.author.assignedAuthor.assignedPerson",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "AssignedAuthor.assignedPerson"
},
"path": "ClinicalDocument.author.assignedAuthor.assignedPerson",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Person"
} ],
"comment": "MAY contain assignedPerson"
}, {
"path": "ClinicalDocument.author.assignedAuthor.assignedPerson.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.author.assignedAuthor.assignedPerson.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "ClinicalDocument.author.assignedAuthor.assignedPerson.realmCode",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.realmCode"
},
"path": "ClinicalDocument.author.assignedAuthor.assignedPerson.realmCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question"
}, {
"id": "ClinicalDocument.author.assignedAuthor.assignedPerson.typeId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "InfrastructureRoot.typeId"
},
"path": "ClinicalDocument.author.assignedAuthor.assignedPerson.typeId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"constraint": [ {
"key": "II-1",
"human": "An II instance must have either a root or an nullFlavor.",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot",
"severity": "error",
"expression": "root.exists() or nullFlavor.exists()"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question."
}, {
"path": "ClinicalDocument.author.assignedAuthor.assignedPerson.typeId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.author.assignedAuthor.assignedPerson.typeId.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.author.assignedAuthor.assignedPerson.typeId.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "ClinicalDocument.author.assignedAuthor.assignedPerson.typeId.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "ClinicalDocument.author.assignedAuthor.assignedPerson.typeId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "ClinicalDocument.author.assignedAuthor.assignedPerson.typeId.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "ClinicalDocument.author.assignedAuthor.assignedPerson.typeId.root",
"min": 1,
"definition": "Identifies the type as an HL7 Registered model",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "2.16.840.1.113883.1.3",
"label": "Root",
"id": "ClinicalDocument.author.assignedAuthor.assignedPerson.typeId.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "ClinicalDocument.author.assignedAuthor.assignedPerson.typeId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "ClinicalDocument.author.assignedAuthor.assignedPerson.typeId.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "ClinicalDocument.author.assignedAuthor.assignedPerson.templateId",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
},
"path": "ClinicalDocument.author.assignedAuthor.assignedPerson.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"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"
}, {
"path": "ClinicalDocument.author.assignedAuthor.assignedPerson.classCode",
"fixedCode": "PSN",
"min": 0,
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.author.assignedAuthor.assignedPerson.classCode",
"base": {
"max": "1",
"min": 0,
"path": "Person.classCode"
}
}, {
"path": "ClinicalDocument.author.assignedAuthor.assignedPerson.determinerCode",
"fixedCode": "INSTANCE",
"min": 0,
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-EntityDeterminer"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.author.assignedAuthor.assignedPerson.determinerCode",
"base": {
"max": "1",
"min": 0,
"path": "Person.determinerCode"
}
}, {
"id": "ClinicalDocument.author.assignedAuthor.assignedPerson.name",
"max": "*",
"min": 1,
"base": {
"max": "*",
"min": 0,
"path": "Person.name"
},
"path": "ClinicalDocument.author.assignedAuthor.assignedPerson.name",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/PN",
"profile": [ "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPersonNamePNUSFIELDED" ]
} ],
"comment": "The assignedPerson, if present, SHALL contain at least one [1..*] US Realm Person Name (PN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1.1) (CONF:4537-16789)."
}, {
"id": "ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcDesc",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "Person.sdtcDesc"
},
"path": "ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcDesc",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ED"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "desc"
} ],
"definition": "The desc extension allows multimedia depictions of patients, healthcare providers, or other individuals to be included in a CDA document."
}, {
"id": "ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "Person.sdtcAsPatientRelationship"
},
"path": "ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "asPatientRelationship"
} ],
"definition": "Each participant role other than an informant/relatedEntity may have zero or more relationship roles with the patient. Each of these roles can be expressed with an asPatientRelationship element which further describes the type of role using a code element."
}, {
"path": "ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.realmCode",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.realmCode"
},
"path": "ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.realmCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question"
}, {
"id": "ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.typeId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "InfrastructureRoot.typeId"
},
"path": "ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.typeId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"constraint": [ {
"key": "II-1",
"human": "An II instance must have either a root or an nullFlavor.",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/ClinicalDocument",
"severity": "error",
"expression": "root.exists() or nullFlavor.exists()"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question."
}, {
"path": "ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.typeId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.typeId.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.typeId.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.typeId.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.typeId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.typeId.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.typeId.root",
"min": 1,
"definition": "Identifies the type as an HL7 Registered model",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "2.16.840.1.113883.1.3",
"label": "Root",
"id": "ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.typeId.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.typeId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.typeId.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.templateId",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
},
"path": "ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"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"
}, {
"id": "ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.classCode",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "Person.sdtcAsPatientRelationship.classCode"
},
"path": "ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.classCode",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"fixedCode": "PRS",
"representation": [ "xmlAttr" ]
}, {
"id": "ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.determinerCode",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "Person.sdtcAsPatientRelationship.determinerCode"
},
"path": "ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.determinerCode",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"fixedCode": "INSTANCE",
"representation": [ "xmlAttr" ]
}, {
"id": "ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.code",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "Person.sdtcAsPatientRelationship.code"
},
"path": "ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.code",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CE"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
} ]
}, {
"id": "ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "AssignedAuthor.assignedAuthoringDevice"
},
"path": "ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/AuthoringDevice"
} ],
"comment": "MAY contain assignedAuthoringDevice"
}, {
"path": "ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.realmCode",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.realmCode"
},
"path": "ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.realmCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question"
}, {
"id": "ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.typeId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "InfrastructureRoot.typeId"
},
"path": "ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.typeId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"constraint": [ {
"key": "II-1",
"human": "An II instance must have either a root or an nullFlavor.",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot",
"severity": "error",
"expression": "root.exists() or nullFlavor.exists()"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question."
}, {
"path": "ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.typeId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.typeId.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.typeId.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.typeId.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.typeId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.typeId.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.typeId.root",
"min": 1,
"definition": "Identifies the type as an HL7 Registered model",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "2.16.840.1.113883.1.3",
"label": "Root",
"id": "ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.typeId.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.typeId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.typeId.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.templateId",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
},
"path": "ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"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"
}, {
"path": "ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.classCode",
"fixedCode": "DEV",
"min": 0,
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-EntityClassDevice"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.classCode",
"base": {
"max": "1",
"min": 0,
"path": "AuthoringDevice.classCode"
}
}, {
"path": "ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.determinerCode",
"fixedCode": "INSTANCE",
"min": 0,
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-EntityDeterminer"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.determinerCode",
"base": {
"max": "1",
"min": 0,
"path": "AuthoringDevice.determinerCode"
}
}, {
"id": "ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.code",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "AuthoringDevice.code"
},
"path": "ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.code",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CE"
} ],
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDAEntityCode"
}
}, {
"id": "ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.manufacturerModelName",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 0,
"path": "AuthoringDevice.manufacturerModelName"
},
"path": "ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.manufacturerModelName",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/SC"
} ],
"binding": {
"strength": "example",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-ManufacturerModelNameExample"
},
"comment": "The assignedAuthoringDevice, if present, SHALL contain exactly one [1..1] manufacturerModelName (CONF:4537-16784)."
}, {
"id": "ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.softwareName",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 0,
"path": "AuthoringDevice.softwareName"
},
"path": "ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.softwareName",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/SC"
} ],
"binding": {
"strength": "example",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-SoftwareNameExample"
},
"comment": "The assignedAuthoringDevice, if present, SHALL contain exactly one [1..1] softwareName (CONF:4537-16785)."
}, {
"id": "ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.asMaintainedEntity",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "AuthoringDevice.asMaintainedEntity"
},
"path": "ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.asMaintainedEntity",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/MaintainedEntity"
} ]
}, {
"id": "ClinicalDocument.author.assignedAuthor.representedOrganization",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "AssignedAuthor.representedOrganization"
},
"path": "ClinicalDocument.author.assignedAuthor.representedOrganization",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Organization"
} ]
}, {
"id": "ClinicalDocument.dataEnterer",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "ClinicalDocument.dataEnterer"
},
"path": "ClinicalDocument.dataEnterer",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/DataEnterer"
} ],
"short": "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.",
"comment": "MAY contain zero or one [0..1] dataEnterer (CONF:4537-5441)."
}, {
"path": "ClinicalDocument.dataEnterer.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.dataEnterer.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "ClinicalDocument.dataEnterer.realmCode",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.realmCode"
},
"path": "ClinicalDocument.dataEnterer.realmCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question"
}, {
"id": "ClinicalDocument.dataEnterer.typeId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "InfrastructureRoot.typeId"
},
"path": "ClinicalDocument.dataEnterer.typeId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"constraint": [ {
"key": "II-1",
"human": "An II instance must have either a root or an nullFlavor.",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot",
"severity": "error",
"expression": "root.exists() or nullFlavor.exists()"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question."
}, {
"path": "ClinicalDocument.dataEnterer.typeId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.dataEnterer.typeId.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.dataEnterer.typeId.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "ClinicalDocument.dataEnterer.typeId.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "ClinicalDocument.dataEnterer.typeId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "ClinicalDocument.dataEnterer.typeId.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "ClinicalDocument.dataEnterer.typeId.root",
"min": 1,
"definition": "Identifies the type as an HL7 Registered model",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "2.16.840.1.113883.1.3",
"label": "Root",
"id": "ClinicalDocument.dataEnterer.typeId.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "ClinicalDocument.dataEnterer.typeId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "ClinicalDocument.dataEnterer.typeId.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "ClinicalDocument.dataEnterer.templateId",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
},
"path": "ClinicalDocument.dataEnterer.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"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"
}, {
"path": "ClinicalDocument.dataEnterer.typeCode",
"fixedCode": "ENT",
"min": 0,
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.dataEnterer.typeCode",
"base": {
"max": "1",
"min": 0,
"path": "DataEnterer.typeCode"
}
}, {
"path": "ClinicalDocument.dataEnterer.contextControlCode",
"fixedCode": "OP",
"min": 0,
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDAContextControl"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.dataEnterer.contextControlCode",
"base": {
"max": "1",
"min": 0,
"path": "DataEnterer.contextControlCode"
}
}, {
"id": "ClinicalDocument.dataEnterer.time",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "DataEnterer.time"
},
"path": "ClinicalDocument.dataEnterer.time",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/TS",
"profile": [ "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmDateTime" ]
} ]
}, {
"id": "ClinicalDocument.dataEnterer.assignedEntity",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "DataEnterer.assignedEntity"
},
"path": "ClinicalDocument.dataEnterer.assignedEntity",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity"
} ],
"comment": "The dataEnterer, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:4537-5442)."
}, {
"path": "ClinicalDocument.dataEnterer.assignedEntity.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.dataEnterer.assignedEntity.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "ClinicalDocument.dataEnterer.assignedEntity.realmCode",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.realmCode"
},
"path": "ClinicalDocument.dataEnterer.assignedEntity.realmCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question"
}, {
"id": "ClinicalDocument.dataEnterer.assignedEntity.typeId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "InfrastructureRoot.typeId"
},
"path": "ClinicalDocument.dataEnterer.assignedEntity.typeId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"constraint": [ {
"key": "II-1",
"human": "An II instance must have either a root or an nullFlavor.",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot",
"severity": "error",
"expression": "root.exists() or nullFlavor.exists()"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question."
}, {
"path": "ClinicalDocument.dataEnterer.assignedEntity.typeId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.dataEnterer.assignedEntity.typeId.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.dataEnterer.assignedEntity.typeId.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "ClinicalDocument.dataEnterer.assignedEntity.typeId.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "ClinicalDocument.dataEnterer.assignedEntity.typeId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "ClinicalDocument.dataEnterer.assignedEntity.typeId.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "ClinicalDocument.dataEnterer.assignedEntity.typeId.root",
"min": 1,
"definition": "Identifies the type as an HL7 Registered model",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "2.16.840.1.113883.1.3",
"label": "Root",
"id": "ClinicalDocument.dataEnterer.assignedEntity.typeId.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "ClinicalDocument.dataEnterer.assignedEntity.typeId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "ClinicalDocument.dataEnterer.assignedEntity.typeId.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "ClinicalDocument.dataEnterer.assignedEntity.templateId",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
},
"path": "ClinicalDocument.dataEnterer.assignedEntity.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"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"
}, {
"path": "ClinicalDocument.dataEnterer.assignedEntity.classCode",
"fixedCode": "ASSIGNED",
"min": 0,
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-RoleClassAssignedEntity"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.dataEnterer.assignedEntity.classCode",
"base": {
"max": "1",
"min": 0,
"path": "AssignedEntity.classCode"
}
}, {
"id": "ClinicalDocument.dataEnterer.assignedEntity.id",
"max": "*",
"min": 1,
"base": {
"max": "*",
"min": 1,
"path": "AssignedEntity.id"
},
"path": "ClinicalDocument.dataEnterer.assignedEntity.id",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"comment": "This assignedEntity SHALL contain at least one [1..*] id (CONF:4537-5443)."
}, {
"path": "ClinicalDocument.dataEnterer.assignedEntity.id.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.dataEnterer.assignedEntity.id.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.dataEnterer.assignedEntity.id.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "ClinicalDocument.dataEnterer.assignedEntity.id.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "ClinicalDocument.dataEnterer.assignedEntity.id.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "ClinicalDocument.dataEnterer.assignedEntity.id.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"constraint": [ {
"key": "should-npi",
"human": "SHOULD be NPI",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader",
"severity": "warning",
"expression": "$this = '2.16.840.1.113883.4.6'"
} ],
"path": "ClinicalDocument.dataEnterer.assignedEntity.id.root",
"min": 0,
"definition": "A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Root",
"id": "ClinicalDocument.dataEnterer.assignedEntity.id.root",
"comment": "Such ids SHOULD contain zero or one [0..1] @root=\"2.16.840.1.113883.4.6\" National Provider Identifier (CONF:4537-16821).",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "ClinicalDocument.dataEnterer.assignedEntity.id.extension",
"min": 0,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "ClinicalDocument.dataEnterer.assignedEntity.id.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "ClinicalDocument.dataEnterer.assignedEntity.sdtcIdentifiedBy",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "AssignedEntity.sdtcIdentifiedBy"
},
"path": "ClinicalDocument.dataEnterer.assignedEntity.sdtcIdentifiedBy",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "identifiedBy"
} ]
}, {
"id": "ClinicalDocument.dataEnterer.assignedEntity.code",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "AssignedEntity.code"
},
"path": "ClinicalDocument.dataEnterer.assignedEntity.code",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CE"
} ],
"binding": {
"strength": "preferred",
"valueSet": "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066"
},
"comment": "This assignedEntity MAY contain zero or one [0..1] code, which SHOULD be selected from ValueSet Healthcare Provider Taxonomy urn:oid:2.16.840.1.114222.4.11.1066 DYNAMIC (CONF:4537-32173)."
}, {
"id": "ClinicalDocument.dataEnterer.assignedEntity.addr",
"max": "*",
"min": 1,
"base": {
"max": "*",
"min": 0,
"path": "AssignedEntity.addr"
},
"path": "ClinicalDocument.dataEnterer.assignedEntity.addr",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/AD",
"profile": [ "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress" ]
} ],
"comment": "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:4537-5460)."
}, {
"id": "ClinicalDocument.dataEnterer.assignedEntity.telecom",
"max": "*",
"min": 1,
"base": {
"max": "*",
"min": 0,
"path": "AssignedEntity.telecom"
},
"path": "ClinicalDocument.dataEnterer.assignedEntity.telecom",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/TEL"
} ],
"comment": "This assignedEntity SHALL contain at least one [1..*] telecom (CONF:4537-5466).",
"constraint": [ {
"key": "should-use",
"human": "SHOULD contain @use",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader",
"severity": "warning",
"expression": "nullFlavor.exists() or use.exists()"
} ]
}, {
"path": "ClinicalDocument.dataEnterer.assignedEntity.telecom.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.dataEnterer.assignedEntity.telecom.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "ClinicalDocument.dataEnterer.assignedEntity.telecom.value",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "TEL.value"
},
"path": "ClinicalDocument.dataEnterer.assignedEntity.telecom.value",
"type": [ {
"code": "url",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/url" ]
} ],
"representation": [ "xmlAttr" ]
}, {
"path": "ClinicalDocument.dataEnterer.assignedEntity.telecom.useablePeriod",
"min": 0,
"definition": "Specifies the periods of time during which the telecommunication address can be used. For a telephone number, this can indicate the time of day in which the party can be reached on that telephone. For a web address, it may specify a time range in which the web content is promised to be available under the given address.",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS"
}, {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS"
}, {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS"
}, {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-defaulttype",
"valueCanonical": "http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS"
} ],
"representation": [ "typeAttr" ],
"max": "*",
"label": "Useable Period",
"id": "ClinicalDocument.dataEnterer.assignedEntity.telecom.useablePeriod",
"base": {
"max": "*",
"min": 0,
"path": "TEL.useablePeriod"
}
}, {
"path": "ClinicalDocument.dataEnterer.assignedEntity.telecom.use",
"min": 0,
"definition": "One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.20"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Use Code",
"id": "ClinicalDocument.dataEnterer.assignedEntity.telecom.use",
"comment": "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:4537-7996).",
"base": {
"max": "*",
"min": 0,
"path": "TEL.use"
}
}, {
"id": "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 0,
"path": "AssignedEntity.assignedPerson"
},
"path": "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Person"
} ],
"comment": "This assignedEntity SHALL contain exactly one [1..1] assignedPerson (CONF:4537-5469)."
}, {
"path": "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.realmCode",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.realmCode"
},
"path": "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.realmCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question"
}, {
"id": "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.typeId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "InfrastructureRoot.typeId"
},
"path": "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.typeId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"constraint": [ {
"key": "II-1",
"human": "An II instance must have either a root or an nullFlavor.",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot",
"severity": "error",
"expression": "root.exists() or nullFlavor.exists()"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question."
}, {
"path": "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.typeId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.typeId.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.typeId.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.typeId.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.typeId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.typeId.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.typeId.root",
"min": 1,
"definition": "Identifies the type as an HL7 Registered model",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "2.16.840.1.113883.1.3",
"label": "Root",
"id": "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.typeId.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.typeId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.typeId.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.templateId",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
},
"path": "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"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"
}, {
"path": "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.classCode",
"fixedCode": "PSN",
"min": 0,
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.classCode",
"base": {
"max": "1",
"min": 0,
"path": "Person.classCode"
}
}, {
"path": "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.determinerCode",
"fixedCode": "INSTANCE",
"min": 0,
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-EntityDeterminer"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.determinerCode",
"base": {
"max": "1",
"min": 0,
"path": "Person.determinerCode"
}
}, {
"id": "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.name",
"max": "*",
"min": 1,
"base": {
"max": "*",
"min": 0,
"path": "Person.name"
},
"path": "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.name",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/PN",
"profile": [ "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPersonNamePNUSFIELDED" ]
} ],
"comment": "This assignedPerson SHALL contain at least one [1..*] US Realm Person Name (PN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1.1) (CONF:4537-5470)."
}, {
"id": "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcDesc",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "Person.sdtcDesc"
},
"path": "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcDesc",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ED"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "desc"
} ],
"definition": "The desc extension allows multimedia depictions of patients, healthcare providers, or other individuals to be included in a CDA document."
}, {
"id": "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "Person.sdtcAsPatientRelationship"
},
"path": "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "asPatientRelationship"
} ],
"definition": "Each participant role other than an informant/relatedEntity may have zero or more relationship roles with the patient. Each of these roles can be expressed with an asPatientRelationship element which further describes the type of role using a code element."
}, {
"path": "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.realmCode",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.realmCode"
},
"path": "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.realmCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question"
}, {
"id": "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "InfrastructureRoot.typeId"
},
"path": "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"constraint": [ {
"key": "II-1",
"human": "An II instance must have either a root or an nullFlavor.",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/ClinicalDocument",
"severity": "error",
"expression": "root.exists() or nullFlavor.exists()"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question."
}, {
"path": "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.root",
"min": 1,
"definition": "Identifies the type as an HL7 Registered model",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "2.16.840.1.113883.1.3",
"label": "Root",
"id": "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.templateId",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
},
"path": "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"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"
}, {
"id": "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.classCode",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "Person.sdtcAsPatientRelationship.classCode"
},
"path": "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.classCode",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"fixedCode": "PRS",
"representation": [ "xmlAttr" ]
}, {
"id": "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.determinerCode",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "Person.sdtcAsPatientRelationship.determinerCode"
},
"path": "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.determinerCode",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"fixedCode": "INSTANCE",
"representation": [ "xmlAttr" ]
}, {
"id": "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.code",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "Person.sdtcAsPatientRelationship.code"
},
"path": "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.code",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CE"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
} ]
}, {
"id": "ClinicalDocument.dataEnterer.assignedEntity.representedOrganization",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "AssignedEntity.representedOrganization"
},
"path": "ClinicalDocument.dataEnterer.assignedEntity.representedOrganization",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Organization"
} ]
}, {
"id": "ClinicalDocument.dataEnterer.assignedEntity.sdtcPatient",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "AssignedEntity.sdtcPatient"
},
"path": "ClinicalDocument.dataEnterer.assignedEntity.sdtcPatient",
"type": [ {
"code": "http://hl7.org/fhir/StructureDefinition/Base"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "patient"
} ]
}, {
"id": "ClinicalDocument.dataEnterer.assignedEntity.sdtcPatient.id",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "AssignedEntity.sdtcPatient.id"
},
"path": "ClinicalDocument.dataEnterer.assignedEntity.sdtcPatient.id",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
} ]
}, {
"id": "ClinicalDocument.informant",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "ClinicalDocument.informant"
},
"path": "ClinicalDocument.informant",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Informant"
} ],
"comment": "MAY contain zero or more [0..*] informant (CONF:4537-31355) such that it",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "relatedEntity",
"type": "exists"
}, {
"path": "assignedEntity",
"type": "exists"
} ]
}
}, {
"path": "ClinicalDocument.informant",
"min": 0,
"short": "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.",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Informant"
} ],
"sliceName": "provider",
"max": "*",
"id": "ClinicalDocument.informant:provider",
"comment": "MAY contain zero or more [0..*] informant (CONF:4537-8001) such that it",
"base": {
"max": "*",
"min": 0,
"path": "ClinicalDocument.informant"
}
}, {
"path": "ClinicalDocument.informant.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.informant:provider.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "ClinicalDocument.informant:provider.realmCode",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.realmCode"
},
"path": "ClinicalDocument.informant.realmCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question"
}, {
"id": "ClinicalDocument.informant:provider.typeId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "InfrastructureRoot.typeId"
},
"path": "ClinicalDocument.informant.typeId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"constraint": [ {
"key": "II-1",
"human": "An II instance must have either a root or an nullFlavor.",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot",
"severity": "error",
"expression": "root.exists() or nullFlavor.exists()"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question."
}, {
"path": "ClinicalDocument.informant.typeId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.informant:provider.typeId.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.informant.typeId.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "ClinicalDocument.informant:provider.typeId.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "ClinicalDocument.informant.typeId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "ClinicalDocument.informant:provider.typeId.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "ClinicalDocument.informant.typeId.root",
"min": 1,
"definition": "Identifies the type as an HL7 Registered model",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "2.16.840.1.113883.1.3",
"label": "Root",
"id": "ClinicalDocument.informant:provider.typeId.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "ClinicalDocument.informant.typeId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "ClinicalDocument.informant:provider.typeId.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "ClinicalDocument.informant:provider.templateId",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
},
"path": "ClinicalDocument.informant.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"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"
}, {
"path": "ClinicalDocument.informant.typeCode",
"fixedCode": "INF",
"min": 0,
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.informant:provider.typeCode",
"base": {
"max": "1",
"min": 0,
"path": "Informant.typeCode"
}
}, {
"path": "ClinicalDocument.informant.contextControlCode",
"fixedCode": "OP",
"min": 0,
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDAContextControl"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.informant:provider.contextControlCode",
"base": {
"max": "1",
"min": 0,
"path": "Informant.contextControlCode"
}
}, {
"id": "ClinicalDocument.informant:provider.assignedEntity",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 0,
"path": "Informant.assignedEntity"
},
"path": "ClinicalDocument.informant.assignedEntity",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity"
} ],
"comment": "SHALL contain exactly one [1..1] assignedEntity (CONF:4537-8002)."
}, {
"path": "ClinicalDocument.informant.assignedEntity.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.informant:provider.assignedEntity.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "ClinicalDocument.informant:provider.assignedEntity.realmCode",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.realmCode"
},
"path": "ClinicalDocument.informant.assignedEntity.realmCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question"
}, {
"id": "ClinicalDocument.informant:provider.assignedEntity.typeId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "InfrastructureRoot.typeId"
},
"path": "ClinicalDocument.informant.assignedEntity.typeId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"constraint": [ {
"key": "II-1",
"human": "An II instance must have either a root or an nullFlavor.",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot",
"severity": "error",
"expression": "root.exists() or nullFlavor.exists()"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question."
}, {
"path": "ClinicalDocument.informant.assignedEntity.typeId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.informant:provider.assignedEntity.typeId.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.informant.assignedEntity.typeId.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "ClinicalDocument.informant:provider.assignedEntity.typeId.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "ClinicalDocument.informant.assignedEntity.typeId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "ClinicalDocument.informant:provider.assignedEntity.typeId.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "ClinicalDocument.informant.assignedEntity.typeId.root",
"min": 1,
"definition": "Identifies the type as an HL7 Registered model",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "2.16.840.1.113883.1.3",
"label": "Root",
"id": "ClinicalDocument.informant:provider.assignedEntity.typeId.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "ClinicalDocument.informant.assignedEntity.typeId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "ClinicalDocument.informant:provider.assignedEntity.typeId.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "ClinicalDocument.informant:provider.assignedEntity.templateId",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
},
"path": "ClinicalDocument.informant.assignedEntity.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"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"
}, {
"path": "ClinicalDocument.informant.assignedEntity.classCode",
"fixedCode": "ASSIGNED",
"min": 0,
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-RoleClassAssignedEntity"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.informant:provider.assignedEntity.classCode",
"base": {
"max": "1",
"min": 0,
"path": "AssignedEntity.classCode"
}
}, {
"id": "ClinicalDocument.informant:provider.assignedEntity.id",
"max": "*",
"min": 1,
"base": {
"max": "*",
"min": 1,
"path": "AssignedEntity.id"
},
"path": "ClinicalDocument.informant.assignedEntity.id",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"short": "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:4537-9946).",
"comment": "This assignedEntity SHALL contain at least one [1..*] id (CONF:4537-9945)."
}, {
"id": "ClinicalDocument.informant:provider.assignedEntity.sdtcIdentifiedBy",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "AssignedEntity.sdtcIdentifiedBy"
},
"path": "ClinicalDocument.informant.assignedEntity.sdtcIdentifiedBy",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "identifiedBy"
} ]
}, {
"id": "ClinicalDocument.informant:provider.assignedEntity.code",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "AssignedEntity.code"
},
"path": "ClinicalDocument.informant.assignedEntity.code",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CE"
} ],
"binding": {
"strength": "preferred",
"valueSet": "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066"
},
"comment": "This assignedEntity MAY contain zero or one [0..1] code, which SHOULD be selected from ValueSet Healthcare Provider Taxonomy urn:oid:2.16.840.1.114222.4.11.1066 DYNAMIC (CONF:4537-32174)."
}, {
"id": "ClinicalDocument.informant:provider.assignedEntity.addr",
"max": "*",
"min": 1,
"base": {
"max": "*",
"min": 0,
"path": "AssignedEntity.addr"
},
"path": "ClinicalDocument.informant.assignedEntity.addr",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/AD",
"profile": [ "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress" ]
} ],
"comment": "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:4537-8220)."
}, {
"id": "ClinicalDocument.informant:provider.assignedEntity.telecom",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "AssignedEntity.telecom"
},
"path": "ClinicalDocument.informant.assignedEntity.telecom",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/TEL"
} ]
}, {
"id": "ClinicalDocument.informant:provider.assignedEntity.assignedPerson",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 0,
"path": "AssignedEntity.assignedPerson"
},
"path": "ClinicalDocument.informant.assignedEntity.assignedPerson",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Person"
} ],
"comment": "This assignedEntity SHALL contain exactly one [1..1] assignedPerson (CONF:4537-8221)."
}, {
"path": "ClinicalDocument.informant.assignedEntity.assignedPerson.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.informant:provider.assignedEntity.assignedPerson.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "ClinicalDocument.informant:provider.assignedEntity.assignedPerson.realmCode",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.realmCode"
},
"path": "ClinicalDocument.informant.assignedEntity.assignedPerson.realmCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question"
}, {
"id": "ClinicalDocument.informant:provider.assignedEntity.assignedPerson.typeId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "InfrastructureRoot.typeId"
},
"path": "ClinicalDocument.informant.assignedEntity.assignedPerson.typeId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"constraint": [ {
"key": "II-1",
"human": "An II instance must have either a root or an nullFlavor.",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot",
"severity": "error",
"expression": "root.exists() or nullFlavor.exists()"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question."
}, {
"path": "ClinicalDocument.informant.assignedEntity.assignedPerson.typeId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.informant:provider.assignedEntity.assignedPerson.typeId.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.informant.assignedEntity.assignedPerson.typeId.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "ClinicalDocument.informant:provider.assignedEntity.assignedPerson.typeId.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "ClinicalDocument.informant.assignedEntity.assignedPerson.typeId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "ClinicalDocument.informant:provider.assignedEntity.assignedPerson.typeId.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "ClinicalDocument.informant.assignedEntity.assignedPerson.typeId.root",
"min": 1,
"definition": "Identifies the type as an HL7 Registered model",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "2.16.840.1.113883.1.3",
"label": "Root",
"id": "ClinicalDocument.informant:provider.assignedEntity.assignedPerson.typeId.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "ClinicalDocument.informant.assignedEntity.assignedPerson.typeId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "ClinicalDocument.informant:provider.assignedEntity.assignedPerson.typeId.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "ClinicalDocument.informant:provider.assignedEntity.assignedPerson.templateId",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
},
"path": "ClinicalDocument.informant.assignedEntity.assignedPerson.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"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"
}, {
"path": "ClinicalDocument.informant.assignedEntity.assignedPerson.classCode",
"fixedCode": "PSN",
"min": 0,
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.informant:provider.assignedEntity.assignedPerson.classCode",
"base": {
"max": "1",
"min": 0,
"path": "Person.classCode"
}
}, {
"path": "ClinicalDocument.informant.assignedEntity.assignedPerson.determinerCode",
"fixedCode": "INSTANCE",
"min": 0,
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-EntityDeterminer"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.informant:provider.assignedEntity.assignedPerson.determinerCode",
"base": {
"max": "1",
"min": 0,
"path": "Person.determinerCode"
}
}, {
"id": "ClinicalDocument.informant:provider.assignedEntity.assignedPerson.name",
"max": "*",
"min": 1,
"base": {
"max": "*",
"min": 0,
"path": "Person.name"
},
"path": "ClinicalDocument.informant.assignedEntity.assignedPerson.name",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/PN",
"profile": [ "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPersonNamePNUSFIELDED" ]
} ],
"comment": "This assignedPerson SHALL contain at least one [1..*] US Realm Person Name (PN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1.1) (CONF:4537-8222)."
}, {
"id": "ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcDesc",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "Person.sdtcDesc"
},
"path": "ClinicalDocument.informant.assignedEntity.assignedPerson.sdtcDesc",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ED"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "desc"
} ],
"definition": "The desc extension allows multimedia depictions of patients, healthcare providers, or other individuals to be included in a CDA document."
}, {
"id": "ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcAsPatientRelationship",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "Person.sdtcAsPatientRelationship"
},
"path": "ClinicalDocument.informant.assignedEntity.assignedPerson.sdtcAsPatientRelationship",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "asPatientRelationship"
} ],
"definition": "Each participant role other than an informant/relatedEntity may have zero or more relationship roles with the patient. Each of these roles can be expressed with an asPatientRelationship element which further describes the type of role using a code element."
}, {
"path": "ClinicalDocument.informant.assignedEntity.assignedPerson.sdtcAsPatientRelationship.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcAsPatientRelationship.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcAsPatientRelationship.realmCode",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.realmCode"
},
"path": "ClinicalDocument.informant.assignedEntity.assignedPerson.sdtcAsPatientRelationship.realmCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question"
}, {
"id": "ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "InfrastructureRoot.typeId"
},
"path": "ClinicalDocument.informant.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"constraint": [ {
"key": "II-1",
"human": "An II instance must have either a root or an nullFlavor.",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/ClinicalDocument",
"severity": "error",
"expression": "root.exists() or nullFlavor.exists()"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question."
}, {
"path": "ClinicalDocument.informant.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.informant.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "ClinicalDocument.informant.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "ClinicalDocument.informant.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.root",
"min": 1,
"definition": "Identifies the type as an HL7 Registered model",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "2.16.840.1.113883.1.3",
"label": "Root",
"id": "ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "ClinicalDocument.informant.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcAsPatientRelationship.templateId",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
},
"path": "ClinicalDocument.informant.assignedEntity.assignedPerson.sdtcAsPatientRelationship.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"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"
}, {
"id": "ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcAsPatientRelationship.classCode",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "Person.sdtcAsPatientRelationship.classCode"
},
"path": "ClinicalDocument.informant.assignedEntity.assignedPerson.sdtcAsPatientRelationship.classCode",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"fixedCode": "PRS",
"representation": [ "xmlAttr" ]
}, {
"id": "ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcAsPatientRelationship.determinerCode",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "Person.sdtcAsPatientRelationship.determinerCode"
},
"path": "ClinicalDocument.informant.assignedEntity.assignedPerson.sdtcAsPatientRelationship.determinerCode",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"fixedCode": "INSTANCE",
"representation": [ "xmlAttr" ]
}, {
"id": "ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcAsPatientRelationship.code",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "Person.sdtcAsPatientRelationship.code"
},
"path": "ClinicalDocument.informant.assignedEntity.assignedPerson.sdtcAsPatientRelationship.code",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CE"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
} ]
}, {
"id": "ClinicalDocument.informant:provider.assignedEntity.representedOrganization",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "AssignedEntity.representedOrganization"
},
"path": "ClinicalDocument.informant.assignedEntity.representedOrganization",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Organization"
} ]
}, {
"id": "ClinicalDocument.informant:provider.assignedEntity.sdtcPatient",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "AssignedEntity.sdtcPatient"
},
"path": "ClinicalDocument.informant.assignedEntity.sdtcPatient",
"type": [ {
"code": "http://hl7.org/fhir/StructureDefinition/Base"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "patient"
} ]
}, {
"id": "ClinicalDocument.informant:provider.assignedEntity.sdtcPatient.id",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "AssignedEntity.sdtcPatient.id"
},
"path": "ClinicalDocument.informant.assignedEntity.sdtcPatient.id",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
} ]
}, {
"id": "ClinicalDocument.informant:provider.relatedEntity",
"max": "0",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "Informant.relatedEntity"
},
"path": "ClinicalDocument.informant.relatedEntity",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/RelatedEntity"
} ]
}, {
"id": "ClinicalDocument.informant:non-provider",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "ClinicalDocument.informant"
},
"path": "ClinicalDocument.informant",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Informant"
} ],
"short": "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.",
"sliceName": "non-provider"
}, {
"path": "ClinicalDocument.informant.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.informant:non-provider.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "ClinicalDocument.informant:non-provider.realmCode",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.realmCode"
},
"path": "ClinicalDocument.informant.realmCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question"
}, {
"id": "ClinicalDocument.informant:non-provider.typeId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "InfrastructureRoot.typeId"
},
"path": "ClinicalDocument.informant.typeId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"constraint": [ {
"key": "II-1",
"human": "An II instance must have either a root or an nullFlavor.",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot",
"severity": "error",
"expression": "root.exists() or nullFlavor.exists()"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question."
}, {
"path": "ClinicalDocument.informant.typeId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.informant:non-provider.typeId.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.informant.typeId.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "ClinicalDocument.informant:non-provider.typeId.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "ClinicalDocument.informant.typeId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "ClinicalDocument.informant:non-provider.typeId.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "ClinicalDocument.informant.typeId.root",
"min": 1,
"definition": "Identifies the type as an HL7 Registered model",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "2.16.840.1.113883.1.3",
"label": "Root",
"id": "ClinicalDocument.informant:non-provider.typeId.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "ClinicalDocument.informant.typeId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "ClinicalDocument.informant:non-provider.typeId.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "ClinicalDocument.informant:non-provider.templateId",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
},
"path": "ClinicalDocument.informant.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"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"
}, {
"path": "ClinicalDocument.informant.typeCode",
"fixedCode": "INF",
"min": 0,
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.informant:non-provider.typeCode",
"base": {
"max": "1",
"min": 0,
"path": "Informant.typeCode"
}
}, {
"path": "ClinicalDocument.informant.contextControlCode",
"fixedCode": "OP",
"min": 0,
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDAContextControl"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.informant:non-provider.contextControlCode",
"base": {
"max": "1",
"min": 0,
"path": "Informant.contextControlCode"
}
}, {
"id": "ClinicalDocument.informant:non-provider.assignedEntity",
"max": "0",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "Informant.assignedEntity"
},
"path": "ClinicalDocument.informant.assignedEntity",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity"
} ]
}, {
"id": "ClinicalDocument.informant:non-provider.relatedEntity",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 0,
"path": "Informant.relatedEntity"
},
"path": "ClinicalDocument.informant.relatedEntity",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/RelatedEntity"
} ],
"comment": "SHALL contain exactly one [1..1] relatedEntity (CONF:4537-31356)."
}, {
"id": "ClinicalDocument.custodian",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "ClinicalDocument.custodian"
},
"path": "ClinicalDocument.custodian",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Custodian"
} ],
"short": "The custodian element represents the organization that is in charge of maintaining and is entrusted with the care of the document.\n\n 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.",
"comment": "SHALL contain exactly one [1..1] custodian (CONF:4537-5519)."
}, {
"path": "ClinicalDocument.custodian.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.custodian.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "ClinicalDocument.custodian.realmCode",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.realmCode"
},
"path": "ClinicalDocument.custodian.realmCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question"
}, {
"id": "ClinicalDocument.custodian.typeId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "InfrastructureRoot.typeId"
},
"path": "ClinicalDocument.custodian.typeId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"constraint": [ {
"key": "II-1",
"human": "An II instance must have either a root or an nullFlavor.",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot",
"severity": "error",
"expression": "root.exists() or nullFlavor.exists()"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question."
}, {
"path": "ClinicalDocument.custodian.typeId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.custodian.typeId.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.custodian.typeId.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "ClinicalDocument.custodian.typeId.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "ClinicalDocument.custodian.typeId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "ClinicalDocument.custodian.typeId.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "ClinicalDocument.custodian.typeId.root",
"min": 1,
"definition": "Identifies the type as an HL7 Registered model",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "2.16.840.1.113883.1.3",
"label": "Root",
"id": "ClinicalDocument.custodian.typeId.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "ClinicalDocument.custodian.typeId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "ClinicalDocument.custodian.typeId.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "ClinicalDocument.custodian.templateId",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
},
"path": "ClinicalDocument.custodian.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"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"
}, {
"path": "ClinicalDocument.custodian.typeCode",
"fixedCode": "CST",
"min": 0,
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.custodian.typeCode",
"base": {
"max": "1",
"min": 0,
"path": "Custodian.typeCode"
}
}, {
"id": "ClinicalDocument.custodian.assignedCustodian",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "Custodian.assignedCustodian"
},
"path": "ClinicalDocument.custodian.assignedCustodian",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/AssignedCustodian"
} ],
"comment": "This custodian SHALL contain exactly one [1..1] assignedCustodian (CONF:4537-5520)."
}, {
"path": "ClinicalDocument.custodian.assignedCustodian.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.custodian.assignedCustodian.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "ClinicalDocument.custodian.assignedCustodian.realmCode",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.realmCode"
},
"path": "ClinicalDocument.custodian.assignedCustodian.realmCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question"
}, {
"id": "ClinicalDocument.custodian.assignedCustodian.typeId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "InfrastructureRoot.typeId"
},
"path": "ClinicalDocument.custodian.assignedCustodian.typeId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"constraint": [ {
"key": "II-1",
"human": "An II instance must have either a root or an nullFlavor.",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot",
"severity": "error",
"expression": "root.exists() or nullFlavor.exists()"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question."
}, {
"path": "ClinicalDocument.custodian.assignedCustodian.typeId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.custodian.assignedCustodian.typeId.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.custodian.assignedCustodian.typeId.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "ClinicalDocument.custodian.assignedCustodian.typeId.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "ClinicalDocument.custodian.assignedCustodian.typeId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "ClinicalDocument.custodian.assignedCustodian.typeId.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "ClinicalDocument.custodian.assignedCustodian.typeId.root",
"min": 1,
"definition": "Identifies the type as an HL7 Registered model",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "2.16.840.1.113883.1.3",
"label": "Root",
"id": "ClinicalDocument.custodian.assignedCustodian.typeId.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "ClinicalDocument.custodian.assignedCustodian.typeId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "ClinicalDocument.custodian.assignedCustodian.typeId.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "ClinicalDocument.custodian.assignedCustodian.templateId",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
},
"path": "ClinicalDocument.custodian.assignedCustodian.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"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"
}, {
"path": "ClinicalDocument.custodian.assignedCustodian.classCode",
"fixedCode": "ASSIGNED",
"min": 0,
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-RoleClassAssignedEntity"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.custodian.assignedCustodian.classCode",
"base": {
"max": "1",
"min": 0,
"path": "AssignedCustodian.classCode"
}
}, {
"id": "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "AssignedCustodian.representedCustodianOrganization"
},
"path": "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CustodianOrganization"
} ],
"comment": "This assignedCustodian SHALL contain exactly one [1..1] representedCustodianOrganization (CONF:4537-5521)."
}, {
"path": "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.realmCode",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.realmCode"
},
"path": "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.realmCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question"
}, {
"id": "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.typeId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "InfrastructureRoot.typeId"
},
"path": "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.typeId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"constraint": [ {
"key": "II-1",
"human": "An II instance must have either a root or an nullFlavor.",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot",
"severity": "error",
"expression": "root.exists() or nullFlavor.exists()"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question."
}, {
"path": "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.typeId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.typeId.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.typeId.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.typeId.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.typeId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.typeId.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.typeId.root",
"min": 1,
"definition": "Identifies the type as an HL7 Registered model",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "2.16.840.1.113883.1.3",
"label": "Root",
"id": "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.typeId.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.typeId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.typeId.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.templateId",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
},
"path": "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"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"
}, {
"path": "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.classCode",
"fixedCode": "ORG",
"min": 0,
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-EntityClassOrganization"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.classCode",
"base": {
"max": "1",
"min": 0,
"path": "CustodianOrganization.classCode"
}
}, {
"path": "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.determinerCode",
"fixedCode": "INSTANCE",
"min": 0,
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-EntityDeterminer"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.determinerCode",
"base": {
"max": "1",
"min": 0,
"path": "CustodianOrganization.determinerCode"
}
}, {
"id": "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id",
"max": "*",
"min": 1,
"base": {
"max": "*",
"min": 1,
"path": "CustodianOrganization.id"
},
"path": "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"comment": "This representedCustodianOrganization SHALL contain at least one [1..*] id (CONF:4537-5522)."
}, {
"path": "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"constraint": [ {
"key": "should-npi",
"human": "SHOULD be NPI",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader",
"severity": "warning",
"expression": "$this = '2.16.840.1.113883.4.6'"
} ],
"path": "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id.root",
"min": 0,
"definition": "A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Root",
"id": "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id.root",
"comment": "Such ids SHOULD contain zero or one [0..1] @root=\"2.16.840.1.113883.4.6\" National Provider Identifier (CONF:4537-16822).",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id.extension",
"min": 0,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.name",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 0,
"path": "CustodianOrganization.name"
},
"path": "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.name",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ON"
} ],
"comment": "This representedCustodianOrganization SHALL contain exactly one [1..1] name (CONF:4537-5524)."
}, {
"id": "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.telecom",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 0,
"path": "CustodianOrganization.telecom"
},
"path": "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.telecom",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/TEL"
} ],
"comment": "This representedCustodianOrganization SHALL contain exactly one [1..1] telecom (CONF:4537-5525).",
"constraint": [ {
"key": "should-use",
"human": "SHOULD contain @use",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader",
"severity": "warning",
"expression": "nullFlavor.exists() or use.exists()"
} ]
}, {
"path": "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.telecom.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.telecom.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.telecom.value",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "TEL.value"
},
"path": "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.telecom.value",
"type": [ {
"code": "url",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/url" ]
} ],
"representation": [ "xmlAttr" ]
}, {
"path": "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.telecom.useablePeriod",
"min": 0,
"definition": "Specifies the periods of time during which the telecommunication address can be used. For a telephone number, this can indicate the time of day in which the party can be reached on that telephone. For a web address, it may specify a time range in which the web content is promised to be available under the given address.",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS"
}, {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS"
}, {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS"
}, {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-defaulttype",
"valueCanonical": "http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS"
} ],
"representation": [ "typeAttr" ],
"max": "*",
"label": "Useable Period",
"id": "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.telecom.useablePeriod",
"base": {
"max": "*",
"min": 0,
"path": "TEL.useablePeriod"
}
}, {
"path": "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.telecom.use",
"min": 0,
"definition": "One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.20"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Use Code",
"id": "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.telecom.use",
"comment": "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:4537-7998).",
"base": {
"max": "*",
"min": 0,
"path": "TEL.use"
}
}, {
"id": "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.sdtcTelecom",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "CustodianOrganization.sdtcTelecom"
},
"path": "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.sdtcTelecom",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/TEL"
} ],
"short": "The stdc:telecom extension can be used to provide additional telecom elements for the custodian organization.",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "telecom"
} ]
}, {
"id": "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.addr",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 0,
"path": "CustodianOrganization.addr"
},
"path": "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.addr",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/AD",
"profile": [ "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress" ]
} ],
"comment": "This representedCustodianOrganization SHALL contain exactly one [1..1] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:4537-5559)."
}, {
"id": "ClinicalDocument.informationRecipient",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "ClinicalDocument.informationRecipient"
},
"path": "ClinicalDocument.informationRecipient",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/InformationRecipient"
} ],
"short": "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.",
"comment": "MAY contain zero or more [0..*] informationRecipient (CONF:1198-32482)."
}, {
"path": "ClinicalDocument.informationRecipient.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.informationRecipient.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "ClinicalDocument.informationRecipient.realmCode",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.realmCode"
},
"path": "ClinicalDocument.informationRecipient.realmCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question"
}, {
"id": "ClinicalDocument.informationRecipient.typeId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "InfrastructureRoot.typeId"
},
"path": "ClinicalDocument.informationRecipient.typeId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"constraint": [ {
"key": "II-1",
"human": "An II instance must have either a root or an nullFlavor.",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot",
"severity": "error",
"expression": "root.exists() or nullFlavor.exists()"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question."
}, {
"path": "ClinicalDocument.informationRecipient.typeId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.informationRecipient.typeId.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.informationRecipient.typeId.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "ClinicalDocument.informationRecipient.typeId.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "ClinicalDocument.informationRecipient.typeId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "ClinicalDocument.informationRecipient.typeId.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "ClinicalDocument.informationRecipient.typeId.root",
"min": 1,
"definition": "Identifies the type as an HL7 Registered model",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "2.16.840.1.113883.1.3",
"label": "Root",
"id": "ClinicalDocument.informationRecipient.typeId.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "ClinicalDocument.informationRecipient.typeId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "ClinicalDocument.informationRecipient.typeId.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "ClinicalDocument.informationRecipient.templateId",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
},
"path": "ClinicalDocument.informationRecipient.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"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"
}, {
"path": "ClinicalDocument.informationRecipient.typeCode",
"min": 0,
"defaultValueCode": "PRCP",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-xInformationRecipient|2.0.0"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.informationRecipient.typeCode",
"base": {
"max": "1",
"min": 0,
"path": "InformationRecipient.typeCode"
}
}, {
"id": "ClinicalDocument.informationRecipient.intendedRecipient",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "InformationRecipient.intendedRecipient"
},
"path": "ClinicalDocument.informationRecipient.intendedRecipient",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/IntendedRecipient"
} ],
"comment": "The informationRecipient, if present, SHALL contain exactly one [1..1] intendedRecipient (CONF:1198-32483)."
}, {
"path": "ClinicalDocument.informationRecipient.intendedRecipient.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.informationRecipient.intendedRecipient.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "ClinicalDocument.informationRecipient.intendedRecipient.realmCode",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.realmCode"
},
"path": "ClinicalDocument.informationRecipient.intendedRecipient.realmCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question"
}, {
"id": "ClinicalDocument.informationRecipient.intendedRecipient.typeId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "InfrastructureRoot.typeId"
},
"path": "ClinicalDocument.informationRecipient.intendedRecipient.typeId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"constraint": [ {
"key": "II-1",
"human": "An II instance must have either a root or an nullFlavor.",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot",
"severity": "error",
"expression": "root.exists() or nullFlavor.exists()"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question."
}, {
"path": "ClinicalDocument.informationRecipient.intendedRecipient.typeId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.informationRecipient.intendedRecipient.typeId.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.informationRecipient.intendedRecipient.typeId.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "ClinicalDocument.informationRecipient.intendedRecipient.typeId.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "ClinicalDocument.informationRecipient.intendedRecipient.typeId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "ClinicalDocument.informationRecipient.intendedRecipient.typeId.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "ClinicalDocument.informationRecipient.intendedRecipient.typeId.root",
"min": 1,
"definition": "Identifies the type as an HL7 Registered model",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "2.16.840.1.113883.1.3",
"label": "Root",
"id": "ClinicalDocument.informationRecipient.intendedRecipient.typeId.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "ClinicalDocument.informationRecipient.intendedRecipient.typeId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "ClinicalDocument.informationRecipient.intendedRecipient.typeId.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "ClinicalDocument.informationRecipient.intendedRecipient.templateId",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
},
"path": "ClinicalDocument.informationRecipient.intendedRecipient.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"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"
}, {
"path": "ClinicalDocument.informationRecipient.intendedRecipient.classCode",
"min": 0,
"defaultValueCode": "ASSIGNED",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDAInformationRecipientRole"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.informationRecipient.intendedRecipient.classCode",
"base": {
"max": "1",
"min": 0,
"path": "IntendedRecipient.classCode"
}
}, {
"id": "ClinicalDocument.informationRecipient.intendedRecipient.id",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "IntendedRecipient.id"
},
"path": "ClinicalDocument.informationRecipient.intendedRecipient.id",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"comment": "This intendedRecipient MAY contain zero or more [0..*] id (CONF:4537-32399)."
}, {
"id": "ClinicalDocument.informationRecipient.intendedRecipient.sdtcIdentifiedBy",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "IntendedRecipient.sdtcIdentifiedBy"
},
"path": "ClinicalDocument.informationRecipient.intendedRecipient.sdtcIdentifiedBy",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "identifiedBy"
} ]
}, {
"id": "ClinicalDocument.informationRecipient.intendedRecipient.addr",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "IntendedRecipient.addr"
},
"path": "ClinicalDocument.informationRecipient.intendedRecipient.addr",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/AD"
} ]
}, {
"id": "ClinicalDocument.informationRecipient.intendedRecipient.telecom",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "IntendedRecipient.telecom"
},
"path": "ClinicalDocument.informationRecipient.intendedRecipient.telecom",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/TEL"
} ]
}, {
"id": "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "IntendedRecipient.informationRecipient"
},
"path": "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Person"
} ],
"comment": "This intendedRecipient MAY contain zero or one [0..1] informationRecipient (CONF:4537-5567)."
}, {
"path": "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.realmCode",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.realmCode"
},
"path": "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.realmCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question"
}, {
"id": "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.typeId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "InfrastructureRoot.typeId"
},
"path": "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.typeId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"constraint": [ {
"key": "II-1",
"human": "An II instance must have either a root or an nullFlavor.",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot",
"severity": "error",
"expression": "root.exists() or nullFlavor.exists()"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question."
}, {
"path": "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.typeId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.typeId.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.typeId.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.typeId.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.typeId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.typeId.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.typeId.root",
"min": 1,
"definition": "Identifies the type as an HL7 Registered model",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "2.16.840.1.113883.1.3",
"label": "Root",
"id": "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.typeId.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.typeId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.typeId.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.templateId",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
},
"path": "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"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"
}, {
"path": "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.classCode",
"fixedCode": "PSN",
"min": 0,
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.classCode",
"base": {
"max": "1",
"min": 0,
"path": "Person.classCode"
}
}, {
"path": "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.determinerCode",
"fixedCode": "INSTANCE",
"min": 0,
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-EntityDeterminer"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.determinerCode",
"base": {
"max": "1",
"min": 0,
"path": "Person.determinerCode"
}
}, {
"id": "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.name",
"max": "*",
"min": 1,
"base": {
"max": "*",
"min": 0,
"path": "Person.name"
},
"path": "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.name",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/PN",
"profile": [ "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPersonNamePNUSFIELDED" ]
} ],
"comment": "The informationRecipient, if present, SHALL contain at least one [1..*] US Realm Person Name (PN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1.1) (CONF:4537-5568)."
}, {
"id": "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcDesc",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "Person.sdtcDesc"
},
"path": "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcDesc",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ED"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "desc"
} ],
"definition": "The desc extension allows multimedia depictions of patients, healthcare providers, or other individuals to be included in a CDA document."
}, {
"id": "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "Person.sdtcAsPatientRelationship"
},
"path": "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "asPatientRelationship"
} ],
"definition": "Each participant role other than an informant/relatedEntity may have zero or more relationship roles with the patient. Each of these roles can be expressed with an asPatientRelationship element which further describes the type of role using a code element."
}, {
"path": "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.realmCode",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.realmCode"
},
"path": "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.realmCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question"
}, {
"id": "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.typeId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "InfrastructureRoot.typeId"
},
"path": "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.typeId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"constraint": [ {
"key": "II-1",
"human": "An II instance must have either a root or an nullFlavor.",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/ClinicalDocument",
"severity": "error",
"expression": "root.exists() or nullFlavor.exists()"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question."
}, {
"path": "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.typeId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.typeId.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.typeId.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.typeId.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.typeId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.typeId.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.typeId.root",
"min": 1,
"definition": "Identifies the type as an HL7 Registered model",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "2.16.840.1.113883.1.3",
"label": "Root",
"id": "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.typeId.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.typeId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.typeId.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.templateId",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
},
"path": "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"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"
}, {
"id": "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.classCode",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "Person.sdtcAsPatientRelationship.classCode"
},
"path": "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.classCode",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"fixedCode": "PRS",
"representation": [ "xmlAttr" ]
}, {
"id": "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.determinerCode",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "Person.sdtcAsPatientRelationship.determinerCode"
},
"path": "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.determinerCode",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"fixedCode": "INSTANCE",
"representation": [ "xmlAttr" ]
}, {
"id": "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.code",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "Person.sdtcAsPatientRelationship.code"
},
"path": "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.code",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CE"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
} ]
}, {
"id": "ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "IntendedRecipient.receivedOrganization"
},
"path": "ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Organization"
} ],
"comment": "This intendedRecipient MAY contain zero or one [0..1] receivedOrganization (CONF:4537-5577)."
}, {
"path": "ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.realmCode",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.realmCode"
},
"path": "ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.realmCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question"
}, {
"id": "ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.typeId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "InfrastructureRoot.typeId"
},
"path": "ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.typeId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"constraint": [ {
"key": "II-1",
"human": "An II instance must have either a root or an nullFlavor.",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot",
"severity": "error",
"expression": "root.exists() or nullFlavor.exists()"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question."
}, {
"path": "ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.typeId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.typeId.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.typeId.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.typeId.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.typeId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.typeId.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.typeId.root",
"min": 1,
"definition": "Identifies the type as an HL7 Registered model",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "2.16.840.1.113883.1.3",
"label": "Root",
"id": "ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.typeId.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.typeId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.typeId.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.templateId",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
},
"path": "ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"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"
}, {
"path": "ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.classCode",
"fixedCode": "ORG",
"min": 0,
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-EntityClassOrganization"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.classCode",
"base": {
"max": "1",
"min": 0,
"path": "Organization.classCode"
}
}, {
"path": "ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.determinerCode",
"fixedCode": "INSTANCE",
"min": 0,
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-EntityDeterminer"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.determinerCode",
"base": {
"max": "1",
"min": 0,
"path": "Organization.determinerCode"
}
}, {
"id": "ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.id",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "Organization.id"
},
"path": "ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.id",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ]
}, {
"id": "ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.name",
"max": "1",
"min": 1,
"base": {
"max": "*",
"min": 0,
"path": "Organization.name"
},
"path": "ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.name",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ON"
} ],
"comment": "The receivedOrganization, if present, SHALL contain exactly one [1..1] name (CONF:4537-5578)."
}, {
"id": "ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.telecom",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "Organization.telecom"
},
"path": "ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.telecom",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/TEL"
} ]
}, {
"id": "ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.addr",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "Organization.addr"
},
"path": "ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.addr",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/AD"
} ]
}, {
"id": "ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.standardIndustryClassCode",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "Organization.standardIndustryClassCode"
},
"path": "ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.standardIndustryClassCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CE"
} ],
"binding": {
"strength": "example",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-OrganizationIndustryClassNAICS"
}
}, {
"id": "ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.asOrganizationPartOf",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "Organization.asOrganizationPartOf"
},
"path": "ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.asOrganizationPartOf",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/OrganizationPartOf"
} ]
}, {
"id": "ClinicalDocument.legalAuthenticator",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "ClinicalDocument.legalAuthenticator"
},
"path": "ClinicalDocument.legalAuthenticator",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/LegalAuthenticator"
} ],
"short": "The 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.",
"comment": "SHOULD contain zero or one [0..1] legalAuthenticator (CONF:4537-5579)."
}, {
"path": "ClinicalDocument.legalAuthenticator.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.legalAuthenticator.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "ClinicalDocument.legalAuthenticator.realmCode",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.realmCode"
},
"path": "ClinicalDocument.legalAuthenticator.realmCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question"
}, {
"id": "ClinicalDocument.legalAuthenticator.typeId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "InfrastructureRoot.typeId"
},
"path": "ClinicalDocument.legalAuthenticator.typeId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"constraint": [ {
"key": "II-1",
"human": "An II instance must have either a root or an nullFlavor.",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot",
"severity": "error",
"expression": "root.exists() or nullFlavor.exists()"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question."
}, {
"path": "ClinicalDocument.legalAuthenticator.typeId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.legalAuthenticator.typeId.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.legalAuthenticator.typeId.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "ClinicalDocument.legalAuthenticator.typeId.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "ClinicalDocument.legalAuthenticator.typeId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "ClinicalDocument.legalAuthenticator.typeId.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "ClinicalDocument.legalAuthenticator.typeId.root",
"min": 1,
"definition": "Identifies the type as an HL7 Registered model",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "2.16.840.1.113883.1.3",
"label": "Root",
"id": "ClinicalDocument.legalAuthenticator.typeId.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "ClinicalDocument.legalAuthenticator.typeId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "ClinicalDocument.legalAuthenticator.typeId.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "ClinicalDocument.legalAuthenticator.templateId",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
},
"path": "ClinicalDocument.legalAuthenticator.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"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"
}, {
"path": "ClinicalDocument.legalAuthenticator.typeCode",
"fixedCode": "LA",
"min": 0,
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.legalAuthenticator.typeCode",
"base": {
"max": "1",
"min": 0,
"path": "LegalAuthenticator.typeCode"
}
}, {
"path": "ClinicalDocument.legalAuthenticator.contextControlCode",
"fixedCode": "OP",
"min": 0,
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDAContextControl"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.legalAuthenticator.contextControlCode",
"base": {
"max": "1",
"min": 0,
"path": "LegalAuthenticator.contextControlCode"
}
}, {
"id": "ClinicalDocument.legalAuthenticator.time",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "LegalAuthenticator.time"
},
"path": "ClinicalDocument.legalAuthenticator.time",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/TS",
"profile": [ "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmDateTime" ]
} ],
"comment": "The legalAuthenticator, if present, SHALL contain exactly one [1..1] US Realm Date and Time (Point in Time) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.4) (CONF:4537-5580)."
}, {
"constraint": [ {
"key": "signature",
"human": "CDA Release One represented either an intended ('X') or actual ('S') authenticator. CDA Release Two only represents an actual authenticator, so has deprecated the value of 'X'.",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/ClinicalDocument",
"severity": "warning",
"expression": "code.exists() implies code != 'X'"
} ],
"path": "ClinicalDocument.legalAuthenticator.signatureCode",
"min": 1,
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDASignatureCode"
},
"max": "1",
"id": "ClinicalDocument.legalAuthenticator.signatureCode",
"comment": "The legalAuthenticator, if present, SHALL contain exactly one [1..1] signatureCode (CONF:4537-5583).",
"base": {
"max": "1",
"min": 1,
"path": "LegalAuthenticator.signatureCode"
}
}, {
"path": "ClinicalDocument.legalAuthenticator.signatureCode.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.legalAuthenticator.signatureCode.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.legalAuthenticator.signatureCode.code",
"min": 1,
"definition": "The plain code symbol defined by the code system. For example, \"784.0\" is the code symbol of the ICD-9 code \"784.0\" for headache.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"patternCode": "S",
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Code",
"id": "ClinicalDocument.legalAuthenticator.signatureCode.code",
"comment": "This signatureCode SHALL contain exactly one [1..1] @code=\"S\" (CodeSystem: HL7ParticipationSignature urn:oid:2.16.840.1.113883.5.89 STATIC) (CONF:4537-5584).",
"base": {
"max": "1",
"min": 0,
"path": "CD.code"
}
}, {
"path": "ClinicalDocument.legalAuthenticator.signatureCode.codeSystem",
"min": 0,
"definition": "Specifies the code system that defines the code.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "0",
"label": "Code System",
"id": "ClinicalDocument.legalAuthenticator.signatureCode.codeSystem",
"base": {
"max": "1",
"min": 0,
"path": "CD.codeSystem"
}
}, {
"path": "ClinicalDocument.legalAuthenticator.signatureCode.codeSystemName",
"min": 0,
"definition": "The common name of the coding system.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "0",
"label": "Code System Name",
"id": "ClinicalDocument.legalAuthenticator.signatureCode.codeSystemName",
"base": {
"max": "1",
"min": 0,
"path": "CD.codeSystemName"
}
}, {
"path": "ClinicalDocument.legalAuthenticator.signatureCode.codeSystemVersion",
"min": 0,
"definition": "If applicable, a version descriptor defined specifically for the given code system.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "0",
"label": "Code System Version",
"id": "ClinicalDocument.legalAuthenticator.signatureCode.codeSystemVersion",
"base": {
"max": "1",
"min": 0,
"path": "CD.codeSystemVersion"
}
}, {
"path": "ClinicalDocument.legalAuthenticator.signatureCode.displayName",
"min": 0,
"definition": "A name or title for the code, under which the sending system shows the code value to its users.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "0",
"label": "Display Name",
"id": "ClinicalDocument.legalAuthenticator.signatureCode.displayName",
"base": {
"max": "1",
"min": 0,
"path": "CD.displayName"
}
}, {
"path": "ClinicalDocument.legalAuthenticator.signatureCode.sdtcValueSet",
"min": 0,
"definition": "The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid" ]
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "valueSet"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.legalAuthenticator.signatureCode.sdtcValueSet",
"base": {
"max": "1",
"min": 0,
"path": "CD.valueSet"
}
}, {
"path": "ClinicalDocument.legalAuthenticator.signatureCode.sdtcValueSetVersion",
"min": 0,
"definition": "The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "valueSetVersion"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.legalAuthenticator.signatureCode.sdtcValueSetVersion",
"base": {
"max": "1",
"min": 0,
"path": "CD.sdtcValueSetVersion"
}
}, {
"id": "ClinicalDocument.legalAuthenticator.signatureCode.originalText",
"max": "0",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "CD.originalText"
},
"path": "ClinicalDocument.legalAuthenticator.signatureCode.originalText",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ED"
} ],
"label": "Original Text",
"definition": "The text or phrase used as the basis for the coding."
}, {
"id": "ClinicalDocument.legalAuthenticator.signatureCode.qualifier",
"max": "0",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "CD.qualifier"
},
"path": "ClinicalDocument.legalAuthenticator.signatureCode.qualifier",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CR"
} ],
"label": "Qualifier",
"definition": "Specifies additional codes that increase the specificity of the the primary code."
}, {
"path": "ClinicalDocument.legalAuthenticator.signatureCode.translation",
"min": 0,
"definition": "A set of other concept descriptors that translate this concept descriptor into other code systems.",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CD"
} ],
"representation": [ "typeAttr" ],
"max": "0",
"label": "Translation",
"id": "ClinicalDocument.legalAuthenticator.signatureCode.translation",
"base": {
"max": "*",
"min": 0,
"path": "CD.translation"
}
}, {
"path": "ClinicalDocument.legalAuthenticator.sdtcSignatureText",
"min": 0,
"definition": "A textual or multimedia depiction of the signature by which the participant endorses his or her participation in the Act as specified in the Participation.typeCode and that he or she agrees to assume the associated accountability.",
"short": "The signature can be represented either inline or by reference according to the ED data type. Typical cases for CDA are:\n1) Electronic signature: this attribute can represent virtually any electronic signature scheme.\n2) Digital signature: this attribute can represent digital signatures by reference to a signature data block that is constructed in accordance to a digital signature standard, such as XML-DSIG, PKCS#7, PGP, etc.\n 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 2013.",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ED"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "signatureText"
} ],
"max": "1",
"id": "ClinicalDocument.legalAuthenticator.sdtcSignatureText",
"comment": "The legalAuthenticator, if present, MAY contain zero or one [0..1] sdtc:signatureText (CONF:4537-30810).",
"base": {
"max": "1",
"min": 0,
"path": "LegalAuthenticator.sdtcSignatureText"
}
}, {
"id": "ClinicalDocument.legalAuthenticator.assignedEntity",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "LegalAuthenticator.assignedEntity"
},
"path": "ClinicalDocument.legalAuthenticator.assignedEntity",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity"
} ],
"comment": "The legalAuthenticator, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:4537-5585)."
}, {
"path": "ClinicalDocument.legalAuthenticator.assignedEntity.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.legalAuthenticator.assignedEntity.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "ClinicalDocument.legalAuthenticator.assignedEntity.realmCode",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.realmCode"
},
"path": "ClinicalDocument.legalAuthenticator.assignedEntity.realmCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question"
}, {
"id": "ClinicalDocument.legalAuthenticator.assignedEntity.typeId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "InfrastructureRoot.typeId"
},
"path": "ClinicalDocument.legalAuthenticator.assignedEntity.typeId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"constraint": [ {
"key": "II-1",
"human": "An II instance must have either a root or an nullFlavor.",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot",
"severity": "error",
"expression": "root.exists() or nullFlavor.exists()"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question."
}, {
"path": "ClinicalDocument.legalAuthenticator.assignedEntity.typeId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.legalAuthenticator.assignedEntity.typeId.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.legalAuthenticator.assignedEntity.typeId.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "ClinicalDocument.legalAuthenticator.assignedEntity.typeId.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "ClinicalDocument.legalAuthenticator.assignedEntity.typeId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "ClinicalDocument.legalAuthenticator.assignedEntity.typeId.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "ClinicalDocument.legalAuthenticator.assignedEntity.typeId.root",
"min": 1,
"definition": "Identifies the type as an HL7 Registered model",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "2.16.840.1.113883.1.3",
"label": "Root",
"id": "ClinicalDocument.legalAuthenticator.assignedEntity.typeId.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "ClinicalDocument.legalAuthenticator.assignedEntity.typeId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "ClinicalDocument.legalAuthenticator.assignedEntity.typeId.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "ClinicalDocument.legalAuthenticator.assignedEntity.templateId",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
},
"path": "ClinicalDocument.legalAuthenticator.assignedEntity.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"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"
}, {
"path": "ClinicalDocument.legalAuthenticator.assignedEntity.classCode",
"fixedCode": "ASSIGNED",
"min": 0,
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-RoleClassAssignedEntity"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.legalAuthenticator.assignedEntity.classCode",
"base": {
"max": "1",
"min": 0,
"path": "AssignedEntity.classCode"
}
}, {
"id": "ClinicalDocument.legalAuthenticator.assignedEntity.id",
"max": "*",
"min": 1,
"base": {
"max": "*",
"min": 1,
"path": "AssignedEntity.id"
},
"path": "ClinicalDocument.legalAuthenticator.assignedEntity.id",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"comment": "This assignedEntity SHALL contain at least one [1..*] id (CONF:4537-5586)."
}, {
"path": "ClinicalDocument.legalAuthenticator.assignedEntity.id.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.legalAuthenticator.assignedEntity.id.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.legalAuthenticator.assignedEntity.id.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "ClinicalDocument.legalAuthenticator.assignedEntity.id.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "ClinicalDocument.legalAuthenticator.assignedEntity.id.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "ClinicalDocument.legalAuthenticator.assignedEntity.id.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "ClinicalDocument.legalAuthenticator.assignedEntity.id.root",
"min": 0,
"definition": "A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.",
"short": "MAY contain '2.16.840.1.113883.4.6' (NPI)",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Root",
"id": "ClinicalDocument.legalAuthenticator.assignedEntity.id.root",
"comment": "Such ids MAY contain zero or one [0..1] @root=\"2.16.840.1.113883.4.6\" National Provider Identifier (CONF:4537-16823).",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "ClinicalDocument.legalAuthenticator.assignedEntity.id.extension",
"min": 0,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "ClinicalDocument.legalAuthenticator.assignedEntity.id.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "ClinicalDocument.legalAuthenticator.assignedEntity.sdtcIdentifiedBy",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "AssignedEntity.sdtcIdentifiedBy"
},
"path": "ClinicalDocument.legalAuthenticator.assignedEntity.sdtcIdentifiedBy",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "identifiedBy"
} ]
}, {
"id": "ClinicalDocument.legalAuthenticator.assignedEntity.code",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "AssignedEntity.code"
},
"path": "ClinicalDocument.legalAuthenticator.assignedEntity.code",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CE"
} ],
"binding": {
"strength": "preferred",
"valueSet": "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066"
},
"comment": "This assignedEntity MAY contain zero or one [0..1] code, which SHOULD be selected from ValueSet Healthcare Provider Taxonomy urn:oid:2.16.840.1.114222.4.11.1066 DYNAMIC (CONF:4537-17000)."
}, {
"id": "ClinicalDocument.legalAuthenticator.assignedEntity.addr",
"max": "*",
"min": 1,
"base": {
"max": "*",
"min": 0,
"path": "AssignedEntity.addr"
},
"path": "ClinicalDocument.legalAuthenticator.assignedEntity.addr",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/AD",
"profile": [ "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress" ]
} ],
"comment": "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:4537-5589)."
}, {
"id": "ClinicalDocument.legalAuthenticator.assignedEntity.telecom",
"max": "*",
"min": 1,
"base": {
"max": "*",
"min": 0,
"path": "AssignedEntity.telecom"
},
"path": "ClinicalDocument.legalAuthenticator.assignedEntity.telecom",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/TEL"
} ],
"comment": "This assignedEntity SHALL contain at least one [1..*] telecom (CONF:4537-5595).",
"constraint": [ {
"key": "should-use",
"human": "SHOULD contain @use",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader",
"severity": "warning",
"expression": "nullFlavor.exists() or use.exists()"
} ]
}, {
"path": "ClinicalDocument.legalAuthenticator.assignedEntity.telecom.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.legalAuthenticator.assignedEntity.telecom.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "ClinicalDocument.legalAuthenticator.assignedEntity.telecom.value",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "TEL.value"
},
"path": "ClinicalDocument.legalAuthenticator.assignedEntity.telecom.value",
"type": [ {
"code": "url",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/url" ]
} ],
"representation": [ "xmlAttr" ]
}, {
"path": "ClinicalDocument.legalAuthenticator.assignedEntity.telecom.useablePeriod",
"min": 0,
"definition": "Specifies the periods of time during which the telecommunication address can be used. For a telephone number, this can indicate the time of day in which the party can be reached on that telephone. For a web address, it may specify a time range in which the web content is promised to be available under the given address.",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS"
}, {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS"
}, {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS"
}, {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-defaulttype",
"valueCanonical": "http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS"
} ],
"representation": [ "typeAttr" ],
"max": "*",
"label": "Useable Period",
"id": "ClinicalDocument.legalAuthenticator.assignedEntity.telecom.useablePeriod",
"base": {
"max": "*",
"min": 0,
"path": "TEL.useablePeriod"
}
}, {
"path": "ClinicalDocument.legalAuthenticator.assignedEntity.telecom.use",
"min": 0,
"definition": "One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.20"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Use Code",
"id": "ClinicalDocument.legalAuthenticator.assignedEntity.telecom.use",
"comment": "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:4537-7999).",
"base": {
"max": "*",
"min": 0,
"path": "TEL.use"
}
}, {
"id": "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 0,
"path": "AssignedEntity.assignedPerson"
},
"path": "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Person"
} ],
"comment": "This assignedEntity SHALL contain exactly one [1..1] assignedPerson (CONF:4537-5597)."
}, {
"path": "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.realmCode",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.realmCode"
},
"path": "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.realmCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question"
}, {
"id": "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.typeId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "InfrastructureRoot.typeId"
},
"path": "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.typeId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"constraint": [ {
"key": "II-1",
"human": "An II instance must have either a root or an nullFlavor.",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot",
"severity": "error",
"expression": "root.exists() or nullFlavor.exists()"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question."
}, {
"path": "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.typeId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.typeId.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.typeId.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.typeId.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.typeId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.typeId.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.typeId.root",
"min": 1,
"definition": "Identifies the type as an HL7 Registered model",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "2.16.840.1.113883.1.3",
"label": "Root",
"id": "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.typeId.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.typeId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.typeId.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.templateId",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
},
"path": "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"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"
}, {
"path": "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.classCode",
"fixedCode": "PSN",
"min": 0,
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.classCode",
"base": {
"max": "1",
"min": 0,
"path": "Person.classCode"
}
}, {
"path": "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.determinerCode",
"fixedCode": "INSTANCE",
"min": 0,
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-EntityDeterminer"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.determinerCode",
"base": {
"max": "1",
"min": 0,
"path": "Person.determinerCode"
}
}, {
"id": "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.name",
"max": "*",
"min": 1,
"base": {
"max": "*",
"min": 0,
"path": "Person.name"
},
"path": "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.name",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/PN",
"profile": [ "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPersonNamePNUSFIELDED" ]
} ],
"comment": "This assignedPerson SHALL contain at least one [1..*] US Realm Person Name (PN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1.1) (CONF:4537-5598)."
}, {
"id": "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcDesc",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "Person.sdtcDesc"
},
"path": "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcDesc",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ED"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "desc"
} ],
"definition": "The desc extension allows multimedia depictions of patients, healthcare providers, or other individuals to be included in a CDA document."
}, {
"id": "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "Person.sdtcAsPatientRelationship"
},
"path": "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "asPatientRelationship"
} ],
"definition": "Each participant role other than an informant/relatedEntity may have zero or more relationship roles with the patient. Each of these roles can be expressed with an asPatientRelationship element which further describes the type of role using a code element."
}, {
"path": "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.realmCode",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.realmCode"
},
"path": "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.realmCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question"
}, {
"id": "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "InfrastructureRoot.typeId"
},
"path": "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"constraint": [ {
"key": "II-1",
"human": "An II instance must have either a root or an nullFlavor.",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/ClinicalDocument",
"severity": "error",
"expression": "root.exists() or nullFlavor.exists()"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question."
}, {
"path": "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.root",
"min": 1,
"definition": "Identifies the type as an HL7 Registered model",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "2.16.840.1.113883.1.3",
"label": "Root",
"id": "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.templateId",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
},
"path": "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"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"
}, {
"id": "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.classCode",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "Person.sdtcAsPatientRelationship.classCode"
},
"path": "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.classCode",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"fixedCode": "PRS",
"representation": [ "xmlAttr" ]
}, {
"id": "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.determinerCode",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "Person.sdtcAsPatientRelationship.determinerCode"
},
"path": "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.determinerCode",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"fixedCode": "INSTANCE",
"representation": [ "xmlAttr" ]
}, {
"id": "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.code",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "Person.sdtcAsPatientRelationship.code"
},
"path": "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.code",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CE"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
} ]
}, {
"id": "ClinicalDocument.legalAuthenticator.assignedEntity.representedOrganization",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "AssignedEntity.representedOrganization"
},
"path": "ClinicalDocument.legalAuthenticator.assignedEntity.representedOrganization",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Organization"
} ]
}, {
"id": "ClinicalDocument.legalAuthenticator.assignedEntity.sdtcPatient",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "AssignedEntity.sdtcPatient"
},
"path": "ClinicalDocument.legalAuthenticator.assignedEntity.sdtcPatient",
"type": [ {
"code": "http://hl7.org/fhir/StructureDefinition/Base"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "patient"
} ]
}, {
"id": "ClinicalDocument.legalAuthenticator.assignedEntity.sdtcPatient.id",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "AssignedEntity.sdtcPatient.id"
},
"path": "ClinicalDocument.legalAuthenticator.assignedEntity.sdtcPatient.id",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
} ]
}, {
"id": "ClinicalDocument.authenticator",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "ClinicalDocument.authenticator"
},
"path": "ClinicalDocument.authenticator",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Authenticator"
} ],
"short": "The authenticator identifies a participant or participants who attest to the accuracy of the information in the document."
}, {
"path": "ClinicalDocument.authenticator.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.authenticator.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "ClinicalDocument.authenticator.realmCode",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.realmCode"
},
"path": "ClinicalDocument.authenticator.realmCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question"
}, {
"id": "ClinicalDocument.authenticator.typeId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "InfrastructureRoot.typeId"
},
"path": "ClinicalDocument.authenticator.typeId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"constraint": [ {
"key": "II-1",
"human": "An II instance must have either a root or an nullFlavor.",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot",
"severity": "error",
"expression": "root.exists() or nullFlavor.exists()"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question."
}, {
"path": "ClinicalDocument.authenticator.typeId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.authenticator.typeId.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.authenticator.typeId.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "ClinicalDocument.authenticator.typeId.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "ClinicalDocument.authenticator.typeId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "ClinicalDocument.authenticator.typeId.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "ClinicalDocument.authenticator.typeId.root",
"min": 1,
"definition": "Identifies the type as an HL7 Registered model",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "2.16.840.1.113883.1.3",
"label": "Root",
"id": "ClinicalDocument.authenticator.typeId.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "ClinicalDocument.authenticator.typeId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "ClinicalDocument.authenticator.typeId.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "ClinicalDocument.authenticator.templateId",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
},
"path": "ClinicalDocument.authenticator.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"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"
}, {
"path": "ClinicalDocument.authenticator.typeCode",
"fixedCode": "AUTHEN",
"min": 0,
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.authenticator.typeCode",
"base": {
"max": "1",
"min": 0,
"path": "Authenticator.typeCode"
}
}, {
"id": "ClinicalDocument.authenticator.time",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "Authenticator.time"
},
"path": "ClinicalDocument.authenticator.time",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/TS",
"profile": [ "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmDateTime" ]
} ],
"comment": "SHALL contain exactly one [1..1] US Realm Date and Time (Point in Time) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.4) (CONF:4537-5608)."
}, {
"constraint": [ {
"key": "signature",
"human": "CDA Release One represented either an intended ('X') or actual ('S') authenticator. CDA Release Two only represents an actual authenticator, so has deprecated the value of 'X'.",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/ClinicalDocument",
"severity": "warning",
"expression": "code.exists() implies code != 'X'"
} ],
"path": "ClinicalDocument.authenticator.signatureCode",
"min": 1,
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDASignatureCode"
},
"max": "1",
"id": "ClinicalDocument.authenticator.signatureCode",
"comment": "SHALL contain exactly one [1..1] signatureCode (CONF:4537-5610).",
"base": {
"max": "1",
"min": 1,
"path": "Authenticator.signatureCode"
}
}, {
"path": "ClinicalDocument.authenticator.signatureCode.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.authenticator.signatureCode.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.authenticator.signatureCode.code",
"min": 1,
"definition": "The plain code symbol defined by the code system. For example, \"784.0\" is the code symbol of the ICD-9 code \"784.0\" for headache.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"patternCode": "S",
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Code",
"id": "ClinicalDocument.authenticator.signatureCode.code",
"comment": "This signatureCode SHALL contain exactly one [1..1] @code=\"S\" (CodeSystem: HL7ParticipationSignature urn:oid:2.16.840.1.113883.5.89 STATIC) (CONF:4537-5611).",
"base": {
"max": "1",
"min": 0,
"path": "CD.code"
}
}, {
"path": "ClinicalDocument.authenticator.signatureCode.codeSystem",
"min": 0,
"definition": "Specifies the code system that defines the code.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "0",
"label": "Code System",
"id": "ClinicalDocument.authenticator.signatureCode.codeSystem",
"base": {
"max": "1",
"min": 0,
"path": "CD.codeSystem"
}
}, {
"path": "ClinicalDocument.authenticator.signatureCode.codeSystemName",
"min": 0,
"definition": "The common name of the coding system.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "0",
"label": "Code System Name",
"id": "ClinicalDocument.authenticator.signatureCode.codeSystemName",
"base": {
"max": "1",
"min": 0,
"path": "CD.codeSystemName"
}
}, {
"path": "ClinicalDocument.authenticator.signatureCode.codeSystemVersion",
"min": 0,
"definition": "If applicable, a version descriptor defined specifically for the given code system.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "0",
"label": "Code System Version",
"id": "ClinicalDocument.authenticator.signatureCode.codeSystemVersion",
"base": {
"max": "1",
"min": 0,
"path": "CD.codeSystemVersion"
}
}, {
"path": "ClinicalDocument.authenticator.signatureCode.displayName",
"min": 0,
"definition": "A name or title for the code, under which the sending system shows the code value to its users.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "0",
"label": "Display Name",
"id": "ClinicalDocument.authenticator.signatureCode.displayName",
"base": {
"max": "1",
"min": 0,
"path": "CD.displayName"
}
}, {
"path": "ClinicalDocument.authenticator.signatureCode.sdtcValueSet",
"min": 0,
"definition": "The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid" ]
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "valueSet"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.authenticator.signatureCode.sdtcValueSet",
"base": {
"max": "1",
"min": 0,
"path": "CD.valueSet"
}
}, {
"path": "ClinicalDocument.authenticator.signatureCode.sdtcValueSetVersion",
"min": 0,
"definition": "The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "valueSetVersion"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.authenticator.signatureCode.sdtcValueSetVersion",
"base": {
"max": "1",
"min": 0,
"path": "CD.sdtcValueSetVersion"
}
}, {
"id": "ClinicalDocument.authenticator.signatureCode.originalText",
"max": "0",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "CD.originalText"
},
"path": "ClinicalDocument.authenticator.signatureCode.originalText",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ED"
} ],
"label": "Original Text",
"definition": "The text or phrase used as the basis for the coding."
}, {
"id": "ClinicalDocument.authenticator.signatureCode.qualifier",
"max": "0",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "CD.qualifier"
},
"path": "ClinicalDocument.authenticator.signatureCode.qualifier",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CR"
} ],
"label": "Qualifier",
"definition": "Specifies additional codes that increase the specificity of the the primary code."
}, {
"path": "ClinicalDocument.authenticator.signatureCode.translation",
"min": 0,
"definition": "A set of other concept descriptors that translate this concept descriptor into other code systems.",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CD"
} ],
"representation": [ "typeAttr" ],
"max": "0",
"label": "Translation",
"id": "ClinicalDocument.authenticator.signatureCode.translation",
"base": {
"max": "*",
"min": 0,
"path": "CD.translation"
}
}, {
"path": "ClinicalDocument.authenticator.sdtcSignatureText",
"min": 0,
"definition": "A textual or multimedia depiction of the signature by which the participant endorses his or her participation in the Act as specified in the Participation.typeCode and that he or she agrees to assume the associated accountability.",
"short": "The signature can be represented either inline or by reference according to the ED data type. Typical cases for CDA are:\n1) Electronic signature: this attribute can represent virtually any electronic signature scheme.\n2) Digital signature: this attribute can represent digital signatures by reference to a signature data block that is constructed in accordance to a digital signature standard, such as XML-DSIG, PKCS#7, PGP, etc.\n 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.",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ED"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "signatureText"
} ],
"max": "1",
"id": "ClinicalDocument.authenticator.sdtcSignatureText",
"comment": "MAY contain zero or one [0..1] sdtc:signatureText (CONF:4537-30811).",
"base": {
"max": "1",
"min": 0,
"path": "Authenticator.sdtcSignatureText"
}
}, {
"id": "ClinicalDocument.authenticator.assignedEntity",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "Authenticator.assignedEntity"
},
"path": "ClinicalDocument.authenticator.assignedEntity",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity"
} ],
"comment": "SHALL contain exactly one [1..1] assignedEntity (CONF:4537-5612)."
}, {
"path": "ClinicalDocument.authenticator.assignedEntity.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.authenticator.assignedEntity.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "ClinicalDocument.authenticator.assignedEntity.realmCode",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.realmCode"
},
"path": "ClinicalDocument.authenticator.assignedEntity.realmCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question"
}, {
"id": "ClinicalDocument.authenticator.assignedEntity.typeId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "InfrastructureRoot.typeId"
},
"path": "ClinicalDocument.authenticator.assignedEntity.typeId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"constraint": [ {
"key": "II-1",
"human": "An II instance must have either a root or an nullFlavor.",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot",
"severity": "error",
"expression": "root.exists() or nullFlavor.exists()"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question."
}, {
"path": "ClinicalDocument.authenticator.assignedEntity.typeId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.authenticator.assignedEntity.typeId.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.authenticator.assignedEntity.typeId.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "ClinicalDocument.authenticator.assignedEntity.typeId.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "ClinicalDocument.authenticator.assignedEntity.typeId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "ClinicalDocument.authenticator.assignedEntity.typeId.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "ClinicalDocument.authenticator.assignedEntity.typeId.root",
"min": 1,
"definition": "Identifies the type as an HL7 Registered model",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "2.16.840.1.113883.1.3",
"label": "Root",
"id": "ClinicalDocument.authenticator.assignedEntity.typeId.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "ClinicalDocument.authenticator.assignedEntity.typeId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "ClinicalDocument.authenticator.assignedEntity.typeId.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "ClinicalDocument.authenticator.assignedEntity.templateId",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
},
"path": "ClinicalDocument.authenticator.assignedEntity.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"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"
}, {
"path": "ClinicalDocument.authenticator.assignedEntity.classCode",
"fixedCode": "ASSIGNED",
"min": 0,
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-RoleClassAssignedEntity"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.authenticator.assignedEntity.classCode",
"base": {
"max": "1",
"min": 0,
"path": "AssignedEntity.classCode"
}
}, {
"id": "ClinicalDocument.authenticator.assignedEntity.id",
"max": "*",
"min": 1,
"base": {
"max": "*",
"min": 1,
"path": "AssignedEntity.id"
},
"path": "ClinicalDocument.authenticator.assignedEntity.id",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"comment": "This assignedEntity SHALL contain at least one [1..*] id (CONF:4537-5613)."
}, {
"path": "ClinicalDocument.authenticator.assignedEntity.id.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.authenticator.assignedEntity.id.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.authenticator.assignedEntity.id.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "ClinicalDocument.authenticator.assignedEntity.id.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "ClinicalDocument.authenticator.assignedEntity.id.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "ClinicalDocument.authenticator.assignedEntity.id.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"constraint": [ {
"key": "should-npi",
"human": "SHOULD be NPI",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader",
"severity": "warning",
"expression": "$this = '2.16.840.1.113883.4.6'"
} ],
"path": "ClinicalDocument.authenticator.assignedEntity.id.root",
"min": 0,
"definition": "A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Root",
"id": "ClinicalDocument.authenticator.assignedEntity.id.root",
"comment": "Such ids SHOULD contain zero or one [0..1] @root=\"2.16.840.1.113883.4.6\" National Provider Identifier (CONF:4537-16824).",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "ClinicalDocument.authenticator.assignedEntity.id.extension",
"min": 0,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "ClinicalDocument.authenticator.assignedEntity.id.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "ClinicalDocument.authenticator.assignedEntity.sdtcIdentifiedBy",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "AssignedEntity.sdtcIdentifiedBy"
},
"path": "ClinicalDocument.authenticator.assignedEntity.sdtcIdentifiedBy",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "identifiedBy"
} ]
}, {
"id": "ClinicalDocument.authenticator.assignedEntity.code",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "AssignedEntity.code"
},
"path": "ClinicalDocument.authenticator.assignedEntity.code",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CE"
} ],
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDARoleCode"
},
"comment": "This assignedEntity MAY contain zero or one [0..1] code (CONF:4537-16825)."
}, {
"path": "ClinicalDocument.authenticator.assignedEntity.code.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.authenticator.assignedEntity.code.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.authenticator.assignedEntity.code.code",
"min": 0,
"definition": "The plain code symbol defined by the code system. For example, \"784.0\" is the code symbol of the ICD-9 code \"784.0\" for headache.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "preferred",
"valueSet": "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Code",
"id": "ClinicalDocument.authenticator.assignedEntity.code.code",
"comment": "The code, if present, MAY contain zero or one [0..1] @code, which SHOULD be selected from ValueSet Healthcare Provider Taxonomy urn:oid:2.16.840.1.114222.4.11.1066 DYNAMIC (CONF:4537-16826).",
"base": {
"max": "1",
"min": 0,
"path": "CD.code"
}
}, {
"path": "ClinicalDocument.authenticator.assignedEntity.code.codeSystem",
"min": 0,
"definition": "Specifies the code system that defines the code.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Code System",
"id": "ClinicalDocument.authenticator.assignedEntity.code.codeSystem",
"base": {
"max": "1",
"min": 0,
"path": "CD.codeSystem"
}
}, {
"path": "ClinicalDocument.authenticator.assignedEntity.code.codeSystemName",
"min": 0,
"definition": "The common name of the coding system.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Code System Name",
"id": "ClinicalDocument.authenticator.assignedEntity.code.codeSystemName",
"base": {
"max": "1",
"min": 0,
"path": "CD.codeSystemName"
}
}, {
"path": "ClinicalDocument.authenticator.assignedEntity.code.codeSystemVersion",
"min": 0,
"definition": "If applicable, a version descriptor defined specifically for the given code system.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Code System Version",
"id": "ClinicalDocument.authenticator.assignedEntity.code.codeSystemVersion",
"base": {
"max": "1",
"min": 0,
"path": "CD.codeSystemVersion"
}
}, {
"path": "ClinicalDocument.authenticator.assignedEntity.code.displayName",
"min": 0,
"definition": "A name or title for the code, under which the sending system shows the code value to its users.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Display Name",
"id": "ClinicalDocument.authenticator.assignedEntity.code.displayName",
"base": {
"max": "1",
"min": 0,
"path": "CD.displayName"
}
}, {
"path": "ClinicalDocument.authenticator.assignedEntity.code.sdtcValueSet",
"min": 0,
"definition": "The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid" ]
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "valueSet"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.authenticator.assignedEntity.code.sdtcValueSet",
"base": {
"max": "1",
"min": 0,
"path": "CD.valueSet"
}
}, {
"path": "ClinicalDocument.authenticator.assignedEntity.code.sdtcValueSetVersion",
"min": 0,
"definition": "The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "valueSetVersion"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.authenticator.assignedEntity.code.sdtcValueSetVersion",
"base": {
"max": "1",
"min": 0,
"path": "CD.sdtcValueSetVersion"
}
}, {
"id": "ClinicalDocument.authenticator.assignedEntity.code.originalText",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "CD.originalText"
},
"path": "ClinicalDocument.authenticator.assignedEntity.code.originalText",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ED"
} ],
"label": "Original Text",
"definition": "The text or phrase used as the basis for the coding."
}, {
"id": "ClinicalDocument.authenticator.assignedEntity.code.qualifier",
"max": "0",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "CD.qualifier"
},
"path": "ClinicalDocument.authenticator.assignedEntity.code.qualifier",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CR"
} ],
"label": "Qualifier",
"definition": "Specifies additional codes that increase the specificity of the the primary code."
}, {
"path": "ClinicalDocument.authenticator.assignedEntity.code.translation",
"min": 0,
"definition": "A set of other concept descriptors that translate this concept descriptor into other code systems.",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CD"
} ],
"representation": [ "typeAttr" ],
"max": "*",
"label": "Translation",
"id": "ClinicalDocument.authenticator.assignedEntity.code.translation",
"base": {
"max": "*",
"min": 0,
"path": "CD.translation"
}
}, {
"id": "ClinicalDocument.authenticator.assignedEntity.addr",
"max": "*",
"min": 1,
"base": {
"max": "*",
"min": 0,
"path": "AssignedEntity.addr"
},
"path": "ClinicalDocument.authenticator.assignedEntity.addr",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/AD",
"profile": [ "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress" ]
} ],
"comment": "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:4537-5616)."
}, {
"id": "ClinicalDocument.authenticator.assignedEntity.telecom",
"max": "*",
"min": 1,
"base": {
"max": "*",
"min": 0,
"path": "AssignedEntity.telecom"
},
"path": "ClinicalDocument.authenticator.assignedEntity.telecom",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/TEL"
} ],
"comment": "This assignedEntity SHALL contain at least one [1..*] telecom (CONF:4537-5622).",
"constraint": [ {
"key": "should-use",
"human": "SHOULD contain @use",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader",
"severity": "warning",
"expression": "nullFlavor.exists() or use.exists()"
} ]
}, {
"path": "ClinicalDocument.authenticator.assignedEntity.telecom.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.authenticator.assignedEntity.telecom.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "ClinicalDocument.authenticator.assignedEntity.telecom.value",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "TEL.value"
},
"path": "ClinicalDocument.authenticator.assignedEntity.telecom.value",
"type": [ {
"code": "url",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/url" ]
} ],
"representation": [ "xmlAttr" ]
}, {
"path": "ClinicalDocument.authenticator.assignedEntity.telecom.useablePeriod",
"min": 0,
"definition": "Specifies the periods of time during which the telecommunication address can be used. For a telephone number, this can indicate the time of day in which the party can be reached on that telephone. For a web address, it may specify a time range in which the web content is promised to be available under the given address.",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS"
}, {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS"
}, {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS"
}, {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-defaulttype",
"valueCanonical": "http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS"
} ],
"representation": [ "typeAttr" ],
"max": "*",
"label": "Useable Period",
"id": "ClinicalDocument.authenticator.assignedEntity.telecom.useablePeriod",
"base": {
"max": "*",
"min": 0,
"path": "TEL.useablePeriod"
}
}, {
"path": "ClinicalDocument.authenticator.assignedEntity.telecom.use",
"min": 0,
"definition": "One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.20"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Use Code",
"id": "ClinicalDocument.authenticator.assignedEntity.telecom.use",
"comment": "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:4537-8000).",
"base": {
"max": "*",
"min": 0,
"path": "TEL.use"
}
}, {
"id": "ClinicalDocument.authenticator.assignedEntity.assignedPerson",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 0,
"path": "AssignedEntity.assignedPerson"
},
"path": "ClinicalDocument.authenticator.assignedEntity.assignedPerson",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Person"
} ],
"comment": "This assignedEntity SHALL contain exactly one [1..1] assignedPerson (CONF:4537-5624)."
}, {
"path": "ClinicalDocument.authenticator.assignedEntity.assignedPerson.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.authenticator.assignedEntity.assignedPerson.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "ClinicalDocument.authenticator.assignedEntity.assignedPerson.realmCode",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.realmCode"
},
"path": "ClinicalDocument.authenticator.assignedEntity.assignedPerson.realmCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question"
}, {
"id": "ClinicalDocument.authenticator.assignedEntity.assignedPerson.typeId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "InfrastructureRoot.typeId"
},
"path": "ClinicalDocument.authenticator.assignedEntity.assignedPerson.typeId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"constraint": [ {
"key": "II-1",
"human": "An II instance must have either a root or an nullFlavor.",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot",
"severity": "error",
"expression": "root.exists() or nullFlavor.exists()"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question."
}, {
"path": "ClinicalDocument.authenticator.assignedEntity.assignedPerson.typeId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.authenticator.assignedEntity.assignedPerson.typeId.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.authenticator.assignedEntity.assignedPerson.typeId.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "ClinicalDocument.authenticator.assignedEntity.assignedPerson.typeId.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "ClinicalDocument.authenticator.assignedEntity.assignedPerson.typeId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "ClinicalDocument.authenticator.assignedEntity.assignedPerson.typeId.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "ClinicalDocument.authenticator.assignedEntity.assignedPerson.typeId.root",
"min": 1,
"definition": "Identifies the type as an HL7 Registered model",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "2.16.840.1.113883.1.3",
"label": "Root",
"id": "ClinicalDocument.authenticator.assignedEntity.assignedPerson.typeId.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "ClinicalDocument.authenticator.assignedEntity.assignedPerson.typeId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "ClinicalDocument.authenticator.assignedEntity.assignedPerson.typeId.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "ClinicalDocument.authenticator.assignedEntity.assignedPerson.templateId",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
},
"path": "ClinicalDocument.authenticator.assignedEntity.assignedPerson.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"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"
}, {
"path": "ClinicalDocument.authenticator.assignedEntity.assignedPerson.classCode",
"fixedCode": "PSN",
"min": 0,
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.authenticator.assignedEntity.assignedPerson.classCode",
"base": {
"max": "1",
"min": 0,
"path": "Person.classCode"
}
}, {
"path": "ClinicalDocument.authenticator.assignedEntity.assignedPerson.determinerCode",
"fixedCode": "INSTANCE",
"min": 0,
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-EntityDeterminer"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.authenticator.assignedEntity.assignedPerson.determinerCode",
"base": {
"max": "1",
"min": 0,
"path": "Person.determinerCode"
}
}, {
"id": "ClinicalDocument.authenticator.assignedEntity.assignedPerson.name",
"max": "*",
"min": 1,
"base": {
"max": "*",
"min": 0,
"path": "Person.name"
},
"path": "ClinicalDocument.authenticator.assignedEntity.assignedPerson.name",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/PN",
"profile": [ "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPersonNamePNUSFIELDED" ]
} ],
"comment": "This assignedPerson SHALL contain at least one [1..*] US Realm Person Name (PN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1.1) (CONF:4537-5625)."
}, {
"id": "ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcDesc",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "Person.sdtcDesc"
},
"path": "ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcDesc",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ED"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "desc"
} ],
"definition": "The desc extension allows multimedia depictions of patients, healthcare providers, or other individuals to be included in a CDA document."
}, {
"id": "ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "Person.sdtcAsPatientRelationship"
},
"path": "ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "asPatientRelationship"
} ],
"definition": "Each participant role other than an informant/relatedEntity may have zero or more relationship roles with the patient. Each of these roles can be expressed with an asPatientRelationship element which further describes the type of role using a code element."
}, {
"path": "ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.realmCode",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.realmCode"
},
"path": "ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.realmCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question"
}, {
"id": "ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "InfrastructureRoot.typeId"
},
"path": "ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"constraint": [ {
"key": "II-1",
"human": "An II instance must have either a root or an nullFlavor.",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/ClinicalDocument",
"severity": "error",
"expression": "root.exists() or nullFlavor.exists()"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question."
}, {
"path": "ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.root",
"min": 1,
"definition": "Identifies the type as an HL7 Registered model",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "2.16.840.1.113883.1.3",
"label": "Root",
"id": "ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.templateId",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
},
"path": "ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"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"
}, {
"id": "ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.classCode",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "Person.sdtcAsPatientRelationship.classCode"
},
"path": "ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.classCode",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"fixedCode": "PRS",
"representation": [ "xmlAttr" ]
}, {
"id": "ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.determinerCode",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "Person.sdtcAsPatientRelationship.determinerCode"
},
"path": "ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.determinerCode",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"fixedCode": "INSTANCE",
"representation": [ "xmlAttr" ]
}, {
"id": "ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.code",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "Person.sdtcAsPatientRelationship.code"
},
"path": "ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.code",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CE"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
} ]
}, {
"id": "ClinicalDocument.authenticator.assignedEntity.representedOrganization",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "AssignedEntity.representedOrganization"
},
"path": "ClinicalDocument.authenticator.assignedEntity.representedOrganization",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Organization"
} ]
}, {
"id": "ClinicalDocument.authenticator.assignedEntity.sdtcPatient",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "AssignedEntity.sdtcPatient"
},
"path": "ClinicalDocument.authenticator.assignedEntity.sdtcPatient",
"type": [ {
"code": "http://hl7.org/fhir/StructureDefinition/Base"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "patient"
} ]
}, {
"id": "ClinicalDocument.authenticator.assignedEntity.sdtcPatient.id",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "AssignedEntity.sdtcPatient.id"
},
"path": "ClinicalDocument.authenticator.assignedEntity.sdtcPatient.id",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
} ]
}, {
"constraint": [ {
"key": "4537-10006",
"human": "**SHALL** contain associatedEntity/associatedPerson *AND/OR* associatedEntity/scopingOrganization (CONF:4537-10006).",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader",
"severity": "error",
"expression": "associatedEntity.associatedPerson.exists() or associatedEntity.scopingOrganization.exists()"
}, {
"key": "4537-10007",
"human": "When participant/@typeCode is *IND*, associatedEntity/@classCode **SHOULD** be selected from ValueSet 2.16.840.1.113883.11.20.9.33 INDRoleclassCodes *DYNAMIC* (CONF:4537-10007).",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader",
"severity": "warning",
"expression": "typeCode = 'IND' implies associatedEntity.classCode.memberOf('http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.33')"
}, {
"key": "1198-8333",
"human": "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 (CONF:1198-8333).\nA special class of participant is the supporting person or organization: an individual or an organization that has a relationship to the patient, including parents, relatives, caregivers, insurance policyholders, and guarantors. In the case of a supporting person who is also an emergency contact or next-of-kin, a participant element should be present for each role recorded.",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/HistoryandPhysical",
"severity": "warning"
} ],
"path": "ClinicalDocument.participant",
"min": 0,
"short": "The participant element in the H&P header follows the General Header Constraints for participants. H&P Note does not specify any use for functionCode for participants. Local policies will determine how this element should be used in implementations.",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Participant1"
} ],
"max": "*",
"id": "ClinicalDocument.participant",
"comment": "MAY contain zero or more [0..*] participant (CONF:1198-8286).",
"base": {
"max": "*",
"min": 0,
"path": "ClinicalDocument.participant"
}
}, {
"path": "ClinicalDocument.participant.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.participant.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "ClinicalDocument.participant.realmCode",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.realmCode"
},
"path": "ClinicalDocument.participant.realmCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question"
}, {
"id": "ClinicalDocument.participant.typeId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "InfrastructureRoot.typeId"
},
"path": "ClinicalDocument.participant.typeId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"constraint": [ {
"key": "II-1",
"human": "An II instance must have either a root or an nullFlavor.",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot",
"severity": "error",
"expression": "root.exists() or nullFlavor.exists()"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question."
}, {
"path": "ClinicalDocument.participant.typeId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.participant.typeId.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.participant.typeId.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "ClinicalDocument.participant.typeId.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "ClinicalDocument.participant.typeId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "ClinicalDocument.participant.typeId.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "ClinicalDocument.participant.typeId.root",
"min": 1,
"definition": "Identifies the type as an HL7 Registered model",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "2.16.840.1.113883.1.3",
"label": "Root",
"id": "ClinicalDocument.participant.typeId.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "ClinicalDocument.participant.typeId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "ClinicalDocument.participant.typeId.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "ClinicalDocument.participant.templateId",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
},
"path": "ClinicalDocument.participant.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"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"
}, {
"id": "ClinicalDocument.participant.typeCode",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "Participant1.typeCode"
},
"path": "ClinicalDocument.participant.typeCode",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType"
},
"representation": [ "xmlAttr" ]
}, {
"path": "ClinicalDocument.participant.contextControlCode",
"fixedCode": "OP",
"min": 0,
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDAContextControl"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.participant.contextControlCode",
"base": {
"max": "1",
"min": 0,
"path": "Participant1.contextControlCode"
}
}, {
"id": "ClinicalDocument.participant.functionCode",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "Participant1.functionCode"
},
"path": "ClinicalDocument.participant.functionCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CE"
} ]
}, {
"id": "ClinicalDocument.participant.time",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "Participant1.time"
},
"path": "ClinicalDocument.participant.time",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS",
"profile": [ "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmDateTimeInterval" ]
} ],
"comment": "MAY contain zero or one [0..1] time (CONF:4537-10004)."
}, {
"id": "ClinicalDocument.participant.associatedEntity",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "Participant1.associatedEntity"
},
"path": "ClinicalDocument.participant.associatedEntity",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/AssociatedEntity"
} ]
}, {
"id": "ClinicalDocument.inFulfillmentOf",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "ClinicalDocument.inFulfillmentOf"
},
"path": "ClinicalDocument.inFulfillmentOf",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/InFulfillmentOf"
} ],
"short": "inFulfillmentOf elements describe the prior orders that are fulfilled (in whole or part) by the service events described in this document. For example, the prior order might be a referral and the H&P Note may be in partial fulfillment of that referral.",
"comment": "MAY contain zero or more [0..*] inFulfillmentOf (CONF:1198-8336)."
}, {
"path": "ClinicalDocument.inFulfillmentOf.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.inFulfillmentOf.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "ClinicalDocument.inFulfillmentOf.realmCode",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.realmCode"
},
"path": "ClinicalDocument.inFulfillmentOf.realmCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question"
}, {
"id": "ClinicalDocument.inFulfillmentOf.typeId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "InfrastructureRoot.typeId"
},
"path": "ClinicalDocument.inFulfillmentOf.typeId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"constraint": [ {
"key": "II-1",
"human": "An II instance must have either a root or an nullFlavor.",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot",
"severity": "error",
"expression": "root.exists() or nullFlavor.exists()"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question."
}, {
"path": "ClinicalDocument.inFulfillmentOf.typeId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.inFulfillmentOf.typeId.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.inFulfillmentOf.typeId.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "ClinicalDocument.inFulfillmentOf.typeId.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "ClinicalDocument.inFulfillmentOf.typeId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "ClinicalDocument.inFulfillmentOf.typeId.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "ClinicalDocument.inFulfillmentOf.typeId.root",
"min": 1,
"definition": "Identifies the type as an HL7 Registered model",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "2.16.840.1.113883.1.3",
"label": "Root",
"id": "ClinicalDocument.inFulfillmentOf.typeId.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "ClinicalDocument.inFulfillmentOf.typeId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "ClinicalDocument.inFulfillmentOf.typeId.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "ClinicalDocument.inFulfillmentOf.templateId",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
},
"path": "ClinicalDocument.inFulfillmentOf.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"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"
}, {
"path": "ClinicalDocument.inFulfillmentOf.typeCode",
"fixedCode": "FLFS",
"min": 0,
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-ActRelationshipFulfills|2.0.0"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.inFulfillmentOf.typeCode",
"base": {
"max": "1",
"min": 0,
"path": "InFulfillmentOf.typeCode"
}
}, {
"id": "ClinicalDocument.inFulfillmentOf.order",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "InFulfillmentOf.order"
},
"path": "ClinicalDocument.inFulfillmentOf.order",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Order"
} ],
"comment": "The inFulfillmentOf, if present, SHALL contain exactly one [1..1] order (CONF:4537-9953)."
}, {
"path": "ClinicalDocument.inFulfillmentOf.order.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.inFulfillmentOf.order.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "ClinicalDocument.inFulfillmentOf.order.realmCode",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.realmCode"
},
"path": "ClinicalDocument.inFulfillmentOf.order.realmCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question"
}, {
"id": "ClinicalDocument.inFulfillmentOf.order.typeId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "InfrastructureRoot.typeId"
},
"path": "ClinicalDocument.inFulfillmentOf.order.typeId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"constraint": [ {
"key": "II-1",
"human": "An II instance must have either a root or an nullFlavor.",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot",
"severity": "error",
"expression": "root.exists() or nullFlavor.exists()"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question."
}, {
"path": "ClinicalDocument.inFulfillmentOf.order.typeId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.inFulfillmentOf.order.typeId.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.inFulfillmentOf.order.typeId.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "ClinicalDocument.inFulfillmentOf.order.typeId.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "ClinicalDocument.inFulfillmentOf.order.typeId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "ClinicalDocument.inFulfillmentOf.order.typeId.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "ClinicalDocument.inFulfillmentOf.order.typeId.root",
"min": 1,
"definition": "Identifies the type as an HL7 Registered model",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "2.16.840.1.113883.1.3",
"label": "Root",
"id": "ClinicalDocument.inFulfillmentOf.order.typeId.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "ClinicalDocument.inFulfillmentOf.order.typeId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "ClinicalDocument.inFulfillmentOf.order.typeId.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "ClinicalDocument.inFulfillmentOf.order.templateId",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
},
"path": "ClinicalDocument.inFulfillmentOf.order.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"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"
}, {
"path": "ClinicalDocument.inFulfillmentOf.order.classCode",
"min": 0,
"defaultValueCode": "ACT",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDAActClass"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.inFulfillmentOf.order.classCode",
"base": {
"max": "1",
"min": 0,
"path": "Order.classCode"
}
}, {
"path": "ClinicalDocument.inFulfillmentOf.order.moodCode",
"fixedCode": "RQO",
"min": 0,
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDAActMoodIntent"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.inFulfillmentOf.order.moodCode",
"base": {
"max": "1",
"min": 0,
"path": "Order.moodCode"
}
}, {
"id": "ClinicalDocument.inFulfillmentOf.order.id",
"max": "*",
"min": 1,
"base": {
"max": "*",
"min": 1,
"path": "Order.id"
},
"path": "ClinicalDocument.inFulfillmentOf.order.id",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"comment": "This order SHALL contain at least one [1..*] id (CONF:4537-9954)."
}, {
"id": "ClinicalDocument.inFulfillmentOf.order.code",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "Order.code"
},
"path": "ClinicalDocument.inFulfillmentOf.order.code",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CE"
} ],
"binding": {
"strength": "example",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-ActCode"
}
}, {
"id": "ClinicalDocument.inFulfillmentOf.order.priorityCode",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "Order.priorityCode"
},
"path": "ClinicalDocument.inFulfillmentOf.order.priorityCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CE"
} ],
"binding": {
"strength": "example",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-ActPriority"
}
}, {
"id": "ClinicalDocument.documentationOf",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "ClinicalDocument.documentationOf"
},
"path": "ClinicalDocument.documentationOf",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/DocumentationOf"
} ],
"comment": "MAY contain zero or more [0..*] documentationOf (CONF:4537-14835)."
}, {
"path": "ClinicalDocument.documentationOf.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.documentationOf.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "ClinicalDocument.documentationOf.realmCode",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.realmCode"
},
"path": "ClinicalDocument.documentationOf.realmCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question"
}, {
"id": "ClinicalDocument.documentationOf.typeId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "InfrastructureRoot.typeId"
},
"path": "ClinicalDocument.documentationOf.typeId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"constraint": [ {
"key": "II-1",
"human": "An II instance must have either a root or an nullFlavor.",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot",
"severity": "error",
"expression": "root.exists() or nullFlavor.exists()"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question."
}, {
"path": "ClinicalDocument.documentationOf.typeId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.documentationOf.typeId.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.documentationOf.typeId.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "ClinicalDocument.documentationOf.typeId.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "ClinicalDocument.documentationOf.typeId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "ClinicalDocument.documentationOf.typeId.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "ClinicalDocument.documentationOf.typeId.root",
"min": 1,
"definition": "Identifies the type as an HL7 Registered model",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "2.16.840.1.113883.1.3",
"label": "Root",
"id": "ClinicalDocument.documentationOf.typeId.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "ClinicalDocument.documentationOf.typeId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "ClinicalDocument.documentationOf.typeId.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "ClinicalDocument.documentationOf.templateId",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
},
"path": "ClinicalDocument.documentationOf.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"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"
}, {
"path": "ClinicalDocument.documentationOf.typeCode",
"fixedCode": "DOC",
"min": 0,
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDAActRelationshipType"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.documentationOf.typeCode",
"base": {
"max": "1",
"min": 0,
"path": "DocumentationOf.typeCode"
}
}, {
"constraint": [ {
"key": "should-us-performer",
"human": "SHOULD contain performer",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader",
"severity": "warning",
"expression": "performer.exists()"
} ],
"path": "ClinicalDocument.documentationOf.serviceEvent",
"min": 1,
"short": "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.",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ServiceEvent"
} ],
"max": "1",
"id": "ClinicalDocument.documentationOf.serviceEvent",
"comment": "The documentationOf, if present, SHALL contain exactly one [1..1] serviceEvent (CONF:4537-14836).",
"base": {
"max": "1",
"min": 1,
"path": "DocumentationOf.serviceEvent"
}
}, {
"path": "ClinicalDocument.documentationOf.serviceEvent.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.documentationOf.serviceEvent.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "ClinicalDocument.documentationOf.serviceEvent.realmCode",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.realmCode"
},
"path": "ClinicalDocument.documentationOf.serviceEvent.realmCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question"
}, {
"id": "ClinicalDocument.documentationOf.serviceEvent.typeId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "InfrastructureRoot.typeId"
},
"path": "ClinicalDocument.documentationOf.serviceEvent.typeId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"constraint": [ {
"key": "II-1",
"human": "An II instance must have either a root or an nullFlavor.",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot",
"severity": "error",
"expression": "root.exists() or nullFlavor.exists()"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question."
}, {
"path": "ClinicalDocument.documentationOf.serviceEvent.typeId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.documentationOf.serviceEvent.typeId.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.documentationOf.serviceEvent.typeId.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "ClinicalDocument.documentationOf.serviceEvent.typeId.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "ClinicalDocument.documentationOf.serviceEvent.typeId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "ClinicalDocument.documentationOf.serviceEvent.typeId.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "ClinicalDocument.documentationOf.serviceEvent.typeId.root",
"min": 1,
"definition": "Identifies the type as an HL7 Registered model",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "2.16.840.1.113883.1.3",
"label": "Root",
"id": "ClinicalDocument.documentationOf.serviceEvent.typeId.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "ClinicalDocument.documentationOf.serviceEvent.typeId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "ClinicalDocument.documentationOf.serviceEvent.typeId.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "ClinicalDocument.documentationOf.serviceEvent.templateId",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
},
"path": "ClinicalDocument.documentationOf.serviceEvent.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"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"
}, {
"path": "ClinicalDocument.documentationOf.serviceEvent.classCode",
"min": 0,
"defaultValueCode": "ACT",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDAActClass"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.documentationOf.serviceEvent.classCode",
"base": {
"max": "1",
"min": 0,
"path": "ServiceEvent.classCode"
}
}, {
"path": "ClinicalDocument.documentationOf.serviceEvent.moodCode",
"fixedCode": "EVN",
"min": 0,
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDAActMood"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.documentationOf.serviceEvent.moodCode",
"base": {
"max": "1",
"min": 0,
"path": "ServiceEvent.moodCode"
}
}, {
"id": "ClinicalDocument.documentationOf.serviceEvent.id",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "ServiceEvent.id"
},
"path": "ClinicalDocument.documentationOf.serviceEvent.id",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ]
}, {
"id": "ClinicalDocument.documentationOf.serviceEvent.code",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "ServiceEvent.code"
},
"path": "ClinicalDocument.documentationOf.serviceEvent.code",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CE"
} ],
"definition": "Drawn from concept domain ActCode"
}, {
"id": "ClinicalDocument.documentationOf.serviceEvent.effectiveTime",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 0,
"path": "ServiceEvent.effectiveTime"
},
"path": "ClinicalDocument.documentationOf.serviceEvent.effectiveTime",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS",
"profile": [ "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmDateTimeInterval" ]
} ],
"comment": "This serviceEvent SHALL contain exactly one [1..1] US Realm Date and Time (Interval) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.3) (CONF:4537-14837)."
}, {
"path": "ClinicalDocument.documentationOf.serviceEvent.effectiveTime.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.documentationOf.serviceEvent.effectiveTime.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.documentationOf.serviceEvent.effectiveTime.value",
"min": 0,
"definition": "A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression.",
"short": "Either @value or low/high should be present, but not both",
"type": [ {
"code": "dateTime",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/ts-simple" ]
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/elementdefinition-date-format",
"valueString": "YYYYMMDDHHMMSS.UUUU[+|-ZZzz]"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/elementdefinition-date-rules",
"valueString": "year-valid:tz-for-time"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.documentationOf.serviceEvent.effectiveTime.value",
"base": {
"max": "1",
"min": 0,
"path": "TS.value"
}
}, {
"path": "ClinicalDocument.documentationOf.serviceEvent.effectiveTime.operator",
"min": 0,
"definition": "A code specifying whether the set component is included (union) or excluded (set-difference) from the set, or other set operations with the current set component and the set as constructed from the representation stream up to the current point.",
"defaultValueCode": "I",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDASetOperator"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.documentationOf.serviceEvent.effectiveTime.operator",
"base": {
"max": "1",
"min": 0,
"path": "SXCM_TS.operator"
}
}, {
"constraint": [ {
"key": "ts-shall-day",
"human": "**SHALL** be precise to at least the day",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmDateTimeInterval",
"severity": "error",
"expression": "nullFlavor.exists() or value.toString().length() >= 10"
}, {
"key": "ts-should-minute",
"human": "**SHOULD** be precise to at least the minute",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmDateTimeInterval",
"severity": "warning",
"expression": "nullFlavor.exists() or value.toString().length() > 10"
} ],
"path": "ClinicalDocument.documentationOf.serviceEvent.effectiveTime.low",
"min": 1,
"definition": "This is the low limit of the interval.",
"short": "**MAY** be precise to at least the second",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS"
} ],
"max": "1",
"label": "Low Boundary",
"id": "ClinicalDocument.documentationOf.serviceEvent.effectiveTime.low",
"comment": "This effectiveTime SHALL contain exactly one [1..1] low (CONF:4537-14838).",
"base": {
"max": "1",
"min": 0,
"path": "IVL_TS.low"
}
}, {
"path": "ClinicalDocument.documentationOf.serviceEvent.effectiveTime.low.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.documentationOf.serviceEvent.effectiveTime.low.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.documentationOf.serviceEvent.effectiveTime.low.value",
"min": 0,
"definition": "A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression.",
"type": [ {
"code": "dateTime",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/ts-simple" ]
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/elementdefinition-date-format",
"valueString": "YYYYMMDDHHMMSS.UUUU[+|-ZZzz]"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/elementdefinition-date-rules",
"valueString": "year-valid:tz-for-time"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.documentationOf.serviceEvent.effectiveTime.low.value",
"base": {
"max": "1",
"min": 0,
"path": "TS.value"
}
}, {
"path": "ClinicalDocument.documentationOf.serviceEvent.effectiveTime.low.inclusive",
"min": 0,
"definition": "Specifies whether the limit is included in the interval (interval is closed) or excluded from the interval (interval is open).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"defaultValueBoolean": true,
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.documentationOf.serviceEvent.effectiveTime.low.inclusive",
"base": {
"max": "1",
"min": 0,
"path": "IVXB_TS.inclusive"
}
}, {
"id": "ClinicalDocument.documentationOf.serviceEvent.effectiveTime.center",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "IVL_TS.center"
},
"path": "ClinicalDocument.documentationOf.serviceEvent.effectiveTime.center",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/TS"
} ],
"label": "Central Value",
"definition": "The arithmetic mean of the interval (low plus high divided by 2). The purpose of distinguishing the center as a semantic property is for conversions of intervals from and to point values."
}, {
"id": "ClinicalDocument.documentationOf.serviceEvent.effectiveTime.width",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "IVL_TS.width"
},
"path": "ClinicalDocument.documentationOf.serviceEvent.effectiveTime.width",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/PQ"
} ],
"label": "Width",
"definition": "The difference between high and low boundary. The purpose of distinguishing a width property is to handle all cases of incomplete information symmetrically. In any interval representation only two of the three properties high, low, and width need to be stated and the third can be derived."
}, {
"constraint": [ {
"key": "ts-shall-day",
"human": "**SHALL** be precise to at least the day",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmDateTimeInterval",
"severity": "error",
"expression": "nullFlavor.exists() or value.toString().length() >= 10"
}, {
"key": "ts-should-minute",
"human": "**SHOULD** be precise to at least the minute",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmDateTimeInterval",
"severity": "warning",
"expression": "nullFlavor.exists() or value.toString().length() > 10"
} ],
"path": "ClinicalDocument.documentationOf.serviceEvent.effectiveTime.high",
"min": 0,
"definition": "This is the high limit of the interval.",
"short": "**MAY** be precise to at least the second",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS"
} ],
"max": "1",
"label": "High Boundary",
"id": "ClinicalDocument.documentationOf.serviceEvent.effectiveTime.high",
"base": {
"max": "1",
"min": 0,
"path": "IVL_TS.high"
}
}, {
"path": "ClinicalDocument.documentationOf.serviceEvent.effectiveTime.high.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.documentationOf.serviceEvent.effectiveTime.high.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.documentationOf.serviceEvent.effectiveTime.high.value",
"min": 0,
"definition": "A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression.",
"type": [ {
"code": "dateTime",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/ts-simple" ]
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/elementdefinition-date-format",
"valueString": "YYYYMMDDHHMMSS.UUUU[+|-ZZzz]"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/elementdefinition-date-rules",
"valueString": "year-valid:tz-for-time"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.documentationOf.serviceEvent.effectiveTime.high.value",
"base": {
"max": "1",
"min": 0,
"path": "TS.value"
}
}, {
"path": "ClinicalDocument.documentationOf.serviceEvent.effectiveTime.high.inclusive",
"min": 0,
"definition": "Specifies whether the limit is included in the interval (interval is closed) or excluded from the interval (interval is open).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"defaultValueBoolean": true,
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.documentationOf.serviceEvent.effectiveTime.high.inclusive",
"base": {
"max": "1",
"min": 0,
"path": "IVXB_TS.inclusive"
}
}, {
"id": "ClinicalDocument.documentationOf.serviceEvent.performer",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "ServiceEvent.performer"
},
"path": "ClinicalDocument.documentationOf.serviceEvent.performer",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Performer1"
} ],
"short": "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.",
"comment": "This serviceEvent SHOULD contain zero or more [0..*] performer (CONF:4537-14839)."
}, {
"path": "ClinicalDocument.documentationOf.serviceEvent.performer.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.documentationOf.serviceEvent.performer.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "ClinicalDocument.documentationOf.serviceEvent.performer.realmCode",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.realmCode"
},
"path": "ClinicalDocument.documentationOf.serviceEvent.performer.realmCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question"
}, {
"id": "ClinicalDocument.documentationOf.serviceEvent.performer.typeId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "InfrastructureRoot.typeId"
},
"path": "ClinicalDocument.documentationOf.serviceEvent.performer.typeId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"constraint": [ {
"key": "II-1",
"human": "An II instance must have either a root or an nullFlavor.",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot",
"severity": "error",
"expression": "root.exists() or nullFlavor.exists()"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question."
}, {
"path": "ClinicalDocument.documentationOf.serviceEvent.performer.typeId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.documentationOf.serviceEvent.performer.typeId.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.documentationOf.serviceEvent.performer.typeId.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "ClinicalDocument.documentationOf.serviceEvent.performer.typeId.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "ClinicalDocument.documentationOf.serviceEvent.performer.typeId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "ClinicalDocument.documentationOf.serviceEvent.performer.typeId.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "ClinicalDocument.documentationOf.serviceEvent.performer.typeId.root",
"min": 1,
"definition": "Identifies the type as an HL7 Registered model",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "2.16.840.1.113883.1.3",
"label": "Root",
"id": "ClinicalDocument.documentationOf.serviceEvent.performer.typeId.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "ClinicalDocument.documentationOf.serviceEvent.performer.typeId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "ClinicalDocument.documentationOf.serviceEvent.performer.typeId.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "ClinicalDocument.documentationOf.serviceEvent.performer.templateId",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
},
"path": "ClinicalDocument.documentationOf.serviceEvent.performer.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"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"
}, {
"path": "ClinicalDocument.documentationOf.serviceEvent.performer.typeCode",
"min": 1,
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.19601"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.documentationOf.serviceEvent.performer.typeCode",
"comment": "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:4537-14840).",
"base": {
"max": "1",
"min": 1,
"path": "Performer1.typeCode"
}
}, {
"id": "ClinicalDocument.documentationOf.serviceEvent.performer.functionCode",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "Performer1.functionCode"
},
"path": "ClinicalDocument.documentationOf.serviceEvent.performer.functionCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CE"
} ],
"comment": "The performer, if present, MAY contain zero or one [0..1] functionCode (CONF:4537-16818).",
"constraint": [ {
"key": "should-code-attr",
"human": "SHOULD contain @code",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader",
"severity": "warning",
"expression": "code.exists()"
} ]
}, {
"path": "ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.code",
"min": 0,
"definition": "The plain code symbol defined by the code system. For example, \"784.0\" is the code symbol of the ICD-9 code \"784.0\" for headache.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "preferred",
"valueSet": "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1099.30"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Code",
"id": "ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.code",
"comment": "The functionCode, if present, SHOULD contain zero or one [0..1] @code, which SHOULD be selected from ValueSet Care Team Member Function urn:oid:2.16.840.1.113762.1.4.1099.30 DYNAMIC (CONF:4537-32889).",
"base": {
"max": "1",
"min": 0,
"path": "CD.code"
}
}, {
"path": "ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.codeSystem",
"min": 0,
"definition": "Specifies the code system that defines the code.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Code System",
"id": "ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.codeSystem",
"base": {
"max": "1",
"min": 0,
"path": "CD.codeSystem"
}
}, {
"path": "ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.codeSystemName",
"min": 0,
"definition": "The common name of the coding system.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Code System Name",
"id": "ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.codeSystemName",
"base": {
"max": "1",
"min": 0,
"path": "CD.codeSystemName"
}
}, {
"path": "ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.codeSystemVersion",
"min": 0,
"definition": "If applicable, a version descriptor defined specifically for the given code system.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Code System Version",
"id": "ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.codeSystemVersion",
"base": {
"max": "1",
"min": 0,
"path": "CD.codeSystemVersion"
}
}, {
"path": "ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.displayName",
"min": 0,
"definition": "A name or title for the code, under which the sending system shows the code value to its users.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Display Name",
"id": "ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.displayName",
"base": {
"max": "1",
"min": 0,
"path": "CD.displayName"
}
}, {
"path": "ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.sdtcValueSet",
"min": 0,
"definition": "The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid" ]
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "valueSet"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.sdtcValueSet",
"base": {
"max": "1",
"min": 0,
"path": "CD.valueSet"
}
}, {
"path": "ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.sdtcValueSetVersion",
"min": 0,
"definition": "The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "valueSetVersion"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.sdtcValueSetVersion",
"base": {
"max": "1",
"min": 0,
"path": "CD.sdtcValueSetVersion"
}
}, {
"id": "ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.originalText",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "CD.originalText"
},
"path": "ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.originalText",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ED"
} ],
"label": "Original Text",
"definition": "The text or phrase used as the basis for the coding."
}, {
"id": "ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.qualifier",
"max": "0",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "CD.qualifier"
},
"path": "ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.qualifier",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CR"
} ],
"label": "Qualifier",
"definition": "Specifies additional codes that increase the specificity of the the primary code."
}, {
"path": "ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.translation",
"min": 0,
"definition": "A set of other concept descriptors that translate this concept descriptor into other code systems.",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CD"
} ],
"representation": [ "typeAttr" ],
"max": "*",
"label": "Translation",
"id": "ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.translation",
"base": {
"max": "*",
"min": 0,
"path": "CD.translation"
}
}, {
"id": "ClinicalDocument.documentationOf.serviceEvent.performer.time",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "Performer1.time"
},
"path": "ClinicalDocument.documentationOf.serviceEvent.performer.time",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS",
"profile": [ "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmDateTimeInterval" ]
} ]
}, {
"id": "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "Performer1.assignedEntity"
},
"path": "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity"
} ],
"comment": "The performer, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:4537-14841).",
"constraint": [ {
"key": "should-us-code",
"human": "SHOULD contain code",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader",
"severity": "warning",
"expression": "code.exists()"
} ]
}, {
"path": "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.realmCode",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.realmCode"
},
"path": "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.realmCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question"
}, {
"id": "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.typeId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "InfrastructureRoot.typeId"
},
"path": "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.typeId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"constraint": [ {
"key": "II-1",
"human": "An II instance must have either a root or an nullFlavor.",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot",
"severity": "error",
"expression": "root.exists() or nullFlavor.exists()"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question."
}, {
"path": "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.typeId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.typeId.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.typeId.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.typeId.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.typeId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.typeId.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.typeId.root",
"min": 1,
"definition": "Identifies the type as an HL7 Registered model",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "2.16.840.1.113883.1.3",
"label": "Root",
"id": "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.typeId.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.typeId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.typeId.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.templateId",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
},
"path": "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"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"
}, {
"path": "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.classCode",
"fixedCode": "ASSIGNED",
"min": 0,
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-RoleClassAssignedEntity"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.classCode",
"base": {
"max": "1",
"min": 0,
"path": "AssignedEntity.classCode"
}
}, {
"id": "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id",
"max": "*",
"min": 1,
"base": {
"max": "*",
"min": 1,
"path": "AssignedEntity.id"
},
"path": "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"comment": "This assignedEntity SHALL contain at least one [1..*] id (CONF:4537-14846)."
}, {
"path": "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"constraint": [ {
"key": "should-npi",
"human": "SHOULD be NPI",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader",
"severity": "warning",
"expression": "$this = '2.16.840.1.113883.4.6'"
} ],
"path": "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id.root",
"min": 0,
"definition": "A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Root",
"id": "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id.root",
"comment": "Such ids SHOULD contain zero or one [0..1] @root=\"2.16.840.1.113883.4.6\" National Provider Identifier (CONF:4537-14847).",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id.extension",
"min": 0,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.sdtcIdentifiedBy",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "AssignedEntity.sdtcIdentifiedBy"
},
"path": "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.sdtcIdentifiedBy",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "identifiedBy"
} ]
}, {
"id": "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.code",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "AssignedEntity.code"
},
"path": "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.code",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CE"
} ],
"binding": {
"strength": "preferred",
"valueSet": "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066"
},
"comment": "This assignedEntity SHOULD contain zero or one [0..1] code, which SHOULD be selected from ValueSet Healthcare Provider Taxonomy urn:oid:2.16.840.1.114222.4.11.1066 DYNAMIC (CONF:4537-14842)."
}, {
"id": "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.addr",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "AssignedEntity.addr"
},
"path": "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.addr",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/AD"
} ]
}, {
"id": "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.telecom",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "AssignedEntity.telecom"
},
"path": "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.telecom",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/TEL"
} ]
}, {
"id": "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.assignedPerson",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "AssignedEntity.assignedPerson"
},
"path": "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.assignedPerson",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Person"
} ]
}, {
"id": "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.representedOrganization",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "AssignedEntity.representedOrganization"
},
"path": "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.representedOrganization",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Organization"
} ]
}, {
"id": "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.sdtcPatient",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "AssignedEntity.sdtcPatient"
},
"path": "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.sdtcPatient",
"type": [ {
"code": "http://hl7.org/fhir/StructureDefinition/Base"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "patient"
} ]
}, {
"id": "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.sdtcPatient.id",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "AssignedEntity.sdtcPatient.id"
},
"path": "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.sdtcPatient.id",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
} ]
}, {
"id": "ClinicalDocument.relatedDocument",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "ClinicalDocument.relatedDocument"
},
"path": "ClinicalDocument.relatedDocument",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/RelatedDocument"
} ]
}, {
"id": "ClinicalDocument.authorization",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "ClinicalDocument.authorization"
},
"path": "ClinicalDocument.authorization",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Authorization"
} ],
"short": "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.",
"comment": "MAY contain zero or more [0..*] authorization (CONF:4537-16792) such that it"
}, {
"path": "ClinicalDocument.authorization.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.authorization.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "ClinicalDocument.authorization.realmCode",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.realmCode"
},
"path": "ClinicalDocument.authorization.realmCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question"
}, {
"id": "ClinicalDocument.authorization.typeId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "InfrastructureRoot.typeId"
},
"path": "ClinicalDocument.authorization.typeId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"constraint": [ {
"key": "II-1",
"human": "An II instance must have either a root or an nullFlavor.",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot",
"severity": "error",
"expression": "root.exists() or nullFlavor.exists()"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question."
}, {
"path": "ClinicalDocument.authorization.typeId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.authorization.typeId.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.authorization.typeId.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "ClinicalDocument.authorization.typeId.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "ClinicalDocument.authorization.typeId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "ClinicalDocument.authorization.typeId.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "ClinicalDocument.authorization.typeId.root",
"min": 1,
"definition": "Identifies the type as an HL7 Registered model",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "2.16.840.1.113883.1.3",
"label": "Root",
"id": "ClinicalDocument.authorization.typeId.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "ClinicalDocument.authorization.typeId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "ClinicalDocument.authorization.typeId.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "ClinicalDocument.authorization.templateId",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
},
"path": "ClinicalDocument.authorization.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"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"
}, {
"path": "ClinicalDocument.authorization.typeCode",
"fixedCode": "AUTH",
"min": 0,
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-ActRelationshipAuthorizedBy"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.authorization.typeCode",
"base": {
"max": "1",
"min": 0,
"path": "Authorization.typeCode"
}
}, {
"id": "ClinicalDocument.authorization.consent",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "Authorization.consent"
},
"path": "ClinicalDocument.authorization.consent",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Consent"
} ],
"comment": "SHALL contain exactly one [1..1] consent (CONF:4537-16793)."
}, {
"path": "ClinicalDocument.authorization.consent.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.authorization.consent.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "ClinicalDocument.authorization.consent.realmCode",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.realmCode"
},
"path": "ClinicalDocument.authorization.consent.realmCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question"
}, {
"id": "ClinicalDocument.authorization.consent.typeId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "InfrastructureRoot.typeId"
},
"path": "ClinicalDocument.authorization.consent.typeId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"constraint": [ {
"key": "II-1",
"human": "An II instance must have either a root or an nullFlavor.",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot",
"severity": "error",
"expression": "root.exists() or nullFlavor.exists()"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question."
}, {
"path": "ClinicalDocument.authorization.consent.typeId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.authorization.consent.typeId.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.authorization.consent.typeId.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "ClinicalDocument.authorization.consent.typeId.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "ClinicalDocument.authorization.consent.typeId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "ClinicalDocument.authorization.consent.typeId.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "ClinicalDocument.authorization.consent.typeId.root",
"min": 1,
"definition": "Identifies the type as an HL7 Registered model",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "2.16.840.1.113883.1.3",
"label": "Root",
"id": "ClinicalDocument.authorization.consent.typeId.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "ClinicalDocument.authorization.consent.typeId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "ClinicalDocument.authorization.consent.typeId.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "ClinicalDocument.authorization.consent.templateId",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
},
"path": "ClinicalDocument.authorization.consent.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"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"
}, {
"path": "ClinicalDocument.authorization.consent.classCode",
"fixedCode": "CONS",
"min": 0,
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDAActClass"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.authorization.consent.classCode",
"base": {
"max": "1",
"min": 0,
"path": "Consent.classCode"
}
}, {
"path": "ClinicalDocument.authorization.consent.moodCode",
"fixedCode": "EVN",
"min": 0,
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDAActMood"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.authorization.consent.moodCode",
"base": {
"max": "1",
"min": 0,
"path": "Consent.moodCode"
}
}, {
"id": "ClinicalDocument.authorization.consent.id",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "Consent.id"
},
"path": "ClinicalDocument.authorization.consent.id",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"comment": "This consent MAY contain zero or more [0..*] id (CONF:4537-16794)."
}, {
"path": "ClinicalDocument.authorization.consent.code",
"min": 0,
"short": "The type of consent (e.g., a consent to perform the related serviceEvent) is conveyed in consent/code.",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CE"
} ],
"binding": {
"strength": "example",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-ActCode"
},
"max": "1",
"id": "ClinicalDocument.authorization.consent.code",
"comment": "This consent MAY contain zero or one [0..1] code (CONF:4537-16795).",
"base": {
"max": "1",
"min": 0,
"path": "Consent.code"
}
}, {
"id": "ClinicalDocument.authorization.consent.statusCode",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "Consent.statusCode"
},
"path": "ClinicalDocument.authorization.consent.statusCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-ActStatus"
},
"comment": "This consent SHALL contain exactly one [1..1] statusCode (CONF:4537-16797)."
}, {
"path": "ClinicalDocument.authorization.consent.statusCode.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.authorization.consent.statusCode.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.authorization.consent.statusCode.code",
"fixedCode": "completed",
"min": 1,
"definition": "The plain code symbol defined by the code system. For example, \"784.0\" is the code symbol of the ICD-9 code \"784.0\" for headache.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Code",
"id": "ClinicalDocument.authorization.consent.statusCode.code",
"comment": "This statusCode SHALL contain exactly one [1..1] @code=\"completed\" Completed (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6) (CONF:4537-16798).",
"base": {
"max": "1",
"min": 0,
"path": "CD.code"
}
}, {
"path": "ClinicalDocument.authorization.consent.statusCode.codeSystem",
"min": 0,
"definition": "Specifies the code system that defines the code.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "0",
"label": "Code System",
"id": "ClinicalDocument.authorization.consent.statusCode.codeSystem",
"base": {
"max": "1",
"min": 0,
"path": "CD.codeSystem"
}
}, {
"path": "ClinicalDocument.authorization.consent.statusCode.codeSystemName",
"min": 0,
"definition": "The common name of the coding system.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "0",
"label": "Code System Name",
"id": "ClinicalDocument.authorization.consent.statusCode.codeSystemName",
"base": {
"max": "1",
"min": 0,
"path": "CD.codeSystemName"
}
}, {
"path": "ClinicalDocument.authorization.consent.statusCode.codeSystemVersion",
"min": 0,
"definition": "If applicable, a version descriptor defined specifically for the given code system.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "0",
"label": "Code System Version",
"id": "ClinicalDocument.authorization.consent.statusCode.codeSystemVersion",
"base": {
"max": "1",
"min": 0,
"path": "CD.codeSystemVersion"
}
}, {
"path": "ClinicalDocument.authorization.consent.statusCode.displayName",
"min": 0,
"definition": "A name or title for the code, under which the sending system shows the code value to its users.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "0",
"label": "Display Name",
"id": "ClinicalDocument.authorization.consent.statusCode.displayName",
"base": {
"max": "1",
"min": 0,
"path": "CD.displayName"
}
}, {
"path": "ClinicalDocument.authorization.consent.statusCode.sdtcValueSet",
"min": 0,
"definition": "The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid" ]
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "valueSet"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.authorization.consent.statusCode.sdtcValueSet",
"base": {
"max": "1",
"min": 0,
"path": "CD.valueSet"
}
}, {
"path": "ClinicalDocument.authorization.consent.statusCode.sdtcValueSetVersion",
"min": 0,
"definition": "The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "valueSetVersion"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.authorization.consent.statusCode.sdtcValueSetVersion",
"base": {
"max": "1",
"min": 0,
"path": "CD.sdtcValueSetVersion"
}
}, {
"id": "ClinicalDocument.authorization.consent.statusCode.originalText",
"max": "0",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "CD.originalText"
},
"path": "ClinicalDocument.authorization.consent.statusCode.originalText",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ED"
} ],
"label": "Original Text",
"definition": "The text or phrase used as the basis for the coding."
}, {
"id": "ClinicalDocument.authorization.consent.statusCode.qualifier",
"max": "0",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "CD.qualifier"
},
"path": "ClinicalDocument.authorization.consent.statusCode.qualifier",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CR"
} ],
"label": "Qualifier",
"definition": "Specifies additional codes that increase the specificity of the the primary code."
}, {
"path": "ClinicalDocument.authorization.consent.statusCode.translation",
"min": 0,
"definition": "A set of other concept descriptors that translate this concept descriptor into other code systems.",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CD"
} ],
"representation": [ "typeAttr" ],
"max": "0",
"label": "Translation",
"id": "ClinicalDocument.authorization.consent.statusCode.translation",
"base": {
"max": "*",
"min": 0,
"path": "CD.translation"
}
}, {
"id": "ClinicalDocument.componentOf",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 0,
"path": "ClinicalDocument.componentOf"
},
"path": "ClinicalDocument.componentOf",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ComponentOf"
} ],
"short": "The H&P Note is always associated with an encounter.",
"comment": "SHALL contain exactly one [1..1] componentOf (CONF:1198-8338)."
}, {
"path": "ClinicalDocument.componentOf.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.componentOf.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "ClinicalDocument.componentOf.realmCode",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.realmCode"
},
"path": "ClinicalDocument.componentOf.realmCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question"
}, {
"id": "ClinicalDocument.componentOf.typeId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "InfrastructureRoot.typeId"
},
"path": "ClinicalDocument.componentOf.typeId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"constraint": [ {
"key": "II-1",
"human": "An II instance must have either a root or an nullFlavor.",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot",
"severity": "error",
"expression": "root.exists() or nullFlavor.exists()"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question."
}, {
"path": "ClinicalDocument.componentOf.typeId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.componentOf.typeId.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.componentOf.typeId.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "ClinicalDocument.componentOf.typeId.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "ClinicalDocument.componentOf.typeId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "ClinicalDocument.componentOf.typeId.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "ClinicalDocument.componentOf.typeId.root",
"min": 1,
"definition": "Identifies the type as an HL7 Registered model",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "2.16.840.1.113883.1.3",
"label": "Root",
"id": "ClinicalDocument.componentOf.typeId.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "ClinicalDocument.componentOf.typeId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "ClinicalDocument.componentOf.typeId.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "ClinicalDocument.componentOf.templateId",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
},
"path": "ClinicalDocument.componentOf.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"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"
}, {
"path": "ClinicalDocument.componentOf.typeCode",
"fixedCode": "COMP",
"min": 0,
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-ActRelationshipHasComponent"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.componentOf.typeCode",
"base": {
"max": "1",
"min": 0,
"path": "ComponentOf.typeCode"
}
}, {
"id": "ClinicalDocument.componentOf.encompassingEncounter",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "ComponentOf.encompassingEncounter"
},
"path": "ClinicalDocument.componentOf.encompassingEncounter",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/EncompassingEncounter"
} ],
"comment": "This componentOf SHALL contain exactly one [1..1] encompassingEncounter (CONF:1198-8339).",
"constraint": [ {
"key": "should-responsibleParty",
"human": "SHOULD contain responsibleParty",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader",
"severity": "warning",
"expression": "responsibleParty.exists()"
} ]
}, {
"path": "ClinicalDocument.componentOf.encompassingEncounter.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.componentOf.encompassingEncounter.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "ClinicalDocument.componentOf.encompassingEncounter.realmCode",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.realmCode"
},
"path": "ClinicalDocument.componentOf.encompassingEncounter.realmCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question"
}, {
"id": "ClinicalDocument.componentOf.encompassingEncounter.typeId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "InfrastructureRoot.typeId"
},
"path": "ClinicalDocument.componentOf.encompassingEncounter.typeId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"constraint": [ {
"key": "II-1",
"human": "An II instance must have either a root or an nullFlavor.",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot",
"severity": "error",
"expression": "root.exists() or nullFlavor.exists()"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question."
}, {
"path": "ClinicalDocument.componentOf.encompassingEncounter.typeId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.componentOf.encompassingEncounter.typeId.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.componentOf.encompassingEncounter.typeId.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "ClinicalDocument.componentOf.encompassingEncounter.typeId.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "ClinicalDocument.componentOf.encompassingEncounter.typeId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "ClinicalDocument.componentOf.encompassingEncounter.typeId.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "ClinicalDocument.componentOf.encompassingEncounter.typeId.root",
"min": 1,
"definition": "Identifies the type as an HL7 Registered model",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "2.16.840.1.113883.1.3",
"label": "Root",
"id": "ClinicalDocument.componentOf.encompassingEncounter.typeId.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "ClinicalDocument.componentOf.encompassingEncounter.typeId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "ClinicalDocument.componentOf.encompassingEncounter.typeId.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "ClinicalDocument.componentOf.encompassingEncounter.templateId",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
},
"path": "ClinicalDocument.componentOf.encompassingEncounter.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"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"
}, {
"path": "ClinicalDocument.componentOf.encompassingEncounter.classCode",
"fixedCode": "ENC",
"min": 0,
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDAActClass"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.componentOf.encompassingEncounter.classCode",
"base": {
"max": "1",
"min": 0,
"path": "EncompassingEncounter.classCode"
}
}, {
"path": "ClinicalDocument.componentOf.encompassingEncounter.moodCode",
"fixedCode": "EVN",
"min": 0,
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDAActMood"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.componentOf.encompassingEncounter.moodCode",
"base": {
"max": "1",
"min": 0,
"path": "EncompassingEncounter.moodCode"
}
}, {
"id": "ClinicalDocument.componentOf.encompassingEncounter.id",
"max": "*",
"min": 1,
"base": {
"max": "*",
"min": 0,
"path": "EncompassingEncounter.id"
},
"path": "ClinicalDocument.componentOf.encompassingEncounter.id",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"comment": "This encompassingEncounter SHALL contain at least one [1..*] id (CONF:1198-8340)."
}, {
"id": "ClinicalDocument.componentOf.encompassingEncounter.code",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "EncompassingEncounter.code"
},
"path": "ClinicalDocument.componentOf.encompassingEncounter.code",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CE"
} ],
"binding": {
"strength": "preferred",
"valueSet": "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1240.5"
},
"comment": "This encompassingEncounter MAY contain zero or one [0..1] code, which SHOULD be selected from ValueSet Act Encounter Codes urn:oid:2.16.840.1.113762.1.4.1240.5 (CONF:1198-30873)."
}, {
"id": "ClinicalDocument.componentOf.encompassingEncounter.effectiveTime",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "EncompassingEncounter.effectiveTime"
},
"path": "ClinicalDocument.componentOf.encompassingEncounter.effectiveTime",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS",
"profile": [ "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmDateTimeInterval" ]
} ],
"short": "The effectiveTime represents the time interval or point in time in which the encounter took place.",
"comment": "This encompassingEncounter SHALL contain exactly one [1..1] US Realm Date and Time (Interval) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.3) (CONF:1198-8341)."
}, {
"id": "ClinicalDocument.componentOf.encompassingEncounter.sdtcAdmissionReferralSourceCode",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "EncompassingEncounter.sdtcAdmissionReferralSourceCode"
},
"path": "ClinicalDocument.componentOf.encompassingEncounter.sdtcAdmissionReferralSourceCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CE"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "admissionReferralSourceCode"
} ],
"definition": "This element is a coded concept that represents the type of referral. Its RIM source class is PatientEncounter."
}, {
"id": "ClinicalDocument.componentOf.encompassingEncounter.dischargeDispositionCode",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "EncompassingEncounter.dischargeDispositionCode"
},
"path": "ClinicalDocument.componentOf.encompassingEncounter.dischargeDispositionCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CE"
} ],
"binding": {
"strength": "example",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-USEncounterDischargeDisposition"
}
}, {
"constraint": [ {
"key": "1198-8348",
"human": "The responsibleParty element, if present, **SHALL** contain an assignedEntity element, which **SHALL** contain an assignedPerson element, a representedOrganization element, or both (CONF:1198-8348).",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/HistoryandPhysical",
"severity": "error",
"expression": "assignedEntity.assignedPerson.exists() or assignedEntity.representedOrganization.exists()"
} ],
"path": "ClinicalDocument.componentOf.encompassingEncounter.responsibleParty",
"min": 0,
"definition": "The responsibleParty participant represents the participant having primary legal responsibility for the encounter. This differs from the legalAuthenticator participant in that the legalAuthenticator may or may not be the responsible party, and is serving a medical records function by signing off on the document, moving it into a completed state.",
"short": "The responsibleParty element records only the party responsible for the encounter, not necessarily the entire episode of care.",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot"
} ],
"max": "1",
"id": "ClinicalDocument.componentOf.encompassingEncounter.responsibleParty",
"comment": "This encompassingEncounter MAY contain zero or one [0..1] responsibleParty (CONF:1198-8345).",
"base": {
"max": "1",
"min": 0,
"path": "EncompassingEncounter.responsibleParty"
}
}, {
"path": "ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.realmCode",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.realmCode"
},
"path": "ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.realmCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question"
}, {
"id": "ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.typeId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "InfrastructureRoot.typeId"
},
"path": "ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.typeId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"constraint": [ {
"key": "II-1",
"human": "An II instance must have either a root or an nullFlavor.",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/ClinicalDocument",
"severity": "error",
"expression": "root.exists() or nullFlavor.exists()"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question."
}, {
"path": "ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.typeId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.typeId.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.typeId.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.typeId.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.typeId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.typeId.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.typeId.root",
"min": 1,
"definition": "Identifies the type as an HL7 Registered model",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "2.16.840.1.113883.1.3",
"label": "Root",
"id": "ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.typeId.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.typeId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.typeId.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.templateId",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
},
"path": "ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"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"
}, {
"path": "ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.typeCode",
"fixedCode": "RESP",
"min": 0,
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.typeCode",
"base": {
"max": "1",
"min": 0,
"path": "EncompassingEncounter.responsibleParty.typeCode"
}
}, {
"id": "ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.assignedEntity",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "EncompassingEncounter.responsibleParty.assignedEntity"
},
"path": "ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.assignedEntity",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity"
} ],
"comment": "The responsibleParty, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:1198-32904).",
"constraint": [ {
"key": "1198-32905",
"human": "This assignedEntity SHALL contain an assignedPerson or a representedOrganization or both (CONF:1198-32905).",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader",
"severity": "error",
"expression": "assignedPerson.exists() or representedOrganization.exists()"
} ]
}, {
"constraint": [ {
"key": "1198-8343",
"human": "An encounterParticipant element, if present, SHALL contain an assignedEntity element, which SHALL contain an assignedPerson element, a representedOrganization element, or both (CONF:1198-8343).",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/HistoryandPhysical",
"severity": "error",
"expression": "assignedEntity.assignedPerson.exists() or assignedEntity.representedOrganization.exists()"
} ],
"path": "ClinicalDocument.componentOf.encompassingEncounter.encounterParticipant",
"min": 0,
"short": "The encounterParticipant elements represent only those participants in the encounter, not necessarily the entire episode of care.",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/EncounterParticipant"
} ],
"max": "*",
"id": "ClinicalDocument.componentOf.encompassingEncounter.encounterParticipant",
"comment": "This encompassingEncounter MAY contain zero or more [0..*] encounterParticipant (CONF:1198-8342).",
"base": {
"max": "*",
"min": 0,
"path": "EncompassingEncounter.encounterParticipant"
}
}, {
"id": "ClinicalDocument.componentOf.encompassingEncounter.location",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "EncompassingEncounter.location"
},
"path": "ClinicalDocument.componentOf.encompassingEncounter.location",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot"
} ],
"comment": "This encompassingEncounter MAY contain zero or one [0..1] location (CONF:1198-8344).",
"definition": "The location participant (location class) relates a healthcare facility (HealthCareFacility class) to the encounter to indicate where the encounter took place. The entity playing the role of HealthCareFacility is a place (Place class). The entity scoping the HealthCareFacility role is an organization (Organization class).\n\nThe setting of an encounter (e.g. cardiology clinic, primary care clinic, rehabilitation hospital, skilled nursing facility) can be expressed in HealthCareFacility.code. Note that setting and physical location are not the same. There is a many-to-many relationship between setting and the physical location where care is delivered. Thus, a particular room can provide the location for cardiology clinic one day, and for primary care clinic another day; and cardiology clinic today might be held in one physical location, but in another physical location tomorrow.\n\nWhen the location is an organization, this is indicated by the presence of a scoping Organization, without a playing Place."
}, {
"path": "ClinicalDocument.componentOf.encompassingEncounter.location.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.componentOf.encompassingEncounter.location.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "ClinicalDocument.componentOf.encompassingEncounter.location.realmCode",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.realmCode"
},
"path": "ClinicalDocument.componentOf.encompassingEncounter.location.realmCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question"
}, {
"id": "ClinicalDocument.componentOf.encompassingEncounter.location.typeId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "InfrastructureRoot.typeId"
},
"path": "ClinicalDocument.componentOf.encompassingEncounter.location.typeId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"constraint": [ {
"key": "II-1",
"human": "An II instance must have either a root or an nullFlavor.",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/ClinicalDocument",
"severity": "error",
"expression": "root.exists() or nullFlavor.exists()"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question."
}, {
"path": "ClinicalDocument.componentOf.encompassingEncounter.location.typeId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.componentOf.encompassingEncounter.location.typeId.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.componentOf.encompassingEncounter.location.typeId.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "ClinicalDocument.componentOf.encompassingEncounter.location.typeId.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "ClinicalDocument.componentOf.encompassingEncounter.location.typeId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "ClinicalDocument.componentOf.encompassingEncounter.location.typeId.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "ClinicalDocument.componentOf.encompassingEncounter.location.typeId.root",
"min": 1,
"definition": "Identifies the type as an HL7 Registered model",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "2.16.840.1.113883.1.3",
"label": "Root",
"id": "ClinicalDocument.componentOf.encompassingEncounter.location.typeId.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "ClinicalDocument.componentOf.encompassingEncounter.location.typeId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "ClinicalDocument.componentOf.encompassingEncounter.location.typeId.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "ClinicalDocument.componentOf.encompassingEncounter.location.templateId",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
},
"path": "ClinicalDocument.componentOf.encompassingEncounter.location.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"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"
}, {
"path": "ClinicalDocument.componentOf.encompassingEncounter.location.typeCode",
"fixedCode": "LOC",
"min": 0,
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-ParticipationTargetLocation"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.componentOf.encompassingEncounter.location.typeCode",
"base": {
"max": "1",
"min": 0,
"path": "EncompassingEncounter.location.typeCode"
}
}, {
"id": "ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "EncompassingEncounter.location.healthCareFacility"
},
"path": "ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/HealthCareFacility"
} ]
}, {
"id": "ClinicalDocument.component",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "ClinicalDocument.component"
},
"path": "ClinicalDocument.component",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Component"
} ],
"comment": "SHALL contain exactly one [1..1] component (CONF:1198-8349)."
}, {
"path": "ClinicalDocument.component.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.component.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "ClinicalDocument.component.realmCode",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.realmCode"
},
"path": "ClinicalDocument.component.realmCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question"
}, {
"id": "ClinicalDocument.component.typeId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "InfrastructureRoot.typeId"
},
"path": "ClinicalDocument.component.typeId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"constraint": [ {
"key": "II-1",
"human": "An II instance must have either a root or an nullFlavor.",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot",
"severity": "error",
"expression": "root.exists() or nullFlavor.exists()"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question."
}, {
"path": "ClinicalDocument.component.typeId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.component.typeId.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.component.typeId.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "ClinicalDocument.component.typeId.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "ClinicalDocument.component.typeId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "ClinicalDocument.component.typeId.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "ClinicalDocument.component.typeId.root",
"min": 1,
"definition": "Identifies the type as an HL7 Registered model",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "2.16.840.1.113883.1.3",
"label": "Root",
"id": "ClinicalDocument.component.typeId.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "ClinicalDocument.component.typeId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "ClinicalDocument.component.typeId.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "ClinicalDocument.component.templateId",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
},
"path": "ClinicalDocument.component.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"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"
}, {
"path": "ClinicalDocument.component.typeCode",
"fixedCode": "COMP",
"min": 0,
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-ActRelationshipHasComponent"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.component.typeCode",
"base": {
"max": "1",
"min": 0,
"path": "Component.typeCode"
}
}, {
"id": "ClinicalDocument.component.contextConductionInd",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "Component.contextConductionInd"
},
"path": "ClinicalDocument.component.contextConductionInd",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"fixedBoolean": true,
"representation": [ "xmlAttr" ]
}, {
"id": "ClinicalDocument.component.nonXMLBody",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "Component.nonXMLBody"
},
"path": "ClinicalDocument.component.nonXMLBody",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/NonXMLBody"
} ]
}, {
"constraint": [ {
"key": "ccrfv-or-cc-or-rfv",
"human": "This structuredBody **SHALL** contain a Chief Complaint and Reason for Visit Section (2.16.840.1.113883.10.20.22.2.13) or a Chief Complaint Section (1.3.6.1.4.1.19376.1.5.3.1.1.13.2.1) or a Reason for Visit Section (2.16.840.1.113883.10.20.22.2.12).",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/HistoryandPhysical",
"severity": "error",
"expression": "component.where(section.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/ChiefComplaintandReasonforVisitSection').exists() or section.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/ChiefComplaintSection').exists() or section.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/ReasonforVisitSection').exists()).exists()"
}, {
"key": "ap-or-a-and-p",
"human": "**SHALL** include an Assessment and Plan Section, or both an Assessment Section and a Plan of Treatment Section.",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/HistoryandPhysical",
"severity": "error",
"expression": "component.where(section.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/AssessmentandPlanSection')).exists() or (component.where(section.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/AssessmentSection') or section.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/PlanofTreatmentSection')).count() = 2)"
}, {
"key": "ap-combo",
"human": "This structuredBody **SHALL NOT** contain an Assessment and Plan Section (2.16.840.1.113883.10.20.22.2.9:2014-06-09) when either an Assessment Section (2.16.840.1.113883.10.20.22.2.8) or a Plan of Treatment Section (2.16.840.1.113883.10.20.22.2.10:2014-06-09) is present.",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/HistoryandPhysical",
"severity": "error",
"expression": "component.where(section.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/AssessmentandPlanSection')).exists() implies component.where(section.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/AssessmentSection') or section.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/PlanofTreatmentSection')).empty()"
}, {
"key": "cc-rfv-combo",
"human": "This structuredBody **SHALL NOT** contain a Chief Complaint and Reason for Visit Section (2.16.840.1.113883.10.20.22.2.13) when either a Chief Complaint Section (1.3.6.1.4.1.19376.1.5.3.1.1.13.2.1) or a Reason for Visit Section (2.16.840.1.113883.10.20.22.2.12) is present.",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/HistoryandPhysical",
"severity": "error",
"expression": "component.where(section.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/ChiefComplaintandReasonforVisitSection')).exists() implies component.where(section.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/ChiefComplaintSection') or section.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/ReasonforVisitSection')).empty()"
}, {
"key": "should-section-hpi",
"human": "SHOULD contain a History of Present Illness Section",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/HistoryandPhysical",
"severity": "warning",
"expression": "component.where(section.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/HistoryofPresentIllnessSection'))"
} ],
"path": "ClinicalDocument.component.structuredBody",
"min": 1,
"short": "In this template (templateId 2.16.840.1.113883.10.20.22.1.3.2), coded entries are optional.",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/StructuredBody"
} ],
"max": "1",
"id": "ClinicalDocument.component.structuredBody",
"comment": "This component SHALL contain exactly one [1..1] structuredBody (CONF:1198-30570).",
"base": {
"max": "1",
"min": 0,
"path": "Component.structuredBody"
}
}, {
"path": "ClinicalDocument.component.structuredBody.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.component.structuredBody.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "ClinicalDocument.component.structuredBody.realmCode",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.realmCode"
},
"path": "ClinicalDocument.component.structuredBody.realmCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question"
}, {
"id": "ClinicalDocument.component.structuredBody.typeId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "InfrastructureRoot.typeId"
},
"path": "ClinicalDocument.component.structuredBody.typeId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"constraint": [ {
"key": "II-1",
"human": "An II instance must have either a root or an nullFlavor.",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot",
"severity": "error",
"expression": "root.exists() or nullFlavor.exists()"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question."
}, {
"path": "ClinicalDocument.component.structuredBody.typeId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.component.structuredBody.typeId.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.component.structuredBody.typeId.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "ClinicalDocument.component.structuredBody.typeId.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "ClinicalDocument.component.structuredBody.typeId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "ClinicalDocument.component.structuredBody.typeId.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "ClinicalDocument.component.structuredBody.typeId.root",
"min": 1,
"definition": "Identifies the type as an HL7 Registered model",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "2.16.840.1.113883.1.3",
"label": "Root",
"id": "ClinicalDocument.component.structuredBody.typeId.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "ClinicalDocument.component.structuredBody.typeId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "ClinicalDocument.component.structuredBody.typeId.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "ClinicalDocument.component.structuredBody.templateId",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
},
"path": "ClinicalDocument.component.structuredBody.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"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"
}, {
"path": "ClinicalDocument.component.structuredBody.classCode",
"fixedCode": "DOCBODY",
"min": 0,
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-ActClassRecordOrganizer"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.component.structuredBody.classCode",
"base": {
"max": "1",
"min": 0,
"path": "StructuredBody.classCode"
}
}, {
"path": "ClinicalDocument.component.structuredBody.moodCode",
"fixedCode": "EVN",
"min": 0,
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDAActMood"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ClinicalDocument.component.structuredBody.moodCode",
"base": {
"max": "1",
"min": 0,
"path": "StructuredBody.moodCode"
}
}, {
"id": "ClinicalDocument.component.structuredBody.confidentialityCode",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "StructuredBody.confidentialityCode"
},
"path": "ClinicalDocument.component.structuredBody.confidentialityCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CE"
} ]
}, {
"id": "ClinicalDocument.component.structuredBody.languageCode",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "StructuredBody.languageCode"
},
"path": "ClinicalDocument.component.structuredBody.languageCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/all-languages"
}
}, {
"id": "ClinicalDocument.component.structuredBody.component",
"max": "*",
"min": 12,
"base": {
"max": "*",
"min": 1,
"path": "StructuredBody.component"
},
"path": "ClinicalDocument.component.structuredBody.component",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot"
} ],
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "section",
"type": "profile"
} ]
}
}, {
"path": "ClinicalDocument.component.structuredBody.component.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.component.structuredBody.component.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "ClinicalDocument.component.structuredBody.component.realmCode",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.realmCode"
},
"path": "ClinicalDocument.component.structuredBody.component.realmCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question"
}, {
"id": "ClinicalDocument.component.structuredBody.component.typeId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "InfrastructureRoot.typeId"
},
"path": "ClinicalDocument.component.structuredBody.component.typeId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"constraint": [ {
"key": "II-1",
"human": "An II instance must have either a root or an nullFlavor.",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader",
"severity": "error",
"expression": "root.exists() or nullFlavor.exists()"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question."
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.component.structuredBody.component.typeId.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "ClinicalDocument.component.structuredBody.component.typeId.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "ClinicalDocument.component.structuredBody.component.typeId.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.root",
"min": 1,
"definition": "Identifies the type as an HL7 Registered model",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "2.16.840.1.113883.1.3",
"label": "Root",
"id": "ClinicalDocument.component.structuredBody.component.typeId.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "ClinicalDocument.component.structuredBody.component.typeId.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "ClinicalDocument.component.structuredBody.component.templateId",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
},
"path": "ClinicalDocument.component.structuredBody.component.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"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"
}, {
"id": "ClinicalDocument.component.structuredBody.component.typeCode",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "StructuredBody.component.typeCode"
},
"path": "ClinicalDocument.component.structuredBody.component.typeCode",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"fixedCode": "COMP",
"representation": [ "xmlAttr" ]
}, {
"id": "ClinicalDocument.component.structuredBody.component.contextConductionInd",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "StructuredBody.component.contextConductionInd"
},
"path": "ClinicalDocument.component.structuredBody.component.contextConductionInd",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"fixedBoolean": true,
"representation": [ "xmlAttr" ]
}, {
"id": "ClinicalDocument.component.structuredBody.component.section",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "StructuredBody.component.section"
},
"path": "ClinicalDocument.component.structuredBody.component.section",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Section"
} ]
}, {
"id": "ClinicalDocument.component.structuredBody.component:allergies",
"max": "1",
"min": 1,
"base": {
"max": "*",
"min": 1,
"path": "StructuredBody.component"
},
"path": "ClinicalDocument.component.structuredBody.component",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot"
} ],
"comment": "This structuredBody SHALL contain exactly one [1..1] component (CONF:1198-30571).",
"sliceName": "allergies"
}, {
"path": "ClinicalDocument.component.structuredBody.component.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.component.structuredBody.component:allergies.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "ClinicalDocument.component.structuredBody.component:allergies.realmCode",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.realmCode"
},
"path": "ClinicalDocument.component.structuredBody.component.realmCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question"
}, {
"id": "ClinicalDocument.component.structuredBody.component:allergies.typeId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "InfrastructureRoot.typeId"
},
"path": "ClinicalDocument.component.structuredBody.component.typeId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"constraint": [ {
"key": "II-1",
"human": "An II instance must have either a root or an nullFlavor.",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader",
"severity": "error",
"expression": "root.exists() or nullFlavor.exists()"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question."
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.component.structuredBody.component:allergies.typeId.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "ClinicalDocument.component.structuredBody.component:allergies.typeId.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "ClinicalDocument.component.structuredBody.component:allergies.typeId.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.root",
"min": 1,
"definition": "Identifies the type as an HL7 Registered model",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "2.16.840.1.113883.1.3",
"label": "Root",
"id": "ClinicalDocument.component.structuredBody.component:allergies.typeId.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "ClinicalDocument.component.structuredBody.component:allergies.typeId.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "ClinicalDocument.component.structuredBody.component:allergies.templateId",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
},
"path": "ClinicalDocument.component.structuredBody.component.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"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"
}, {
"id": "ClinicalDocument.component.structuredBody.component:allergies.typeCode",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "StructuredBody.component.typeCode"
},
"path": "ClinicalDocument.component.structuredBody.component.typeCode",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"fixedCode": "COMP",
"representation": [ "xmlAttr" ]
}, {
"id": "ClinicalDocument.component.structuredBody.component:allergies.contextConductionInd",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "StructuredBody.component.contextConductionInd"
},
"path": "ClinicalDocument.component.structuredBody.component.contextConductionInd",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"fixedBoolean": true,
"representation": [ "xmlAttr" ]
}, {
"id": "ClinicalDocument.component.structuredBody.component:allergies.section",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "StructuredBody.component.section"
},
"path": "ClinicalDocument.component.structuredBody.component.section",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Section",
"profile": [ "http://hl7.org/cda/us/ccda/StructureDefinition/AllergiesAndIntolerancesSection" ]
} ],
"comment": "SHALL contain exactly one [1..1] Allergies and Intolerances Section (identifier: urn:oid:2.16.840.1.113883.10.20.22.2.6.1:2024-05-01) (CONF:1198-30572)."
}, {
"id": "ClinicalDocument.component.structuredBody.component:assessment",
"max": "1",
"min": 0,
"base": {
"max": "*",
"min": 1,
"path": "StructuredBody.component"
},
"path": "ClinicalDocument.component.structuredBody.component",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot"
} ],
"comment": "This structuredBody MAY contain zero or one [0..1] component (CONF:1198-30573) such that it",
"sliceName": "assessment"
}, {
"path": "ClinicalDocument.component.structuredBody.component.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.component.structuredBody.component:assessment.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "ClinicalDocument.component.structuredBody.component:assessment.realmCode",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.realmCode"
},
"path": "ClinicalDocument.component.structuredBody.component.realmCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question"
}, {
"id": "ClinicalDocument.component.structuredBody.component:assessment.typeId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "InfrastructureRoot.typeId"
},
"path": "ClinicalDocument.component.structuredBody.component.typeId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"constraint": [ {
"key": "II-1",
"human": "An II instance must have either a root or an nullFlavor.",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader",
"severity": "error",
"expression": "root.exists() or nullFlavor.exists()"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question."
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.component.structuredBody.component:assessment.typeId.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "ClinicalDocument.component.structuredBody.component:assessment.typeId.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "ClinicalDocument.component.structuredBody.component:assessment.typeId.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.root",
"min": 1,
"definition": "Identifies the type as an HL7 Registered model",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "2.16.840.1.113883.1.3",
"label": "Root",
"id": "ClinicalDocument.component.structuredBody.component:assessment.typeId.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "ClinicalDocument.component.structuredBody.component:assessment.typeId.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "ClinicalDocument.component.structuredBody.component:assessment.templateId",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
},
"path": "ClinicalDocument.component.structuredBody.component.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"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"
}, {
"id": "ClinicalDocument.component.structuredBody.component:assessment.typeCode",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "StructuredBody.component.typeCode"
},
"path": "ClinicalDocument.component.structuredBody.component.typeCode",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"fixedCode": "COMP",
"representation": [ "xmlAttr" ]
}, {
"id": "ClinicalDocument.component.structuredBody.component:assessment.contextConductionInd",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "StructuredBody.component.contextConductionInd"
},
"path": "ClinicalDocument.component.structuredBody.component.contextConductionInd",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"fixedBoolean": true,
"representation": [ "xmlAttr" ]
}, {
"id": "ClinicalDocument.component.structuredBody.component:assessment.section",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "StructuredBody.component.section"
},
"path": "ClinicalDocument.component.structuredBody.component.section",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Section",
"profile": [ "http://hl7.org/cda/us/ccda/StructureDefinition/AssessmentSection" ]
} ],
"comment": "SHALL contain exactly one [1..1] Assessment Section (identifier: urn:oid:2.16.840.1.113883.10.20.22.2.8) (CONF:1198-30574)."
}, {
"id": "ClinicalDocument.component.structuredBody.component:planOfTreatment",
"max": "1",
"min": 0,
"base": {
"max": "*",
"min": 1,
"path": "StructuredBody.component"
},
"path": "ClinicalDocument.component.structuredBody.component",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot"
} ],
"comment": "This structuredBody MAY contain zero or one [0..1] component (CONF:1198-30575) such that it",
"sliceName": "planOfTreatment"
}, {
"path": "ClinicalDocument.component.structuredBody.component.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.component.structuredBody.component:planOfTreatment.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "ClinicalDocument.component.structuredBody.component:planOfTreatment.realmCode",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.realmCode"
},
"path": "ClinicalDocument.component.structuredBody.component.realmCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question"
}, {
"id": "ClinicalDocument.component.structuredBody.component:planOfTreatment.typeId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "InfrastructureRoot.typeId"
},
"path": "ClinicalDocument.component.structuredBody.component.typeId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"constraint": [ {
"key": "II-1",
"human": "An II instance must have either a root or an nullFlavor.",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader",
"severity": "error",
"expression": "root.exists() or nullFlavor.exists()"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question."
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.component.structuredBody.component:planOfTreatment.typeId.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "ClinicalDocument.component.structuredBody.component:planOfTreatment.typeId.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "ClinicalDocument.component.structuredBody.component:planOfTreatment.typeId.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.root",
"min": 1,
"definition": "Identifies the type as an HL7 Registered model",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "2.16.840.1.113883.1.3",
"label": "Root",
"id": "ClinicalDocument.component.structuredBody.component:planOfTreatment.typeId.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "ClinicalDocument.component.structuredBody.component:planOfTreatment.typeId.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "ClinicalDocument.component.structuredBody.component:planOfTreatment.templateId",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
},
"path": "ClinicalDocument.component.structuredBody.component.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"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"
}, {
"id": "ClinicalDocument.component.structuredBody.component:planOfTreatment.typeCode",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "StructuredBody.component.typeCode"
},
"path": "ClinicalDocument.component.structuredBody.component.typeCode",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"fixedCode": "COMP",
"representation": [ "xmlAttr" ]
}, {
"id": "ClinicalDocument.component.structuredBody.component:planOfTreatment.contextConductionInd",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "StructuredBody.component.contextConductionInd"
},
"path": "ClinicalDocument.component.structuredBody.component.contextConductionInd",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"fixedBoolean": true,
"representation": [ "xmlAttr" ]
}, {
"id": "ClinicalDocument.component.structuredBody.component:planOfTreatment.section",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "StructuredBody.component.section"
},
"path": "ClinicalDocument.component.structuredBody.component.section",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Section",
"profile": [ "http://hl7.org/cda/us/ccda/StructureDefinition/PlanofTreatmentSection" ]
} ],
"comment": "SHALL contain exactly one [1..1] Plan of Treatment Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.10:2014-06-09) (CONF:1198-30576)."
}, {
"id": "ClinicalDocument.component.structuredBody.component:assessmentAndPlan",
"max": "1",
"min": 0,
"base": {
"max": "*",
"min": 1,
"path": "StructuredBody.component"
},
"path": "ClinicalDocument.component.structuredBody.component",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot"
} ],
"comment": "This structuredBody MAY contain zero or one [0..1] component (CONF:1198-30577) such that it",
"sliceName": "assessmentAndPlan"
}, {
"path": "ClinicalDocument.component.structuredBody.component.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.component.structuredBody.component:assessmentAndPlan.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "ClinicalDocument.component.structuredBody.component:assessmentAndPlan.realmCode",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.realmCode"
},
"path": "ClinicalDocument.component.structuredBody.component.realmCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question"
}, {
"id": "ClinicalDocument.component.structuredBody.component:assessmentAndPlan.typeId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "InfrastructureRoot.typeId"
},
"path": "ClinicalDocument.component.structuredBody.component.typeId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"constraint": [ {
"key": "II-1",
"human": "An II instance must have either a root or an nullFlavor.",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader",
"severity": "error",
"expression": "root.exists() or nullFlavor.exists()"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question."
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.component.structuredBody.component:assessmentAndPlan.typeId.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "ClinicalDocument.component.structuredBody.component:assessmentAndPlan.typeId.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "ClinicalDocument.component.structuredBody.component:assessmentAndPlan.typeId.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.root",
"min": 1,
"definition": "Identifies the type as an HL7 Registered model",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "2.16.840.1.113883.1.3",
"label": "Root",
"id": "ClinicalDocument.component.structuredBody.component:assessmentAndPlan.typeId.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "ClinicalDocument.component.structuredBody.component:assessmentAndPlan.typeId.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "ClinicalDocument.component.structuredBody.component:assessmentAndPlan.templateId",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
},
"path": "ClinicalDocument.component.structuredBody.component.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"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"
}, {
"id": "ClinicalDocument.component.structuredBody.component:assessmentAndPlan.typeCode",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "StructuredBody.component.typeCode"
},
"path": "ClinicalDocument.component.structuredBody.component.typeCode",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"fixedCode": "COMP",
"representation": [ "xmlAttr" ]
}, {
"id": "ClinicalDocument.component.structuredBody.component:assessmentAndPlan.contextConductionInd",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "StructuredBody.component.contextConductionInd"
},
"path": "ClinicalDocument.component.structuredBody.component.contextConductionInd",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"fixedBoolean": true,
"representation": [ "xmlAttr" ]
}, {
"id": "ClinicalDocument.component.structuredBody.component:assessmentAndPlan.section",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "StructuredBody.component.section"
},
"path": "ClinicalDocument.component.structuredBody.component.section",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Section",
"profile": [ "http://hl7.org/cda/us/ccda/StructureDefinition/AssessmentandPlanSection" ]
} ],
"comment": "SHALL contain exactly one [1..1] Assessment and Plan Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.9:2014-06-09) (CONF:1198-30578)."
}, {
"id": "ClinicalDocument.component.structuredBody.component:chiefComplaint",
"max": "1",
"min": 0,
"base": {
"max": "*",
"min": 1,
"path": "StructuredBody.component"
},
"path": "ClinicalDocument.component.structuredBody.component",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot"
} ],
"comment": "This structuredBody MAY contain zero or one [0..1] component (CONF:1198-30579) such that it",
"sliceName": "chiefComplaint"
}, {
"path": "ClinicalDocument.component.structuredBody.component.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.component.structuredBody.component:chiefComplaint.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "ClinicalDocument.component.structuredBody.component:chiefComplaint.realmCode",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.realmCode"
},
"path": "ClinicalDocument.component.structuredBody.component.realmCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question"
}, {
"id": "ClinicalDocument.component.structuredBody.component:chiefComplaint.typeId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "InfrastructureRoot.typeId"
},
"path": "ClinicalDocument.component.structuredBody.component.typeId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"constraint": [ {
"key": "II-1",
"human": "An II instance must have either a root or an nullFlavor.",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader",
"severity": "error",
"expression": "root.exists() or nullFlavor.exists()"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question."
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.component.structuredBody.component:chiefComplaint.typeId.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "ClinicalDocument.component.structuredBody.component:chiefComplaint.typeId.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "ClinicalDocument.component.structuredBody.component:chiefComplaint.typeId.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.root",
"min": 1,
"definition": "Identifies the type as an HL7 Registered model",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "2.16.840.1.113883.1.3",
"label": "Root",
"id": "ClinicalDocument.component.structuredBody.component:chiefComplaint.typeId.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "ClinicalDocument.component.structuredBody.component:chiefComplaint.typeId.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "ClinicalDocument.component.structuredBody.component:chiefComplaint.templateId",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
},
"path": "ClinicalDocument.component.structuredBody.component.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"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"
}, {
"id": "ClinicalDocument.component.structuredBody.component:chiefComplaint.typeCode",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "StructuredBody.component.typeCode"
},
"path": "ClinicalDocument.component.structuredBody.component.typeCode",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"fixedCode": "COMP",
"representation": [ "xmlAttr" ]
}, {
"id": "ClinicalDocument.component.structuredBody.component:chiefComplaint.contextConductionInd",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "StructuredBody.component.contextConductionInd"
},
"path": "ClinicalDocument.component.structuredBody.component.contextConductionInd",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"fixedBoolean": true,
"representation": [ "xmlAttr" ]
}, {
"id": "ClinicalDocument.component.structuredBody.component:chiefComplaint.section",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "StructuredBody.component.section"
},
"path": "ClinicalDocument.component.structuredBody.component.section",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Section",
"profile": [ "http://hl7.org/cda/us/ccda/StructureDefinition/ChiefComplaintSection" ]
} ],
"comment": "SHALL contain exactly one [1..1] Chief Complaint Section (identifier: urn:oid:1.3.6.1.4.1.19376.1.5.3.1.1.13.2.1) (CONF:1198-30580)."
}, {
"id": "ClinicalDocument.component.structuredBody.component:chiefComplaintRFV",
"max": "1",
"min": 0,
"base": {
"max": "*",
"min": 1,
"path": "StructuredBody.component"
},
"path": "ClinicalDocument.component.structuredBody.component",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot"
} ],
"comment": "This structuredBody MAY contain zero or one [0..1] component (CONF:1198-30581) such that it",
"sliceName": "chiefComplaintRFV"
}, {
"path": "ClinicalDocument.component.structuredBody.component.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.component.structuredBody.component:chiefComplaintRFV.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "ClinicalDocument.component.structuredBody.component:chiefComplaintRFV.realmCode",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.realmCode"
},
"path": "ClinicalDocument.component.structuredBody.component.realmCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question"
}, {
"id": "ClinicalDocument.component.structuredBody.component:chiefComplaintRFV.typeId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "InfrastructureRoot.typeId"
},
"path": "ClinicalDocument.component.structuredBody.component.typeId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"constraint": [ {
"key": "II-1",
"human": "An II instance must have either a root or an nullFlavor.",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader",
"severity": "error",
"expression": "root.exists() or nullFlavor.exists()"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question."
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.component.structuredBody.component:chiefComplaintRFV.typeId.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "ClinicalDocument.component.structuredBody.component:chiefComplaintRFV.typeId.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "ClinicalDocument.component.structuredBody.component:chiefComplaintRFV.typeId.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.root",
"min": 1,
"definition": "Identifies the type as an HL7 Registered model",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "2.16.840.1.113883.1.3",
"label": "Root",
"id": "ClinicalDocument.component.structuredBody.component:chiefComplaintRFV.typeId.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "ClinicalDocument.component.structuredBody.component:chiefComplaintRFV.typeId.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "ClinicalDocument.component.structuredBody.component:chiefComplaintRFV.templateId",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
},
"path": "ClinicalDocument.component.structuredBody.component.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"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"
}, {
"id": "ClinicalDocument.component.structuredBody.component:chiefComplaintRFV.typeCode",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "StructuredBody.component.typeCode"
},
"path": "ClinicalDocument.component.structuredBody.component.typeCode",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"fixedCode": "COMP",
"representation": [ "xmlAttr" ]
}, {
"id": "ClinicalDocument.component.structuredBody.component:chiefComplaintRFV.contextConductionInd",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "StructuredBody.component.contextConductionInd"
},
"path": "ClinicalDocument.component.structuredBody.component.contextConductionInd",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"fixedBoolean": true,
"representation": [ "xmlAttr" ]
}, {
"id": "ClinicalDocument.component.structuredBody.component:chiefComplaintRFV.section",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "StructuredBody.component.section"
},
"path": "ClinicalDocument.component.structuredBody.component.section",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Section",
"profile": [ "http://hl7.org/cda/us/ccda/StructureDefinition/ChiefComplaintandReasonforVisitSection" ]
} ],
"comment": "SHALL contain exactly one [1..1] Chief Complaint and Reason for Visit Section (identifier: urn:oid:2.16.840.1.113883.10.20.22.2.13) (CONF:1198-30582)."
}, {
"id": "ClinicalDocument.component.structuredBody.component:familyHistory",
"max": "1",
"min": 1,
"base": {
"max": "*",
"min": 1,
"path": "StructuredBody.component"
},
"path": "ClinicalDocument.component.structuredBody.component",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot"
} ],
"comment": "This structuredBody SHALL contain exactly one [1..1] component (CONF:1198-30583) such that it",
"sliceName": "familyHistory"
}, {
"path": "ClinicalDocument.component.structuredBody.component.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.component.structuredBody.component:familyHistory.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "ClinicalDocument.component.structuredBody.component:familyHistory.realmCode",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.realmCode"
},
"path": "ClinicalDocument.component.structuredBody.component.realmCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question"
}, {
"id": "ClinicalDocument.component.structuredBody.component:familyHistory.typeId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "InfrastructureRoot.typeId"
},
"path": "ClinicalDocument.component.structuredBody.component.typeId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"constraint": [ {
"key": "II-1",
"human": "An II instance must have either a root or an nullFlavor.",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader",
"severity": "error",
"expression": "root.exists() or nullFlavor.exists()"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question."
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.component.structuredBody.component:familyHistory.typeId.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "ClinicalDocument.component.structuredBody.component:familyHistory.typeId.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "ClinicalDocument.component.structuredBody.component:familyHistory.typeId.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.root",
"min": 1,
"definition": "Identifies the type as an HL7 Registered model",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "2.16.840.1.113883.1.3",
"label": "Root",
"id": "ClinicalDocument.component.structuredBody.component:familyHistory.typeId.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "ClinicalDocument.component.structuredBody.component:familyHistory.typeId.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "ClinicalDocument.component.structuredBody.component:familyHistory.templateId",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
},
"path": "ClinicalDocument.component.structuredBody.component.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"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"
}, {
"id": "ClinicalDocument.component.structuredBody.component:familyHistory.typeCode",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "StructuredBody.component.typeCode"
},
"path": "ClinicalDocument.component.structuredBody.component.typeCode",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"fixedCode": "COMP",
"representation": [ "xmlAttr" ]
}, {
"id": "ClinicalDocument.component.structuredBody.component:familyHistory.contextConductionInd",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "StructuredBody.component.contextConductionInd"
},
"path": "ClinicalDocument.component.structuredBody.component.contextConductionInd",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"fixedBoolean": true,
"representation": [ "xmlAttr" ]
}, {
"id": "ClinicalDocument.component.structuredBody.component:familyHistory.section",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "StructuredBody.component.section"
},
"path": "ClinicalDocument.component.structuredBody.component.section",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Section",
"profile": [ "http://hl7.org/cda/us/ccda/StructureDefinition/FamilyHistorySection" ]
} ],
"comment": "SHALL contain exactly one [1..1] Family History Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.15:2024-05-01) (CONF:1198-30584)."
}, {
"id": "ClinicalDocument.component.structuredBody.component:generalStatus",
"max": "1",
"min": 1,
"base": {
"max": "*",
"min": 1,
"path": "StructuredBody.component"
},
"path": "ClinicalDocument.component.structuredBody.component",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot"
} ],
"comment": "This structuredBody SHALL contain exactly one [1..1] component (CONF:1198-30585) such that it",
"sliceName": "generalStatus"
}, {
"path": "ClinicalDocument.component.structuredBody.component.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.component.structuredBody.component:generalStatus.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "ClinicalDocument.component.structuredBody.component:generalStatus.realmCode",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.realmCode"
},
"path": "ClinicalDocument.component.structuredBody.component.realmCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question"
}, {
"id": "ClinicalDocument.component.structuredBody.component:generalStatus.typeId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "InfrastructureRoot.typeId"
},
"path": "ClinicalDocument.component.structuredBody.component.typeId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"constraint": [ {
"key": "II-1",
"human": "An II instance must have either a root or an nullFlavor.",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader",
"severity": "error",
"expression": "root.exists() or nullFlavor.exists()"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question."
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.component.structuredBody.component:generalStatus.typeId.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "ClinicalDocument.component.structuredBody.component:generalStatus.typeId.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "ClinicalDocument.component.structuredBody.component:generalStatus.typeId.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.root",
"min": 1,
"definition": "Identifies the type as an HL7 Registered model",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "2.16.840.1.113883.1.3",
"label": "Root",
"id": "ClinicalDocument.component.structuredBody.component:generalStatus.typeId.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "ClinicalDocument.component.structuredBody.component:generalStatus.typeId.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "ClinicalDocument.component.structuredBody.component:generalStatus.templateId",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
},
"path": "ClinicalDocument.component.structuredBody.component.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"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"
}, {
"id": "ClinicalDocument.component.structuredBody.component:generalStatus.typeCode",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "StructuredBody.component.typeCode"
},
"path": "ClinicalDocument.component.structuredBody.component.typeCode",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"fixedCode": "COMP",
"representation": [ "xmlAttr" ]
}, {
"id": "ClinicalDocument.component.structuredBody.component:generalStatus.contextConductionInd",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "StructuredBody.component.contextConductionInd"
},
"path": "ClinicalDocument.component.structuredBody.component.contextConductionInd",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"fixedBoolean": true,
"representation": [ "xmlAttr" ]
}, {
"id": "ClinicalDocument.component.structuredBody.component:generalStatus.section",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "StructuredBody.component.section"
},
"path": "ClinicalDocument.component.structuredBody.component.section",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Section",
"profile": [ "http://hl7.org/cda/us/ccda/StructureDefinition/GeneralStatusSection" ]
} ],
"comment": "SHALL contain exactly one [1..1] General Status Section (identifier: urn:oid:2.16.840.1.113883.10.20.2.5) (CONF:1198-30586)."
}, {
"id": "ClinicalDocument.component.structuredBody.component:pastMedicalHistory",
"max": "1",
"min": 1,
"base": {
"max": "*",
"min": 1,
"path": "StructuredBody.component"
},
"path": "ClinicalDocument.component.structuredBody.component",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot"
} ],
"comment": "This structuredBody SHALL contain exactly one [1..1] component (CONF:1198-30587) such that it",
"sliceName": "pastMedicalHistory"
}, {
"path": "ClinicalDocument.component.structuredBody.component.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.component.structuredBody.component:pastMedicalHistory.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "ClinicalDocument.component.structuredBody.component:pastMedicalHistory.realmCode",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.realmCode"
},
"path": "ClinicalDocument.component.structuredBody.component.realmCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question"
}, {
"id": "ClinicalDocument.component.structuredBody.component:pastMedicalHistory.typeId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "InfrastructureRoot.typeId"
},
"path": "ClinicalDocument.component.structuredBody.component.typeId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"constraint": [ {
"key": "II-1",
"human": "An II instance must have either a root or an nullFlavor.",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader",
"severity": "error",
"expression": "root.exists() or nullFlavor.exists()"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question."
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.component.structuredBody.component:pastMedicalHistory.typeId.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "ClinicalDocument.component.structuredBody.component:pastMedicalHistory.typeId.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "ClinicalDocument.component.structuredBody.component:pastMedicalHistory.typeId.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.root",
"min": 1,
"definition": "Identifies the type as an HL7 Registered model",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "2.16.840.1.113883.1.3",
"label": "Root",
"id": "ClinicalDocument.component.structuredBody.component:pastMedicalHistory.typeId.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "ClinicalDocument.component.structuredBody.component:pastMedicalHistory.typeId.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "ClinicalDocument.component.structuredBody.component:pastMedicalHistory.templateId",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
},
"path": "ClinicalDocument.component.structuredBody.component.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"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"
}, {
"id": "ClinicalDocument.component.structuredBody.component:pastMedicalHistory.typeCode",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "StructuredBody.component.typeCode"
},
"path": "ClinicalDocument.component.structuredBody.component.typeCode",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"fixedCode": "COMP",
"representation": [ "xmlAttr" ]
}, {
"id": "ClinicalDocument.component.structuredBody.component:pastMedicalHistory.contextConductionInd",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "StructuredBody.component.contextConductionInd"
},
"path": "ClinicalDocument.component.structuredBody.component.contextConductionInd",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"fixedBoolean": true,
"representation": [ "xmlAttr" ]
}, {
"id": "ClinicalDocument.component.structuredBody.component:pastMedicalHistory.section",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "StructuredBody.component.section"
},
"path": "ClinicalDocument.component.structuredBody.component.section",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Section",
"profile": [ "http://hl7.org/cda/us/ccda/StructureDefinition/PastMedicalHistory" ]
} ],
"comment": "SHALL contain exactly one [1..1] Past Medical History (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.20:2024-05-01) (CONF:1198-30588)."
}, {
"id": "ClinicalDocument.component.structuredBody.component:historyPresentIllness",
"max": "1",
"min": 0,
"base": {
"max": "*",
"min": 1,
"path": "StructuredBody.component"
},
"path": "ClinicalDocument.component.structuredBody.component",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot"
} ],
"comment": "This structuredBody SHOULD contain zero or one [0..1] component (CONF:1198-30589) such that it",
"sliceName": "historyPresentIllness"
}, {
"path": "ClinicalDocument.component.structuredBody.component.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.component.structuredBody.component:historyPresentIllness.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "ClinicalDocument.component.structuredBody.component:historyPresentIllness.realmCode",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.realmCode"
},
"path": "ClinicalDocument.component.structuredBody.component.realmCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question"
}, {
"id": "ClinicalDocument.component.structuredBody.component:historyPresentIllness.typeId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "InfrastructureRoot.typeId"
},
"path": "ClinicalDocument.component.structuredBody.component.typeId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"constraint": [ {
"key": "II-1",
"human": "An II instance must have either a root or an nullFlavor.",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader",
"severity": "error",
"expression": "root.exists() or nullFlavor.exists()"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question."
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.component.structuredBody.component:historyPresentIllness.typeId.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "ClinicalDocument.component.structuredBody.component:historyPresentIllness.typeId.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "ClinicalDocument.component.structuredBody.component:historyPresentIllness.typeId.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.root",
"min": 1,
"definition": "Identifies the type as an HL7 Registered model",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "2.16.840.1.113883.1.3",
"label": "Root",
"id": "ClinicalDocument.component.structuredBody.component:historyPresentIllness.typeId.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "ClinicalDocument.component.structuredBody.component:historyPresentIllness.typeId.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "ClinicalDocument.component.structuredBody.component:historyPresentIllness.templateId",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
},
"path": "ClinicalDocument.component.structuredBody.component.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"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"
}, {
"id": "ClinicalDocument.component.structuredBody.component:historyPresentIllness.typeCode",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "StructuredBody.component.typeCode"
},
"path": "ClinicalDocument.component.structuredBody.component.typeCode",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"fixedCode": "COMP",
"representation": [ "xmlAttr" ]
}, {
"id": "ClinicalDocument.component.structuredBody.component:historyPresentIllness.contextConductionInd",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "StructuredBody.component.contextConductionInd"
},
"path": "ClinicalDocument.component.structuredBody.component.contextConductionInd",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"fixedBoolean": true,
"representation": [ "xmlAttr" ]
}, {
"id": "ClinicalDocument.component.structuredBody.component:historyPresentIllness.section",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "StructuredBody.component.section"
},
"path": "ClinicalDocument.component.structuredBody.component.section",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Section",
"profile": [ "http://hl7.org/cda/us/ccda/StructureDefinition/HistoryofPresentIllnessSection" ]
} ],
"comment": "SHALL contain exactly one [1..1] History of Present Illness Section (identifier: urn:oid:1.3.6.1.4.1.19376.1.5.3.1.3.4) (CONF:1198-30590)."
}, {
"id": "ClinicalDocument.component.structuredBody.component:immunizations",
"max": "1",
"min": 0,
"base": {
"max": "*",
"min": 1,
"path": "StructuredBody.component"
},
"path": "ClinicalDocument.component.structuredBody.component",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot"
} ],
"comment": "This structuredBody MAY contain zero or one [0..1] component (CONF:1198-30591) such that it",
"sliceName": "immunizations"
}, {
"path": "ClinicalDocument.component.structuredBody.component.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.component.structuredBody.component:immunizations.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "ClinicalDocument.component.structuredBody.component:immunizations.realmCode",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.realmCode"
},
"path": "ClinicalDocument.component.structuredBody.component.realmCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question"
}, {
"id": "ClinicalDocument.component.structuredBody.component:immunizations.typeId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "InfrastructureRoot.typeId"
},
"path": "ClinicalDocument.component.structuredBody.component.typeId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"constraint": [ {
"key": "II-1",
"human": "An II instance must have either a root or an nullFlavor.",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader",
"severity": "error",
"expression": "root.exists() or nullFlavor.exists()"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question."
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.component.structuredBody.component:immunizations.typeId.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "ClinicalDocument.component.structuredBody.component:immunizations.typeId.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "ClinicalDocument.component.structuredBody.component:immunizations.typeId.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.root",
"min": 1,
"definition": "Identifies the type as an HL7 Registered model",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "2.16.840.1.113883.1.3",
"label": "Root",
"id": "ClinicalDocument.component.structuredBody.component:immunizations.typeId.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "ClinicalDocument.component.structuredBody.component:immunizations.typeId.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "ClinicalDocument.component.structuredBody.component:immunizations.templateId",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
},
"path": "ClinicalDocument.component.structuredBody.component.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"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"
}, {
"id": "ClinicalDocument.component.structuredBody.component:immunizations.typeCode",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "StructuredBody.component.typeCode"
},
"path": "ClinicalDocument.component.structuredBody.component.typeCode",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"fixedCode": "COMP",
"representation": [ "xmlAttr" ]
}, {
"id": "ClinicalDocument.component.structuredBody.component:immunizations.contextConductionInd",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "StructuredBody.component.contextConductionInd"
},
"path": "ClinicalDocument.component.structuredBody.component.contextConductionInd",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"fixedBoolean": true,
"representation": [ "xmlAttr" ]
}, {
"id": "ClinicalDocument.component.structuredBody.component:immunizations.section",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "StructuredBody.component.section"
},
"path": "ClinicalDocument.component.structuredBody.component.section",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Section",
"profile": [ "http://hl7.org/cda/us/ccda/StructureDefinition/ImmunizationsSection" ]
} ],
"comment": "SHALL contain exactly one [1..1] Immunizations Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.2.1:2024-05-01) (CONF:1198-30592)."
}, {
"id": "ClinicalDocument.component.structuredBody.component:instructions",
"max": "1",
"min": 0,
"base": {
"max": "*",
"min": 1,
"path": "StructuredBody.component"
},
"path": "ClinicalDocument.component.structuredBody.component",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot"
} ],
"comment": "This structuredBody MAY contain zero or one [0..1] component (CONF:1198-30593) such that it",
"sliceName": "instructions"
}, {
"path": "ClinicalDocument.component.structuredBody.component.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.component.structuredBody.component:instructions.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "ClinicalDocument.component.structuredBody.component:instructions.realmCode",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.realmCode"
},
"path": "ClinicalDocument.component.structuredBody.component.realmCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question"
}, {
"id": "ClinicalDocument.component.structuredBody.component:instructions.typeId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "InfrastructureRoot.typeId"
},
"path": "ClinicalDocument.component.structuredBody.component.typeId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"constraint": [ {
"key": "II-1",
"human": "An II instance must have either a root or an nullFlavor.",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader",
"severity": "error",
"expression": "root.exists() or nullFlavor.exists()"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question."
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.component.structuredBody.component:instructions.typeId.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "ClinicalDocument.component.structuredBody.component:instructions.typeId.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "ClinicalDocument.component.structuredBody.component:instructions.typeId.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.root",
"min": 1,
"definition": "Identifies the type as an HL7 Registered model",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "2.16.840.1.113883.1.3",
"label": "Root",
"id": "ClinicalDocument.component.structuredBody.component:instructions.typeId.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "ClinicalDocument.component.structuredBody.component:instructions.typeId.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "ClinicalDocument.component.structuredBody.component:instructions.templateId",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
},
"path": "ClinicalDocument.component.structuredBody.component.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"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"
}, {
"id": "ClinicalDocument.component.structuredBody.component:instructions.typeCode",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "StructuredBody.component.typeCode"
},
"path": "ClinicalDocument.component.structuredBody.component.typeCode",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"fixedCode": "COMP",
"representation": [ "xmlAttr" ]
}, {
"id": "ClinicalDocument.component.structuredBody.component:instructions.contextConductionInd",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "StructuredBody.component.contextConductionInd"
},
"path": "ClinicalDocument.component.structuredBody.component.contextConductionInd",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"fixedBoolean": true,
"representation": [ "xmlAttr" ]
}, {
"id": "ClinicalDocument.component.structuredBody.component:instructions.section",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "StructuredBody.component.section"
},
"path": "ClinicalDocument.component.structuredBody.component.section",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Section",
"profile": [ "http://hl7.org/cda/us/ccda/StructureDefinition/InstructionsSection" ]
} ],
"comment": "SHALL contain exactly one [1..1] Instructions Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.45:2014-06-09) (CONF:1198-31385)."
}, {
"id": "ClinicalDocument.component.structuredBody.component:medications",
"max": "1",
"min": 1,
"base": {
"max": "*",
"min": 1,
"path": "StructuredBody.component"
},
"path": "ClinicalDocument.component.structuredBody.component",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot"
} ],
"comment": "This structuredBody SHALL contain exactly one [1..1] component (CONF:1198-30595) such that it",
"sliceName": "medications"
}, {
"path": "ClinicalDocument.component.structuredBody.component.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.component.structuredBody.component:medications.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "ClinicalDocument.component.structuredBody.component:medications.realmCode",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.realmCode"
},
"path": "ClinicalDocument.component.structuredBody.component.realmCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question"
}, {
"id": "ClinicalDocument.component.structuredBody.component:medications.typeId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "InfrastructureRoot.typeId"
},
"path": "ClinicalDocument.component.structuredBody.component.typeId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"constraint": [ {
"key": "II-1",
"human": "An II instance must have either a root or an nullFlavor.",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader",
"severity": "error",
"expression": "root.exists() or nullFlavor.exists()"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question."
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.component.structuredBody.component:medications.typeId.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "ClinicalDocument.component.structuredBody.component:medications.typeId.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "ClinicalDocument.component.structuredBody.component:medications.typeId.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.root",
"min": 1,
"definition": "Identifies the type as an HL7 Registered model",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "2.16.840.1.113883.1.3",
"label": "Root",
"id": "ClinicalDocument.component.structuredBody.component:medications.typeId.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "ClinicalDocument.component.structuredBody.component:medications.typeId.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "ClinicalDocument.component.structuredBody.component:medications.templateId",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
},
"path": "ClinicalDocument.component.structuredBody.component.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"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"
}, {
"id": "ClinicalDocument.component.structuredBody.component:medications.typeCode",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "StructuredBody.component.typeCode"
},
"path": "ClinicalDocument.component.structuredBody.component.typeCode",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"fixedCode": "COMP",
"representation": [ "xmlAttr" ]
}, {
"id": "ClinicalDocument.component.structuredBody.component:medications.contextConductionInd",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "StructuredBody.component.contextConductionInd"
},
"path": "ClinicalDocument.component.structuredBody.component.contextConductionInd",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"fixedBoolean": true,
"representation": [ "xmlAttr" ]
}, {
"id": "ClinicalDocument.component.structuredBody.component:medications.section",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "StructuredBody.component.section"
},
"path": "ClinicalDocument.component.structuredBody.component.section",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Section",
"profile": [ "http://hl7.org/cda/us/ccda/StructureDefinition/MedicationsSection" ]
} ],
"comment": "SHALL contain exactly one [1..1] Medications Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.1.1:2014-06-09) (CONF:1198-30596)."
}, {
"id": "ClinicalDocument.component.structuredBody.component:physicalExam",
"max": "1",
"min": 1,
"base": {
"max": "*",
"min": 1,
"path": "StructuredBody.component"
},
"path": "ClinicalDocument.component.structuredBody.component",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot"
} ],
"comment": "This structuredBody SHALL contain exactly one [1..1] component (CONF:1198-30597) such that it",
"sliceName": "physicalExam"
}, {
"path": "ClinicalDocument.component.structuredBody.component.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.component.structuredBody.component:physicalExam.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "ClinicalDocument.component.structuredBody.component:physicalExam.realmCode",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.realmCode"
},
"path": "ClinicalDocument.component.structuredBody.component.realmCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question"
}, {
"id": "ClinicalDocument.component.structuredBody.component:physicalExam.typeId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "InfrastructureRoot.typeId"
},
"path": "ClinicalDocument.component.structuredBody.component.typeId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"constraint": [ {
"key": "II-1",
"human": "An II instance must have either a root or an nullFlavor.",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader",
"severity": "error",
"expression": "root.exists() or nullFlavor.exists()"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question."
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.component.structuredBody.component:physicalExam.typeId.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "ClinicalDocument.component.structuredBody.component:physicalExam.typeId.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "ClinicalDocument.component.structuredBody.component:physicalExam.typeId.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.root",
"min": 1,
"definition": "Identifies the type as an HL7 Registered model",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "2.16.840.1.113883.1.3",
"label": "Root",
"id": "ClinicalDocument.component.structuredBody.component:physicalExam.typeId.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "ClinicalDocument.component.structuredBody.component:physicalExam.typeId.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "ClinicalDocument.component.structuredBody.component:physicalExam.templateId",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
},
"path": "ClinicalDocument.component.structuredBody.component.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"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"
}, {
"id": "ClinicalDocument.component.structuredBody.component:physicalExam.typeCode",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "StructuredBody.component.typeCode"
},
"path": "ClinicalDocument.component.structuredBody.component.typeCode",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"fixedCode": "COMP",
"representation": [ "xmlAttr" ]
}, {
"id": "ClinicalDocument.component.structuredBody.component:physicalExam.contextConductionInd",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "StructuredBody.component.contextConductionInd"
},
"path": "ClinicalDocument.component.structuredBody.component.contextConductionInd",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"fixedBoolean": true,
"representation": [ "xmlAttr" ]
}, {
"id": "ClinicalDocument.component.structuredBody.component:physicalExam.section",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "StructuredBody.component.section"
},
"path": "ClinicalDocument.component.structuredBody.component.section",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Section",
"profile": [ "http://hl7.org/cda/us/ccda/StructureDefinition/PhysicalExamSection" ]
} ],
"comment": "SHALL contain exactly one [1..1] Physical Exam Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.2.10:2024-05-01) (CONF:1198-30598)."
}, {
"id": "ClinicalDocument.component.structuredBody.component:problems",
"max": "1",
"min": 0,
"base": {
"max": "*",
"min": 1,
"path": "StructuredBody.component"
},
"path": "ClinicalDocument.component.structuredBody.component",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot"
} ],
"comment": "This structuredBody MAY contain zero or one [0..1] component (CONF:1198-30599) such that it",
"sliceName": "problems"
}, {
"path": "ClinicalDocument.component.structuredBody.component.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.component.structuredBody.component:problems.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "ClinicalDocument.component.structuredBody.component:problems.realmCode",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.realmCode"
},
"path": "ClinicalDocument.component.structuredBody.component.realmCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question"
}, {
"id": "ClinicalDocument.component.structuredBody.component:problems.typeId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "InfrastructureRoot.typeId"
},
"path": "ClinicalDocument.component.structuredBody.component.typeId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"constraint": [ {
"key": "II-1",
"human": "An II instance must have either a root or an nullFlavor.",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader",
"severity": "error",
"expression": "root.exists() or nullFlavor.exists()"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question."
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.component.structuredBody.component:problems.typeId.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "ClinicalDocument.component.structuredBody.component:problems.typeId.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "ClinicalDocument.component.structuredBody.component:problems.typeId.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.root",
"min": 1,
"definition": "Identifies the type as an HL7 Registered model",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "2.16.840.1.113883.1.3",
"label": "Root",
"id": "ClinicalDocument.component.structuredBody.component:problems.typeId.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "ClinicalDocument.component.structuredBody.component:problems.typeId.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "ClinicalDocument.component.structuredBody.component:problems.templateId",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
},
"path": "ClinicalDocument.component.structuredBody.component.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"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"
}, {
"id": "ClinicalDocument.component.structuredBody.component:problems.typeCode",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "StructuredBody.component.typeCode"
},
"path": "ClinicalDocument.component.structuredBody.component.typeCode",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"fixedCode": "COMP",
"representation": [ "xmlAttr" ]
}, {
"id": "ClinicalDocument.component.structuredBody.component:problems.contextConductionInd",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "StructuredBody.component.contextConductionInd"
},
"path": "ClinicalDocument.component.structuredBody.component.contextConductionInd",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"fixedBoolean": true,
"representation": [ "xmlAttr" ]
}, {
"id": "ClinicalDocument.component.structuredBody.component:problems.section",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "StructuredBody.component.section"
},
"path": "ClinicalDocument.component.structuredBody.component.section",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Section",
"profile": [ "http://hl7.org/cda/us/ccda/StructureDefinition/ProblemSection" ]
} ],
"comment": "SHALL contain exactly one [1..1] Problem Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.5.1:2024-05-01) (CONF:1198-30600)."
}, {
"id": "ClinicalDocument.component.structuredBody.component:procedures",
"max": "1",
"min": 0,
"base": {
"max": "*",
"min": 1,
"path": "StructuredBody.component"
},
"path": "ClinicalDocument.component.structuredBody.component",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot"
} ],
"comment": "This structuredBody MAY contain zero or one [0..1] component (CONF:1198-30601) such that it",
"sliceName": "procedures"
}, {
"path": "ClinicalDocument.component.structuredBody.component.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.component.structuredBody.component:procedures.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "ClinicalDocument.component.structuredBody.component:procedures.realmCode",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.realmCode"
},
"path": "ClinicalDocument.component.structuredBody.component.realmCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question"
}, {
"id": "ClinicalDocument.component.structuredBody.component:procedures.typeId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "InfrastructureRoot.typeId"
},
"path": "ClinicalDocument.component.structuredBody.component.typeId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"constraint": [ {
"key": "II-1",
"human": "An II instance must have either a root or an nullFlavor.",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader",
"severity": "error",
"expression": "root.exists() or nullFlavor.exists()"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question."
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.component.structuredBody.component:procedures.typeId.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "ClinicalDocument.component.structuredBody.component:procedures.typeId.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "ClinicalDocument.component.structuredBody.component:procedures.typeId.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.root",
"min": 1,
"definition": "Identifies the type as an HL7 Registered model",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "2.16.840.1.113883.1.3",
"label": "Root",
"id": "ClinicalDocument.component.structuredBody.component:procedures.typeId.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "ClinicalDocument.component.structuredBody.component:procedures.typeId.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "ClinicalDocument.component.structuredBody.component:procedures.templateId",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
},
"path": "ClinicalDocument.component.structuredBody.component.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"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"
}, {
"id": "ClinicalDocument.component.structuredBody.component:procedures.typeCode",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "StructuredBody.component.typeCode"
},
"path": "ClinicalDocument.component.structuredBody.component.typeCode",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"fixedCode": "COMP",
"representation": [ "xmlAttr" ]
}, {
"id": "ClinicalDocument.component.structuredBody.component:procedures.contextConductionInd",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "StructuredBody.component.contextConductionInd"
},
"path": "ClinicalDocument.component.structuredBody.component.contextConductionInd",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"fixedBoolean": true,
"representation": [ "xmlAttr" ]
}, {
"id": "ClinicalDocument.component.structuredBody.component:procedures.section",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "StructuredBody.component.section"
},
"path": "ClinicalDocument.component.structuredBody.component.section",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Section",
"profile": [ "http://hl7.org/cda/us/ccda/StructureDefinition/ProceduresSection" ]
} ],
"comment": "SHALL contain exactly one [1..1] Procedures Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.7.1:2014-06-09) (CONF:1198-30602)."
}, {
"id": "ClinicalDocument.component.structuredBody.component:reasonForVisit",
"max": "1",
"min": 0,
"base": {
"max": "*",
"min": 1,
"path": "StructuredBody.component"
},
"path": "ClinicalDocument.component.structuredBody.component",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot"
} ],
"comment": "This structuredBody MAY contain zero or one [0..1] component (CONF:1198-30603) such that it",
"sliceName": "reasonForVisit"
}, {
"path": "ClinicalDocument.component.structuredBody.component.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.component.structuredBody.component:reasonForVisit.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "ClinicalDocument.component.structuredBody.component:reasonForVisit.realmCode",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.realmCode"
},
"path": "ClinicalDocument.component.structuredBody.component.realmCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question"
}, {
"id": "ClinicalDocument.component.structuredBody.component:reasonForVisit.typeId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "InfrastructureRoot.typeId"
},
"path": "ClinicalDocument.component.structuredBody.component.typeId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"constraint": [ {
"key": "II-1",
"human": "An II instance must have either a root or an nullFlavor.",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader",
"severity": "error",
"expression": "root.exists() or nullFlavor.exists()"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question."
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.component.structuredBody.component:reasonForVisit.typeId.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "ClinicalDocument.component.structuredBody.component:reasonForVisit.typeId.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "ClinicalDocument.component.structuredBody.component:reasonForVisit.typeId.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.root",
"min": 1,
"definition": "Identifies the type as an HL7 Registered model",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "2.16.840.1.113883.1.3",
"label": "Root",
"id": "ClinicalDocument.component.structuredBody.component:reasonForVisit.typeId.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "ClinicalDocument.component.structuredBody.component:reasonForVisit.typeId.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "ClinicalDocument.component.structuredBody.component:reasonForVisit.templateId",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
},
"path": "ClinicalDocument.component.structuredBody.component.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"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"
}, {
"id": "ClinicalDocument.component.structuredBody.component:reasonForVisit.typeCode",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "StructuredBody.component.typeCode"
},
"path": "ClinicalDocument.component.structuredBody.component.typeCode",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"fixedCode": "COMP",
"representation": [ "xmlAttr" ]
}, {
"id": "ClinicalDocument.component.structuredBody.component:reasonForVisit.contextConductionInd",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "StructuredBody.component.contextConductionInd"
},
"path": "ClinicalDocument.component.structuredBody.component.contextConductionInd",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"fixedBoolean": true,
"representation": [ "xmlAttr" ]
}, {
"id": "ClinicalDocument.component.structuredBody.component:reasonForVisit.section",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "StructuredBody.component.section"
},
"path": "ClinicalDocument.component.structuredBody.component.section",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Section",
"profile": [ "http://hl7.org/cda/us/ccda/StructureDefinition/ReasonforVisitSection" ]
} ],
"comment": "SHALL contain exactly one [1..1] Reason for Visit Section (identifier: urn:oid:2.16.840.1.113883.10.20.22.2.12) (CONF:1198-30604)."
}, {
"id": "ClinicalDocument.component.structuredBody.component:results",
"max": "1",
"min": 1,
"base": {
"max": "*",
"min": 1,
"path": "StructuredBody.component"
},
"path": "ClinicalDocument.component.structuredBody.component",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot"
} ],
"comment": "This structuredBody SHALL contain exactly one [1..1] component (CONF:1198-30605) such that it",
"sliceName": "results"
}, {
"path": "ClinicalDocument.component.structuredBody.component.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.component.structuredBody.component:results.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "ClinicalDocument.component.structuredBody.component:results.realmCode",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.realmCode"
},
"path": "ClinicalDocument.component.structuredBody.component.realmCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question"
}, {
"id": "ClinicalDocument.component.structuredBody.component:results.typeId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "InfrastructureRoot.typeId"
},
"path": "ClinicalDocument.component.structuredBody.component.typeId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"constraint": [ {
"key": "II-1",
"human": "An II instance must have either a root or an nullFlavor.",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader",
"severity": "error",
"expression": "root.exists() or nullFlavor.exists()"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question."
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.component.structuredBody.component:results.typeId.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "ClinicalDocument.component.structuredBody.component:results.typeId.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "ClinicalDocument.component.structuredBody.component:results.typeId.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.root",
"min": 1,
"definition": "Identifies the type as an HL7 Registered model",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "2.16.840.1.113883.1.3",
"label": "Root",
"id": "ClinicalDocument.component.structuredBody.component:results.typeId.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "ClinicalDocument.component.structuredBody.component:results.typeId.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "ClinicalDocument.component.structuredBody.component:results.templateId",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
},
"path": "ClinicalDocument.component.structuredBody.component.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"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"
}, {
"id": "ClinicalDocument.component.structuredBody.component:results.typeCode",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "StructuredBody.component.typeCode"
},
"path": "ClinicalDocument.component.structuredBody.component.typeCode",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"fixedCode": "COMP",
"representation": [ "xmlAttr" ]
}, {
"id": "ClinicalDocument.component.structuredBody.component:results.contextConductionInd",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "StructuredBody.component.contextConductionInd"
},
"path": "ClinicalDocument.component.structuredBody.component.contextConductionInd",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"fixedBoolean": true,
"representation": [ "xmlAttr" ]
}, {
"id": "ClinicalDocument.component.structuredBody.component:results.section",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "StructuredBody.component.section"
},
"path": "ClinicalDocument.component.structuredBody.component.section",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Section",
"profile": [ "http://hl7.org/cda/us/ccda/StructureDefinition/ResultsSection" ]
} ],
"comment": "SHALL contain exactly one [1..1] Results Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.3.1:2024-05-01) (CONF:1198-30606)."
}, {
"id": "ClinicalDocument.component.structuredBody.component:reviewOfSystems",
"max": "1",
"min": 1,
"base": {
"max": "*",
"min": 1,
"path": "StructuredBody.component"
},
"path": "ClinicalDocument.component.structuredBody.component",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot"
} ],
"comment": "This structuredBody SHALL contain exactly one [1..1] component (CONF:1198-30607) such that it",
"sliceName": "reviewOfSystems"
}, {
"path": "ClinicalDocument.component.structuredBody.component.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.component.structuredBody.component:reviewOfSystems.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "ClinicalDocument.component.structuredBody.component:reviewOfSystems.realmCode",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.realmCode"
},
"path": "ClinicalDocument.component.structuredBody.component.realmCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question"
}, {
"id": "ClinicalDocument.component.structuredBody.component:reviewOfSystems.typeId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "InfrastructureRoot.typeId"
},
"path": "ClinicalDocument.component.structuredBody.component.typeId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"constraint": [ {
"key": "II-1",
"human": "An II instance must have either a root or an nullFlavor.",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader",
"severity": "error",
"expression": "root.exists() or nullFlavor.exists()"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question."
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.component.structuredBody.component:reviewOfSystems.typeId.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "ClinicalDocument.component.structuredBody.component:reviewOfSystems.typeId.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "ClinicalDocument.component.structuredBody.component:reviewOfSystems.typeId.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.root",
"min": 1,
"definition": "Identifies the type as an HL7 Registered model",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "2.16.840.1.113883.1.3",
"label": "Root",
"id": "ClinicalDocument.component.structuredBody.component:reviewOfSystems.typeId.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "ClinicalDocument.component.structuredBody.component:reviewOfSystems.typeId.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "ClinicalDocument.component.structuredBody.component:reviewOfSystems.templateId",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
},
"path": "ClinicalDocument.component.structuredBody.component.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"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"
}, {
"id": "ClinicalDocument.component.structuredBody.component:reviewOfSystems.typeCode",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "StructuredBody.component.typeCode"
},
"path": "ClinicalDocument.component.structuredBody.component.typeCode",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"fixedCode": "COMP",
"representation": [ "xmlAttr" ]
}, {
"id": "ClinicalDocument.component.structuredBody.component:reviewOfSystems.contextConductionInd",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "StructuredBody.component.contextConductionInd"
},
"path": "ClinicalDocument.component.structuredBody.component.contextConductionInd",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"fixedBoolean": true,
"representation": [ "xmlAttr" ]
}, {
"id": "ClinicalDocument.component.structuredBody.component:reviewOfSystems.section",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "StructuredBody.component.section"
},
"path": "ClinicalDocument.component.structuredBody.component.section",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Section",
"profile": [ "http://hl7.org/cda/us/ccda/StructureDefinition/ReviewofSystemsSection" ]
} ],
"comment": "SHALL contain exactly one [1..1] Review of Systems Section (identifier: urn:oid:1.3.6.1.4.1.19376.1.5.3.1.3.18) (CONF:1198-30608)."
}, {
"id": "ClinicalDocument.component.structuredBody.component:socialHistory",
"max": "1",
"min": 1,
"base": {
"max": "*",
"min": 1,
"path": "StructuredBody.component"
},
"path": "ClinicalDocument.component.structuredBody.component",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot"
} ],
"comment": "This structuredBody SHALL contain exactly one [1..1] component (CONF:1198-30609) such that it",
"sliceName": "socialHistory"
}, {
"path": "ClinicalDocument.component.structuredBody.component.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.component.structuredBody.component:socialHistory.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "ClinicalDocument.component.structuredBody.component:socialHistory.realmCode",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.realmCode"
},
"path": "ClinicalDocument.component.structuredBody.component.realmCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question"
}, {
"id": "ClinicalDocument.component.structuredBody.component:socialHistory.typeId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "InfrastructureRoot.typeId"
},
"path": "ClinicalDocument.component.structuredBody.component.typeId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"constraint": [ {
"key": "II-1",
"human": "An II instance must have either a root or an nullFlavor.",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader",
"severity": "error",
"expression": "root.exists() or nullFlavor.exists()"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question."
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.component.structuredBody.component:socialHistory.typeId.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "ClinicalDocument.component.structuredBody.component:socialHistory.typeId.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "ClinicalDocument.component.structuredBody.component:socialHistory.typeId.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.root",
"min": 1,
"definition": "Identifies the type as an HL7 Registered model",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "2.16.840.1.113883.1.3",
"label": "Root",
"id": "ClinicalDocument.component.structuredBody.component:socialHistory.typeId.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "ClinicalDocument.component.structuredBody.component:socialHistory.typeId.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "ClinicalDocument.component.structuredBody.component:socialHistory.templateId",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
},
"path": "ClinicalDocument.component.structuredBody.component.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"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"
}, {
"id": "ClinicalDocument.component.structuredBody.component:socialHistory.typeCode",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "StructuredBody.component.typeCode"
},
"path": "ClinicalDocument.component.structuredBody.component.typeCode",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"fixedCode": "COMP",
"representation": [ "xmlAttr" ]
}, {
"id": "ClinicalDocument.component.structuredBody.component:socialHistory.contextConductionInd",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "StructuredBody.component.contextConductionInd"
},
"path": "ClinicalDocument.component.structuredBody.component.contextConductionInd",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"fixedBoolean": true,
"representation": [ "xmlAttr" ]
}, {
"id": "ClinicalDocument.component.structuredBody.component:socialHistory.section",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "StructuredBody.component.section"
},
"path": "ClinicalDocument.component.structuredBody.component.section",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Section",
"profile": [ "http://hl7.org/cda/us/ccda/StructureDefinition/SocialHistorySection" ]
} ],
"comment": "SHALL contain exactly one [1..1] Social History Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.17:2024-05-01) (CONF:1198-30610)."
}, {
"id": "ClinicalDocument.component.structuredBody.component:vitalSigns",
"max": "1",
"min": 1,
"base": {
"max": "*",
"min": 1,
"path": "StructuredBody.component"
},
"path": "ClinicalDocument.component.structuredBody.component",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot"
} ],
"comment": "This structuredBody SHALL contain exactly one [1..1] component (CONF:1198-30611) such that it",
"sliceName": "vitalSigns"
}, {
"path": "ClinicalDocument.component.structuredBody.component.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.component.structuredBody.component:vitalSigns.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "ClinicalDocument.component.structuredBody.component:vitalSigns.realmCode",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.realmCode"
},
"path": "ClinicalDocument.component.structuredBody.component.realmCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question"
}, {
"id": "ClinicalDocument.component.structuredBody.component:vitalSigns.typeId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "InfrastructureRoot.typeId"
},
"path": "ClinicalDocument.component.structuredBody.component.typeId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"constraint": [ {
"key": "II-1",
"human": "An II instance must have either a root or an nullFlavor.",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader",
"severity": "error",
"expression": "root.exists() or nullFlavor.exists()"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question."
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.component.structuredBody.component:vitalSigns.typeId.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "ClinicalDocument.component.structuredBody.component:vitalSigns.typeId.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "ClinicalDocument.component.structuredBody.component:vitalSigns.typeId.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.root",
"min": 1,
"definition": "Identifies the type as an HL7 Registered model",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "2.16.840.1.113883.1.3",
"label": "Root",
"id": "ClinicalDocument.component.structuredBody.component:vitalSigns.typeId.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "ClinicalDocument.component.structuredBody.component:vitalSigns.typeId.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "ClinicalDocument.component.structuredBody.component:vitalSigns.templateId",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
},
"path": "ClinicalDocument.component.structuredBody.component.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"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"
}, {
"id": "ClinicalDocument.component.structuredBody.component:vitalSigns.typeCode",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "StructuredBody.component.typeCode"
},
"path": "ClinicalDocument.component.structuredBody.component.typeCode",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"fixedCode": "COMP",
"representation": [ "xmlAttr" ]
}, {
"id": "ClinicalDocument.component.structuredBody.component:vitalSigns.contextConductionInd",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "StructuredBody.component.contextConductionInd"
},
"path": "ClinicalDocument.component.structuredBody.component.contextConductionInd",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"fixedBoolean": true,
"representation": [ "xmlAttr" ]
}, {
"id": "ClinicalDocument.component.structuredBody.component:vitalSigns.section",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "StructuredBody.component.section"
},
"path": "ClinicalDocument.component.structuredBody.component.section",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Section",
"profile": [ "http://hl7.org/cda/us/ccda/StructureDefinition/VitalSignsSection" ]
} ],
"comment": "SHALL contain exactly one [1..1] Vital Signs Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.4.1:2024-05-01) (CONF:1198-30612)."
}, {
"id": "ClinicalDocument.component.structuredBody.component:advDirectives",
"max": "1",
"min": 0,
"base": {
"max": "*",
"min": 1,
"path": "StructuredBody.component"
},
"path": "ClinicalDocument.component.structuredBody.component",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot"
} ],
"comment": "This structuredBody MAY contain zero or one [0..1] component (CONF:1198-28942) such that it",
"sliceName": "advDirectives"
}, {
"path": "ClinicalDocument.component.structuredBody.component.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.component.structuredBody.component:advDirectives.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "ClinicalDocument.component.structuredBody.component:advDirectives.realmCode",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.realmCode"
},
"path": "ClinicalDocument.component.structuredBody.component.realmCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question"
}, {
"id": "ClinicalDocument.component.structuredBody.component:advDirectives.typeId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "InfrastructureRoot.typeId"
},
"path": "ClinicalDocument.component.structuredBody.component.typeId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"constraint": [ {
"key": "II-1",
"human": "An II instance must have either a root or an nullFlavor.",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader",
"severity": "error",
"expression": "root.exists() or nullFlavor.exists()"
} ],
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question."
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "ClinicalDocument.component.structuredBody.component:advDirectives.typeId.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.assigningAuthorityName",
"min": 0,
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "ClinicalDocument.component.structuredBody.component:advDirectives.typeId.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "ClinicalDocument.component.structuredBody.component:advDirectives.typeId.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.root",
"min": 1,
"definition": "Identifies the type as an HL7 Registered model",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "2.16.840.1.113883.1.3",
"label": "Root",
"id": "ClinicalDocument.component.structuredBody.component:advDirectives.typeId.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "ClinicalDocument.component.structuredBody.component.typeId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "ClinicalDocument.component.structuredBody.component:advDirectives.typeId.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "ClinicalDocument.component.structuredBody.component:advDirectives.templateId",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
},
"path": "ClinicalDocument.component.structuredBody.component.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"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"
}, {
"id": "ClinicalDocument.component.structuredBody.component:advDirectives.typeCode",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "StructuredBody.component.typeCode"
},
"path": "ClinicalDocument.component.structuredBody.component.typeCode",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"fixedCode": "COMP",
"representation": [ "xmlAttr" ]
}, {
"id": "ClinicalDocument.component.structuredBody.component:advDirectives.contextConductionInd",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "StructuredBody.component.contextConductionInd"
},
"path": "ClinicalDocument.component.structuredBody.component.contextConductionInd",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"fixedBoolean": true,
"representation": [ "xmlAttr" ]
}, {
"id": "ClinicalDocument.component.structuredBody.component:advDirectives.section",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "StructuredBody.component.section"
},
"path": "ClinicalDocument.component.structuredBody.component.section",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Section",
"profile": [ "http://hl7.org/cda/us/ccda/StructureDefinition/AdvanceDirectivesSection" ]
} ],
"comment": "SHALL contain exactly one [1..1] Advance Directives Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.21.1:2024-05-01)."
} ]
},
"status": "active",
"id": "b094d265-7ece-4c39-958d-60fa86244ef8",
"kind": "logical",
"url": "http://hl7.org/cda/us/ccda/StructureDefinition/HistoryandPhysical",
"identifier": [ {
"value": "urn:hl7ii:2.16.840.1.113883.10.20.22.1.3:2024-05-01",
"system": "urn:ietf:rfc:3986"
} ],
"version": "4.0.0-ballot",
"differential": {
"element": [ {
"id": "ClinicalDocument",
"path": "ClinicalDocument",
"constraint": [ {
"key": "category-34117-2",
"human": "If category is present, then there shall be a category with LOINC code '34117-2'.",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/HistoryandPhysical",
"severity": "error",
"expression": "sdtcCategory.empty() or sdtcCategory.exists(code = '34117-2' and codeSystem = '2.16.840.1.113883.6.1')"
} ]
}, {
"id": "ClinicalDocument.templateId",
"min": 2,
"path": "ClinicalDocument.templateId"
}, {
"id": "ClinicalDocument.templateId:history-physical",
"max": "1",
"min": 1,
"path": "ClinicalDocument.templateId",
"sliceName": "history-physical"
}, {
"id": "ClinicalDocument.templateId:history-physical.root",
"min": 1,
"path": "ClinicalDocument.templateId.root",
"patternString": "2.16.840.1.113883.10.20.22.1.3"
}, {
"id": "ClinicalDocument.templateId:history-physical.extension",
"min": 1,
"path": "ClinicalDocument.templateId.extension",
"patternString": "2024-05-01"
}, {
"id": "ClinicalDocument.sdtcCategory",
"path": "ClinicalDocument.sdtcCategory",
"short": "Used to categorize the document as a History and Physical. If present, there SHALL be a category of 34117-2 (History and physical note)."
}, {
"id": "ClinicalDocument.code",
"path": "ClinicalDocument.code",
"short": "The H&P Note recommends use of a single document type code, 34117-2 \"History and physical note\", with further specification provided by author or performer, setting, or specialty. When pre-coordinated codes are used, any coded values describing the author or performer of the service act or the practice setting must be consistent with the LOINC document type.",
"binding": {
"strength": "required",
"valueSet": "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.20.22"
},
"comment": "SHALL contain exactly one [1..1] code (CONF:1198-17185)."
}, {
"id": "ClinicalDocument.informationRecipient",
"path": "ClinicalDocument.informationRecipient",
"comment": "MAY contain zero or more [0..*] informationRecipient (CONF:1198-32482)."
}, {
"id": "ClinicalDocument.informationRecipient.intendedRecipient",
"path": "ClinicalDocument.informationRecipient.intendedRecipient",
"comment": "The informationRecipient, if present, SHALL contain exactly one [1..1] intendedRecipient (CONF:1198-32483)."
}, {
"id": "ClinicalDocument.participant",
"path": "ClinicalDocument.participant",
"short": "The participant element in the H&P header follows the General Header Constraints for participants. H&P Note does not specify any use for functionCode for participants. Local policies will determine how this element should be used in implementations.",
"comment": "MAY contain zero or more [0..*] participant (CONF:1198-8286).",
"constraint": [ {
"key": "1198-8333",
"human": "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 (CONF:1198-8333).\nA special class of participant is the supporting person or organization: an individual or an organization that has a relationship to the patient, including parents, relatives, caregivers, insurance policyholders, and guarantors. In the case of a supporting person who is also an emergency contact or next-of-kin, a participant element should be present for each role recorded.",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/HistoryandPhysical",
"severity": "warning"
} ]
}, {
"id": "ClinicalDocument.inFulfillmentOf",
"path": "ClinicalDocument.inFulfillmentOf",
"short": "inFulfillmentOf elements describe the prior orders that are fulfilled (in whole or part) by the service events described in this document. For example, the prior order might be a referral and the H&P Note may be in partial fulfillment of that referral.",
"comment": "MAY contain zero or more [0..*] inFulfillmentOf (CONF:1198-8336)."
}, {
"id": "ClinicalDocument.componentOf",
"min": 1,
"path": "ClinicalDocument.componentOf",
"short": "The H&P Note is always associated with an encounter.",
"comment": "SHALL contain exactly one [1..1] componentOf (CONF:1198-8338)."
}, {
"id": "ClinicalDocument.componentOf.encompassingEncounter",
"path": "ClinicalDocument.componentOf.encompassingEncounter",
"comment": "This componentOf SHALL contain exactly one [1..1] encompassingEncounter (CONF:1198-8339)."
}, {
"id": "ClinicalDocument.componentOf.encompassingEncounter.id",
"path": "ClinicalDocument.componentOf.encompassingEncounter.id",
"comment": "This encompassingEncounter SHALL contain at least one [1..*] id (CONF:1198-8340)."
}, {
"id": "ClinicalDocument.componentOf.encompassingEncounter.effectiveTime",
"path": "ClinicalDocument.componentOf.encompassingEncounter.effectiveTime",
"short": "The effectiveTime represents the time interval or point in time in which the encounter took place.",
"comment": "This encompassingEncounter SHALL contain exactly one [1..1] US Realm Date and Time (Interval) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.3) (CONF:1198-8341)."
}, {
"id": "ClinicalDocument.componentOf.encompassingEncounter.responsibleParty",
"path": "ClinicalDocument.componentOf.encompassingEncounter.responsibleParty",
"short": "The responsibleParty element records only the party responsible for the encounter, not necessarily the entire episode of care.",
"comment": "This encompassingEncounter MAY contain zero or one [0..1] responsibleParty (CONF:1198-8345).",
"constraint": [ {
"key": "1198-8348",
"human": "The responsibleParty element, if present, **SHALL** contain an assignedEntity element, which **SHALL** contain an assignedPerson element, a representedOrganization element, or both (CONF:1198-8348).",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/HistoryandPhysical",
"severity": "error",
"expression": "assignedEntity.assignedPerson.exists() or assignedEntity.representedOrganization.exists()"
} ]
}, {
"id": "ClinicalDocument.componentOf.encompassingEncounter.encounterParticipant",
"path": "ClinicalDocument.componentOf.encompassingEncounter.encounterParticipant",
"short": "The encounterParticipant elements represent only those participants in the encounter, not necessarily the entire episode of care.",
"comment": "This encompassingEncounter MAY contain zero or more [0..*] encounterParticipant (CONF:1198-8342).",
"constraint": [ {
"key": "1198-8343",
"human": "An encounterParticipant element, if present, SHALL contain an assignedEntity element, which SHALL contain an assignedPerson element, a representedOrganization element, or both (CONF:1198-8343).",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/HistoryandPhysical",
"severity": "error",
"expression": "assignedEntity.assignedPerson.exists() or assignedEntity.representedOrganization.exists()"
} ]
}, {
"id": "ClinicalDocument.componentOf.encompassingEncounter.location",
"path": "ClinicalDocument.componentOf.encompassingEncounter.location",
"comment": "This encompassingEncounter MAY contain zero or one [0..1] location (CONF:1198-8344)."
}, {
"id": "ClinicalDocument.component",
"path": "ClinicalDocument.component",
"comment": "SHALL contain exactly one [1..1] component (CONF:1198-8349)."
}, {
"id": "ClinicalDocument.component.structuredBody",
"min": 1,
"path": "ClinicalDocument.component.structuredBody",
"short": "In this template (templateId 2.16.840.1.113883.10.20.22.1.3.2), coded entries are optional.",
"comment": "This component SHALL contain exactly one [1..1] structuredBody (CONF:1198-30570).",
"constraint": [ {
"key": "ccrfv-or-cc-or-rfv",
"human": "This structuredBody **SHALL** contain a Chief Complaint and Reason for Visit Section (2.16.840.1.113883.10.20.22.2.13) or a Chief Complaint Section (1.3.6.1.4.1.19376.1.5.3.1.1.13.2.1) or a Reason for Visit Section (2.16.840.1.113883.10.20.22.2.12).",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/HistoryandPhysical",
"severity": "error",
"expression": "component.where(section.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/ChiefComplaintandReasonforVisitSection').exists() or section.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/ChiefComplaintSection').exists() or section.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/ReasonforVisitSection').exists()).exists()"
}, {
"key": "ap-or-a-and-p",
"human": "**SHALL** include an Assessment and Plan Section, or both an Assessment Section and a Plan of Treatment Section.",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/HistoryandPhysical",
"severity": "error",
"expression": "component.where(section.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/AssessmentandPlanSection')).exists() or (component.where(section.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/AssessmentSection') or section.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/PlanofTreatmentSection')).count() = 2)"
}, {
"key": "ap-combo",
"human": "This structuredBody **SHALL NOT** contain an Assessment and Plan Section (2.16.840.1.113883.10.20.22.2.9:2014-06-09) when either an Assessment Section (2.16.840.1.113883.10.20.22.2.8) or a Plan of Treatment Section (2.16.840.1.113883.10.20.22.2.10:2014-06-09) is present.",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/HistoryandPhysical",
"severity": "error",
"expression": "component.where(section.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/AssessmentandPlanSection')).exists() implies component.where(section.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/AssessmentSection') or section.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/PlanofTreatmentSection')).empty()"
}, {
"key": "cc-rfv-combo",
"human": "This structuredBody **SHALL NOT** contain a Chief Complaint and Reason for Visit Section (2.16.840.1.113883.10.20.22.2.13) when either a Chief Complaint Section (1.3.6.1.4.1.19376.1.5.3.1.1.13.2.1) or a Reason for Visit Section (2.16.840.1.113883.10.20.22.2.12) is present.",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/HistoryandPhysical",
"severity": "error",
"expression": "component.where(section.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/ChiefComplaintandReasonforVisitSection')).exists() implies component.where(section.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/ChiefComplaintSection') or section.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/ReasonforVisitSection')).empty()"
}, {
"key": "should-section-hpi",
"human": "SHOULD contain a History of Present Illness Section",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/HistoryandPhysical",
"severity": "warning",
"expression": "component.where(section.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/HistoryofPresentIllnessSection'))"
} ]
}, {
"id": "ClinicalDocument.component.structuredBody.component",
"min": 12,
"path": "ClinicalDocument.component.structuredBody.component",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "section",
"type": "profile"
} ]
}
}, {
"id": "ClinicalDocument.component.structuredBody.component:allergies",
"max": "1",
"min": 1,
"path": "ClinicalDocument.component.structuredBody.component",
"comment": "This structuredBody SHALL contain exactly one [1..1] component (CONF:1198-30571).",
"sliceName": "allergies"
}, {
"id": "ClinicalDocument.component.structuredBody.component:allergies.section",
"path": "ClinicalDocument.component.structuredBody.component.section",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Section",
"profile": [ "http://hl7.org/cda/us/ccda/StructureDefinition/AllergiesAndIntolerancesSection" ]
} ],
"comment": "SHALL contain exactly one [1..1] Allergies and Intolerances Section (identifier: urn:oid:2.16.840.1.113883.10.20.22.2.6.1:2024-05-01) (CONF:1198-30572)."
}, {
"id": "ClinicalDocument.component.structuredBody.component:assessment",
"max": "1",
"min": 0,
"path": "ClinicalDocument.component.structuredBody.component",
"comment": "This structuredBody MAY contain zero or one [0..1] component (CONF:1198-30573) such that it",
"sliceName": "assessment"
}, {
"id": "ClinicalDocument.component.structuredBody.component:assessment.section",
"path": "ClinicalDocument.component.structuredBody.component.section",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Section",
"profile": [ "http://hl7.org/cda/us/ccda/StructureDefinition/AssessmentSection" ]
} ],
"comment": "SHALL contain exactly one [1..1] Assessment Section (identifier: urn:oid:2.16.840.1.113883.10.20.22.2.8) (CONF:1198-30574)."
}, {
"id": "ClinicalDocument.component.structuredBody.component:planOfTreatment",
"max": "1",
"min": 0,
"path": "ClinicalDocument.component.structuredBody.component",
"comment": "This structuredBody MAY contain zero or one [0..1] component (CONF:1198-30575) such that it",
"sliceName": "planOfTreatment"
}, {
"id": "ClinicalDocument.component.structuredBody.component:planOfTreatment.section",
"path": "ClinicalDocument.component.structuredBody.component.section",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Section",
"profile": [ "http://hl7.org/cda/us/ccda/StructureDefinition/PlanofTreatmentSection" ]
} ],
"comment": "SHALL contain exactly one [1..1] Plan of Treatment Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.10:2014-06-09) (CONF:1198-30576)."
}, {
"id": "ClinicalDocument.component.structuredBody.component:assessmentAndPlan",
"max": "1",
"min": 0,
"path": "ClinicalDocument.component.structuredBody.component",
"comment": "This structuredBody MAY contain zero or one [0..1] component (CONF:1198-30577) such that it",
"sliceName": "assessmentAndPlan"
}, {
"id": "ClinicalDocument.component.structuredBody.component:assessmentAndPlan.section",
"path": "ClinicalDocument.component.structuredBody.component.section",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Section",
"profile": [ "http://hl7.org/cda/us/ccda/StructureDefinition/AssessmentandPlanSection" ]
} ],
"comment": "SHALL contain exactly one [1..1] Assessment and Plan Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.9:2014-06-09) (CONF:1198-30578)."
}, {
"id": "ClinicalDocument.component.structuredBody.component:chiefComplaint",
"max": "1",
"min": 0,
"path": "ClinicalDocument.component.structuredBody.component",
"comment": "This structuredBody MAY contain zero or one [0..1] component (CONF:1198-30579) such that it",
"sliceName": "chiefComplaint"
}, {
"id": "ClinicalDocument.component.structuredBody.component:chiefComplaint.section",
"path": "ClinicalDocument.component.structuredBody.component.section",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Section",
"profile": [ "http://hl7.org/cda/us/ccda/StructureDefinition/ChiefComplaintSection" ]
} ],
"comment": "SHALL contain exactly one [1..1] Chief Complaint Section (identifier: urn:oid:1.3.6.1.4.1.19376.1.5.3.1.1.13.2.1) (CONF:1198-30580)."
}, {
"id": "ClinicalDocument.component.structuredBody.component:chiefComplaintRFV",
"max": "1",
"min": 0,
"path": "ClinicalDocument.component.structuredBody.component",
"comment": "This structuredBody MAY contain zero or one [0..1] component (CONF:1198-30581) such that it",
"sliceName": "chiefComplaintRFV"
}, {
"id": "ClinicalDocument.component.structuredBody.component:chiefComplaintRFV.section",
"path": "ClinicalDocument.component.structuredBody.component.section",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Section",
"profile": [ "http://hl7.org/cda/us/ccda/StructureDefinition/ChiefComplaintandReasonforVisitSection" ]
} ],
"comment": "SHALL contain exactly one [1..1] Chief Complaint and Reason for Visit Section (identifier: urn:oid:2.16.840.1.113883.10.20.22.2.13) (CONF:1198-30582)."
}, {
"id": "ClinicalDocument.component.structuredBody.component:familyHistory",
"max": "1",
"min": 1,
"path": "ClinicalDocument.component.structuredBody.component",
"comment": "This structuredBody SHALL contain exactly one [1..1] component (CONF:1198-30583) such that it",
"sliceName": "familyHistory"
}, {
"id": "ClinicalDocument.component.structuredBody.component:familyHistory.section",
"path": "ClinicalDocument.component.structuredBody.component.section",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Section",
"profile": [ "http://hl7.org/cda/us/ccda/StructureDefinition/FamilyHistorySection" ]
} ],
"comment": "SHALL contain exactly one [1..1] Family History Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.15:2024-05-01) (CONF:1198-30584)."
}, {
"id": "ClinicalDocument.component.structuredBody.component:generalStatus",
"max": "1",
"min": 1,
"path": "ClinicalDocument.component.structuredBody.component",
"comment": "This structuredBody SHALL contain exactly one [1..1] component (CONF:1198-30585) such that it",
"sliceName": "generalStatus"
}, {
"id": "ClinicalDocument.component.structuredBody.component:generalStatus.section",
"path": "ClinicalDocument.component.structuredBody.component.section",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Section",
"profile": [ "http://hl7.org/cda/us/ccda/StructureDefinition/GeneralStatusSection" ]
} ],
"comment": "SHALL contain exactly one [1..1] General Status Section (identifier: urn:oid:2.16.840.1.113883.10.20.2.5) (CONF:1198-30586)."
}, {
"id": "ClinicalDocument.component.structuredBody.component:pastMedicalHistory",
"max": "1",
"min": 1,
"path": "ClinicalDocument.component.structuredBody.component",
"comment": "This structuredBody SHALL contain exactly one [1..1] component (CONF:1198-30587) such that it",
"sliceName": "pastMedicalHistory"
}, {
"id": "ClinicalDocument.component.structuredBody.component:pastMedicalHistory.section",
"path": "ClinicalDocument.component.structuredBody.component.section",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Section",
"profile": [ "http://hl7.org/cda/us/ccda/StructureDefinition/PastMedicalHistory" ]
} ],
"comment": "SHALL contain exactly one [1..1] Past Medical History (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.20:2024-05-01) (CONF:1198-30588)."
}, {
"id": "ClinicalDocument.component.structuredBody.component:historyPresentIllness",
"max": "1",
"min": 0,
"path": "ClinicalDocument.component.structuredBody.component",
"comment": "This structuredBody SHOULD contain zero or one [0..1] component (CONF:1198-30589) such that it",
"sliceName": "historyPresentIllness"
}, {
"id": "ClinicalDocument.component.structuredBody.component:historyPresentIllness.section",
"path": "ClinicalDocument.component.structuredBody.component.section",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Section",
"profile": [ "http://hl7.org/cda/us/ccda/StructureDefinition/HistoryofPresentIllnessSection" ]
} ],
"comment": "SHALL contain exactly one [1..1] History of Present Illness Section (identifier: urn:oid:1.3.6.1.4.1.19376.1.5.3.1.3.4) (CONF:1198-30590)."
}, {
"id": "ClinicalDocument.component.structuredBody.component:immunizations",
"max": "1",
"min": 0,
"path": "ClinicalDocument.component.structuredBody.component",
"comment": "This structuredBody MAY contain zero or one [0..1] component (CONF:1198-30591) such that it",
"sliceName": "immunizations"
}, {
"id": "ClinicalDocument.component.structuredBody.component:immunizations.section",
"path": "ClinicalDocument.component.structuredBody.component.section",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Section",
"profile": [ "http://hl7.org/cda/us/ccda/StructureDefinition/ImmunizationsSection" ]
} ],
"comment": "SHALL contain exactly one [1..1] Immunizations Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.2.1:2024-05-01) (CONF:1198-30592)."
}, {
"id": "ClinicalDocument.component.structuredBody.component:instructions",
"max": "1",
"min": 0,
"path": "ClinicalDocument.component.structuredBody.component",
"comment": "This structuredBody MAY contain zero or one [0..1] component (CONF:1198-30593) such that it",
"sliceName": "instructions"
}, {
"id": "ClinicalDocument.component.structuredBody.component:instructions.section",
"path": "ClinicalDocument.component.structuredBody.component.section",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Section",
"profile": [ "http://hl7.org/cda/us/ccda/StructureDefinition/InstructionsSection" ]
} ],
"comment": "SHALL contain exactly one [1..1] Instructions Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.45:2014-06-09) (CONF:1198-31385)."
}, {
"id": "ClinicalDocument.component.structuredBody.component:medications",
"max": "1",
"min": 1,
"path": "ClinicalDocument.component.structuredBody.component",
"comment": "This structuredBody SHALL contain exactly one [1..1] component (CONF:1198-30595) such that it",
"sliceName": "medications"
}, {
"id": "ClinicalDocument.component.structuredBody.component:medications.section",
"path": "ClinicalDocument.component.structuredBody.component.section",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Section",
"profile": [ "http://hl7.org/cda/us/ccda/StructureDefinition/MedicationsSection" ]
} ],
"comment": "SHALL contain exactly one [1..1] Medications Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.1.1:2014-06-09) (CONF:1198-30596)."
}, {
"id": "ClinicalDocument.component.structuredBody.component:physicalExam",
"max": "1",
"min": 1,
"path": "ClinicalDocument.component.structuredBody.component",
"comment": "This structuredBody SHALL contain exactly one [1..1] component (CONF:1198-30597) such that it",
"sliceName": "physicalExam"
}, {
"id": "ClinicalDocument.component.structuredBody.component:physicalExam.section",
"path": "ClinicalDocument.component.structuredBody.component.section",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Section",
"profile": [ "http://hl7.org/cda/us/ccda/StructureDefinition/PhysicalExamSection" ]
} ],
"comment": "SHALL contain exactly one [1..1] Physical Exam Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.2.10:2024-05-01) (CONF:1198-30598)."
}, {
"id": "ClinicalDocument.component.structuredBody.component:problems",
"max": "1",
"min": 0,
"path": "ClinicalDocument.component.structuredBody.component",
"comment": "This structuredBody MAY contain zero or one [0..1] component (CONF:1198-30599) such that it",
"sliceName": "problems"
}, {
"id": "ClinicalDocument.component.structuredBody.component:problems.section",
"path": "ClinicalDocument.component.structuredBody.component.section",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Section",
"profile": [ "http://hl7.org/cda/us/ccda/StructureDefinition/ProblemSection" ]
} ],
"comment": "SHALL contain exactly one [1..1] Problem Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.5.1:2024-05-01) (CONF:1198-30600)."
}, {
"id": "ClinicalDocument.component.structuredBody.component:procedures",
"max": "1",
"min": 0,
"path": "ClinicalDocument.component.structuredBody.component",
"comment": "This structuredBody MAY contain zero or one [0..1] component (CONF:1198-30601) such that it",
"sliceName": "procedures"
}, {
"id": "ClinicalDocument.component.structuredBody.component:procedures.section",
"path": "ClinicalDocument.component.structuredBody.component.section",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Section",
"profile": [ "http://hl7.org/cda/us/ccda/StructureDefinition/ProceduresSection" ]
} ],
"comment": "SHALL contain exactly one [1..1] Procedures Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.7.1:2014-06-09) (CONF:1198-30602)."
}, {
"id": "ClinicalDocument.component.structuredBody.component:reasonForVisit",
"max": "1",
"min": 0,
"path": "ClinicalDocument.component.structuredBody.component",
"comment": "This structuredBody MAY contain zero or one [0..1] component (CONF:1198-30603) such that it",
"sliceName": "reasonForVisit"
}, {
"id": "ClinicalDocument.component.structuredBody.component:reasonForVisit.section",
"path": "ClinicalDocument.component.structuredBody.component.section",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Section",
"profile": [ "http://hl7.org/cda/us/ccda/StructureDefinition/ReasonforVisitSection" ]
} ],
"comment": "SHALL contain exactly one [1..1] Reason for Visit Section (identifier: urn:oid:2.16.840.1.113883.10.20.22.2.12) (CONF:1198-30604)."
}, {
"id": "ClinicalDocument.component.structuredBody.component:results",
"max": "1",
"min": 1,
"path": "ClinicalDocument.component.structuredBody.component",
"comment": "This structuredBody SHALL contain exactly one [1..1] component (CONF:1198-30605) such that it",
"sliceName": "results"
}, {
"id": "ClinicalDocument.component.structuredBody.component:results.section",
"path": "ClinicalDocument.component.structuredBody.component.section",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Section",
"profile": [ "http://hl7.org/cda/us/ccda/StructureDefinition/ResultsSection" ]
} ],
"comment": "SHALL contain exactly one [1..1] Results Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.3.1:2024-05-01) (CONF:1198-30606)."
}, {
"id": "ClinicalDocument.component.structuredBody.component:reviewOfSystems",
"max": "1",
"min": 1,
"path": "ClinicalDocument.component.structuredBody.component",
"comment": "This structuredBody SHALL contain exactly one [1..1] component (CONF:1198-30607) such that it",
"sliceName": "reviewOfSystems"
}, {
"id": "ClinicalDocument.component.structuredBody.component:reviewOfSystems.section",
"path": "ClinicalDocument.component.structuredBody.component.section",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Section",
"profile": [ "http://hl7.org/cda/us/ccda/StructureDefinition/ReviewofSystemsSection" ]
} ],
"comment": "SHALL contain exactly one [1..1] Review of Systems Section (identifier: urn:oid:1.3.6.1.4.1.19376.1.5.3.1.3.18) (CONF:1198-30608)."
}, {
"id": "ClinicalDocument.component.structuredBody.component:socialHistory",
"max": "1",
"min": 1,
"path": "ClinicalDocument.component.structuredBody.component",
"comment": "This structuredBody SHALL contain exactly one [1..1] component (CONF:1198-30609) such that it",
"sliceName": "socialHistory"
}, {
"id": "ClinicalDocument.component.structuredBody.component:socialHistory.section",
"path": "ClinicalDocument.component.structuredBody.component.section",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Section",
"profile": [ "http://hl7.org/cda/us/ccda/StructureDefinition/SocialHistorySection" ]
} ],
"comment": "SHALL contain exactly one [1..1] Social History Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.17:2024-05-01) (CONF:1198-30610)."
}, {
"id": "ClinicalDocument.component.structuredBody.component:vitalSigns",
"max": "1",
"min": 1,
"path": "ClinicalDocument.component.structuredBody.component",
"comment": "This structuredBody SHALL contain exactly one [1..1] component (CONF:1198-30611) such that it",
"sliceName": "vitalSigns"
}, {
"id": "ClinicalDocument.component.structuredBody.component:vitalSigns.section",
"path": "ClinicalDocument.component.structuredBody.component.section",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Section",
"profile": [ "http://hl7.org/cda/us/ccda/StructureDefinition/VitalSignsSection" ]
} ],
"comment": "SHALL contain exactly one [1..1] Vital Signs Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.4.1:2024-05-01) (CONF:1198-30612)."
}, {
"id": "ClinicalDocument.component.structuredBody.component:advDirectives",
"max": "1",
"min": 0,
"path": "ClinicalDocument.component.structuredBody.component",
"comment": "This structuredBody MAY contain zero or one [0..1] component (CONF:1198-28942) such that it",
"sliceName": "advDirectives"
}, {
"id": "ClinicalDocument.component.structuredBody.component:advDirectives.section",
"path": "ClinicalDocument.component.structuredBody.component.section",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Section",
"profile": [ "http://hl7.org/cda/us/ccda/StructureDefinition/AdvanceDirectivesSection" ]
} ],
"comment": "SHALL contain exactly one [1..1] Advance Directives Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.21.1:2024-05-01)."
} ]
},
"contact": [ {
"name": "HL7 International - Structured Documents",
"telecom": [ {
"value": "http://www.hl7.org/Special/committees/structure",
"system": "url"
} ]
} ],
"baseDefinition": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader"
}