Clinical Document Architecture
2.0.0-sd - release
Clinical Document Architecture
2.0.0-sd - release
Clinical Document Architecture, published by Health Level 7. This guide is not an authorized publication; it is the continuous build for version 2.0.0-sd built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/CDA-core-sd/ and changes regularly. See the Directory of published versions
| Active as of 2024-10-25 |
JSON representation of the EntryRelationship logical model.
{
"resourceType" : "StructureDefinition",
"id" : "EntryRelationship",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n <p>CDA entries represent the structured computer-processable components within a document section. Each section can contain zero to many entries.</p>\n </div>"
},
"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" : "entryRelationship"
},
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/logical-container",
"valueUri" : "http://hl7.org/cda/stds/core/StructureDefinition/ClinicalDocument"
},
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/type-profile-style",
"valueUri" : "cda"
}
],
"url" : "http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship",
"version" : "2.0.0-sd",
"name" : "EntryRelationship",
"title" : "EntryRelationship (CDA Class)",
"status" : "active",
"experimental" : false,
"date" : "2024-10-25T20:25:09+00:00",
"publisher" : "Health Level 7",
"contact" : [
{
"name" : "HL7 International - Structured Documents",
"telecom" : [
{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/structure"
},
{
"system" : "email",
"value" : "structdog@lists.HL7.org"
}
]
}
],
"description" : "CDA entries represent the structured computer-processable components within a document section. Each section can contain zero to many entries.",
"fhirVersion" : "5.0.0",
"mapping" : [
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
}
],
"kind" : "logical",
"abstract" : false,
"type" : "http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship",
"baseDefinition" : "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot",
"derivation" : "specialization",
"snapshot" : {
"element" : [
{
"id" : "EntryRelationship",
"path" : "EntryRelationship",
"short" : "Base for all types and resources",
"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.",
"min" : 1,
"max" : "*",
"base" : {
"path" : "Base",
"min" : 0,
"max" : "*"
},
"constraint" : [
{
"key" : "entry-rel-only-one",
"severity" : "error",
"human" : "SHALL have no more than one of act, encounter, observation, observationMedia, organizer, procedure, regionOfInterest, substanceAdministration, or supply.",
"expression" : "(act | encounter | observation | observationMedia | organizer | procedure | regionOfInterest | substanceAdministration | supply).count() = 1"
}
],
"isModifier" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "EntryRelationship.nullFlavor",
"path" : "EntryRelationship.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"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"
}
},
{
"id" : "EntryRelationship.realmCode",
"path" : "EntryRelationship.realmCode",
"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",
"min" : 0,
"max" : "*",
"base" : {
"path" : "InfrastructureRoot.realmCode",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CS"
}
]
},
{
"id" : "EntryRelationship.typeId",
"path" : "EntryRelationship.typeId",
"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.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "InfrastructureRoot.typeId",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id" : "EntryRelationship.typeId.nullFlavor",
"path" : "EntryRelationship.typeId.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"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"
}
},
{
"id" : "EntryRelationship.typeId.assigningAuthorityName",
"path" : "EntryRelationship.typeId.assigningAuthorityName",
"representation" : [
"xmlAttr"
],
"label" : "Assigning Authority Name",
"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.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "II.assigningAuthorityName",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "EntryRelationship.typeId.displayable",
"path" : "EntryRelationship.typeId.displayable",
"representation" : [
"xmlAttr"
],
"label" : "Displayable",
"definition" : "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "II.displayable",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "boolean",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple"
]
}
]
},
{
"id" : "EntryRelationship.typeId.root",
"path" : "EntryRelationship.typeId.root",
"representation" : [
"xmlAttr"
],
"label" : "Root",
"definition" : "Identifies the type as an HL7 Registered model",
"min" : 1,
"max" : "1",
"base" : {
"path" : "II.root",
"min" : 0,
"max" : "1"
},
"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"
]
}
],
"fixedString" : "2.16.840.1.113883.1.3"
},
{
"id" : "EntryRelationship.typeId.extension",
"path" : "EntryRelationship.typeId.extension",
"representation" : [
"xmlAttr"
],
"label" : "Extension",
"definition" : "A character string as a unique identifier within the scope of the identifier root.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "II.extension",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "EntryRelationship.templateId",
"path" : "EntryRelationship.templateId",
"definition" : "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question",
"min" : 0,
"max" : "*",
"base" : {
"path" : "InfrastructureRoot.templateId",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id" : "EntryRelationship.typeCode",
"path" : "EntryRelationship.typeCode",
"representation" : [
"xmlAttr"
],
"min" : 1,
"max" : "1",
"base" : {
"path" : "EntryRelationship.typeCode",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship"
}
},
{
"id" : "EntryRelationship.inversionInd",
"path" : "EntryRelationship.inversionInd",
"representation" : [
"xmlAttr"
],
"definition" : "The entryRelationship.inversionInd can be set to \"true\" to indicate that the relationship should be interpreted as if the roles of the source and target entries were reversed.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "EntryRelationship.inversionInd",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "boolean",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple"
]
}
]
},
{
"id" : "EntryRelationship.contextConductionInd",
"path" : "EntryRelationship.contextConductionInd",
"representation" : [
"xmlAttr"
],
"definition" : "The entryRelationship.contextConductionInd differs from the otherwise common use of this attribute in that in all other cases where this attribute is used, the value is fixed at \"true\", whereas here the value is defaulted to \"true\", and can be changed to \"false\" when referencing an entry in the same document. Setting the context conduction to false when referencing an entry in the same document keeps clear the fact that the referenced object retains its original context.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "EntryRelationship.contextConductionInd",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "boolean",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple"
]
}
],
"defaultValueBoolean" : true
},
{
"id" : "EntryRelationship.negationInd",
"path" : "EntryRelationship.negationInd",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "EntryRelationship.negationInd",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "boolean",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple"
]
}
]
},
{
"id" : "EntryRelationship.sequenceNumber",
"path" : "EntryRelationship.sequenceNumber",
"min" : 0,
"max" : "1",
"base" : {
"path" : "EntryRelationship.sequenceNumber",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/INT"
}
]
},
{
"id" : "EntryRelationship.seperatableInd",
"path" : "EntryRelationship.seperatableInd",
"min" : 0,
"max" : "1",
"base" : {
"path" : "EntryRelationship.seperatableInd",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/BL"
}
]
},
{
"id" : "EntryRelationship.act",
"path" : "EntryRelationship.act",
"min" : 0,
"max" : "1",
"base" : {
"path" : "EntryRelationship.act",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/Act"
}
]
},
{
"id" : "EntryRelationship.encounter",
"path" : "EntryRelationship.encounter",
"min" : 0,
"max" : "1",
"base" : {
"path" : "EntryRelationship.encounter",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/Encounter"
}
]
},
{
"id" : "EntryRelationship.observation",
"path" : "EntryRelationship.observation",
"min" : 0,
"max" : "1",
"base" : {
"path" : "EntryRelationship.observation",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/Observation"
}
]
},
{
"id" : "EntryRelationship.observationMedia",
"path" : "EntryRelationship.observationMedia",
"min" : 0,
"max" : "1",
"base" : {
"path" : "EntryRelationship.observationMedia",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia"
}
]
},
{
"id" : "EntryRelationship.organizer",
"path" : "EntryRelationship.organizer",
"min" : 0,
"max" : "1",
"base" : {
"path" : "EntryRelationship.organizer",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/Organizer"
}
]
},
{
"id" : "EntryRelationship.procedure",
"path" : "EntryRelationship.procedure",
"min" : 0,
"max" : "1",
"base" : {
"path" : "EntryRelationship.procedure",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/Procedure"
}
]
},
{
"id" : "EntryRelationship.regionOfInterest",
"path" : "EntryRelationship.regionOfInterest",
"min" : 0,
"max" : "1",
"base" : {
"path" : "EntryRelationship.regionOfInterest",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest"
}
]
},
{
"id" : "EntryRelationship.substanceAdministration",
"path" : "EntryRelationship.substanceAdministration",
"min" : 0,
"max" : "1",
"base" : {
"path" : "EntryRelationship.substanceAdministration",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration"
}
]
},
{
"id" : "EntryRelationship.supply",
"path" : "EntryRelationship.supply",
"min" : 0,
"max" : "1",
"base" : {
"path" : "EntryRelationship.supply",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/Supply"
}
]
}
]
},
"differential" : {
"element" : [
{
"id" : "EntryRelationship",
"path" : "EntryRelationship",
"min" : 1,
"max" : "*",
"constraint" : [
{
"key" : "entry-rel-only-one",
"severity" : "error",
"human" : "SHALL have no more than one of act, encounter, observation, observationMedia, organizer, procedure, regionOfInterest, substanceAdministration, or supply.",
"expression" : "(act | encounter | observation | observationMedia | organizer | procedure | regionOfInterest | substanceAdministration | supply).count() = 1"
}
]
},
{
"id" : "EntryRelationship.typeCode",
"path" : "EntryRelationship.typeCode",
"representation" : [
"xmlAttr"
],
"min" : 1,
"max" : "1",
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship"
}
},
{
"id" : "EntryRelationship.inversionInd",
"path" : "EntryRelationship.inversionInd",
"representation" : [
"xmlAttr"
],
"definition" : "The entryRelationship.inversionInd can be set to \"true\" to indicate that the relationship should be interpreted as if the roles of the source and target entries were reversed.",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "boolean",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple"
]
}
]
},
{
"id" : "EntryRelationship.contextConductionInd",
"path" : "EntryRelationship.contextConductionInd",
"representation" : [
"xmlAttr"
],
"definition" : "The entryRelationship.contextConductionInd differs from the otherwise common use of this attribute in that in all other cases where this attribute is used, the value is fixed at \"true\", whereas here the value is defaulted to \"true\", and can be changed to \"false\" when referencing an entry in the same document. Setting the context conduction to false when referencing an entry in the same document keeps clear the fact that the referenced object retains its original context.",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "boolean",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple"
]
}
],
"defaultValueBoolean" : true
},
{
"id" : "EntryRelationship.negationInd",
"path" : "EntryRelationship.negationInd",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "boolean",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple"
]
}
]
},
{
"id" : "EntryRelationship.sequenceNumber",
"path" : "EntryRelationship.sequenceNumber",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/INT"
}
]
},
{
"id" : "EntryRelationship.seperatableInd",
"path" : "EntryRelationship.seperatableInd",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/BL"
}
]
},
{
"id" : "EntryRelationship.act",
"path" : "EntryRelationship.act",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/Act"
}
]
},
{
"id" : "EntryRelationship.encounter",
"path" : "EntryRelationship.encounter",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/Encounter"
}
]
},
{
"id" : "EntryRelationship.observation",
"path" : "EntryRelationship.observation",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/Observation"
}
]
},
{
"id" : "EntryRelationship.observationMedia",
"path" : "EntryRelationship.observationMedia",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia"
}
]
},
{
"id" : "EntryRelationship.organizer",
"path" : "EntryRelationship.organizer",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/Organizer"
}
]
},
{
"id" : "EntryRelationship.procedure",
"path" : "EntryRelationship.procedure",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/Procedure"
}
]
},
{
"id" : "EntryRelationship.regionOfInterest",
"path" : "EntryRelationship.regionOfInterest",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest"
}
]
},
{
"id" : "EntryRelationship.substanceAdministration",
"path" : "EntryRelationship.substanceAdministration",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration"
}
]
},
{
"id" : "EntryRelationship.supply",
"path" : "EntryRelationship.supply",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/Supply"
}
]
}
]
}
}
IG © 2019+ Health Level 7. Package hl7.cda.uv.core#2.0.0-sd based on FHIR 5.0.0. Generated 2024-10-25
Links: Table of Contents |
QA Report
| Version History 
|
|
Propose a change