Clinical Document Architecture V2.0.1
2.1.0-draft1 - 1st Draft
Clinical Document Architecture V2.0.1
2.1.0-draft1 - 1st Draft
This page is part of the CDA: Clinical Document Architecture (v2.1.0-draft1: CDA 2.1 Draft) based on FHIR v5.0.0. . For a full list of available versions, see the Directory of published versions 
| Active as of 2023-01-16 |
JSON representation of the Encounter logical model.
{
"resourceType" : "StructureDefinition",
"id" : "Encounter",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n <p>A derivative of the RIM PatientEncounter class, used to represent related encounters, such as follow-up visits or referenced past encounters.</p>\n <p>NOTE: The EncompassingEncounter class in the CDA Header (see Header Relationships (§ 4.2.3 )) represents the setting of the clinical encounter during which the documented act occurred. The Encounter class in the CDA Body is used to represent other related encounters.</p>\n </div>"
},
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace",
"valueUri" : "urn:hl7-org:v3"
}
],
"url" : "http://hl7.org/fhir/cda/StructureDefinition/Encounter",
"version" : "2.1.0-draft1",
"name" : "CDAR2.Encounter",
"title" : "Encounter (CDA Class)",
"status" : "active",
"experimental" : false,
"date" : "2023-01-16T16:39:50+11:00",
"publisher" : "Health Level 7",
"contact" : [
{
"name" : "HL7 International - Cross-Group Projects",
"telecom" : [
{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/cgp"
},
{
"system" : "email",
"value" : "cgp@lists.HL7.org"
}
]
}
],
"description" : "A derivative of the RIM PatientEncounter class, used to represent related encounters, such as follow-up visits or referenced past encounters.\nNOTE: The EncompassingEncounter class in the CDA Header (see Header Relationships (§ 4.2.3 )) represents the setting of the clinical encounter during which the documented act occurred. The Encounter class in the CDA Body is used to represent other related encounters.",
"fhirVersion" : "5.0.0-snapshot3",
"mapping" : [
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
}
],
"kind" : "logical",
"abstract" : false,
"type" : "Encounter",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/Base",
"derivation" : "specialization",
"snapshot" : {
"element" : [
{
"id" : "Encounter",
"path" : "Encounter",
"short" : "Base for all types and resources",
"definition" : "Base definition for all types defined in FHIR type system.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Base",
"min" : 0,
"max" : "*"
},
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Encounter.classCode",
"path" : "Encounter.classCode",
"representation" : [
"xmlAttr"
],
"min" : 1,
"max" : "1",
"base" : {
"path" : "Encounter.classCode",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"fixedCode" : "ENC",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-ActClass"
}
},
{
"id" : "Encounter.moodCode",
"path" : "Encounter.moodCode",
"representation" : [
"xmlAttr"
],
"min" : 1,
"max" : "1",
"base" : {
"path" : "Encounter.moodCode",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
]
},
{
"id" : "Encounter.realmCode",
"path" : "Encounter.realmCode",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Encounter.realmCode",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/CS"
}
]
},
{
"id" : "Encounter.typeId",
"path" : "Encounter.typeId",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Encounter.typeId",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/II"
}
]
},
{
"id" : "Encounter.templateId",
"path" : "Encounter.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" : "Encounter.templateId",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/II"
}
]
},
{
"id" : "Encounter.id",
"path" : "Encounter.id",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Encounter.id",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/II"
}
]
},
{
"id" : "Encounter.code",
"path" : "Encounter.code",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Encounter.code",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/CD"
}
],
"binding" : {
"strength" : "extensible",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-ActEncounterCode"
}
},
{
"id" : "Encounter.text",
"path" : "Encounter.text",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Encounter.text",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/ED"
}
]
},
{
"id" : "Encounter.statusCode",
"path" : "Encounter.statusCode",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Encounter.statusCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/CS"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-ActStatus"
}
},
{
"id" : "Encounter.effectiveTime",
"path" : "Encounter.effectiveTime",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Encounter.effectiveTime",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/IVL-TS"
}
]
},
{
"id" : "Encounter.dischargeDispositionCode",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace",
"valueUri" : "urn:hl7-org:sdtc"
}
],
"path" : "Encounter.dischargeDispositionCode",
"short" : "sdtc:dischargeDispositionCode",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Encounter.dischargeDispositionCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/CE"
}
]
},
{
"id" : "Encounter.priorityCode",
"path" : "Encounter.priorityCode",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Encounter.priorityCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/CE"
}
],
"binding" : {
"strength" : "extensible",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-ActPriority"
}
},
{
"id" : "Encounter.subject",
"path" : "Encounter.subject",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Encounter.subject",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Element"
}
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
]
},
{
"id" : "Encounter.subject.id",
"path" : "Encounter.subject.id",
"representation" : [
"xmlAttr"
],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}
],
"code" : "http://hl7.org/fhirpath/System.String"
}
],
"isModifier" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Encounter.subject.extension",
"path" : "Encounter.subject.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Encounter.subject.typeCode",
"path" : "Encounter.subject.typeCode",
"representation" : [
"xmlAttr"
],
"min" : 1,
"max" : "1",
"base" : {
"path" : "Encounter.subject.typeCode",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"defaultValueCode" : "SBJ",
"fixedCode" : "SBJ",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-ParticipationTargetSubject"
}
},
{
"id" : "Encounter.subject.contextControlCode",
"path" : "Encounter.subject.contextControlCode",
"representation" : [
"xmlAttr"
],
"min" : 1,
"max" : "1",
"base" : {
"path" : "Encounter.subject.contextControlCode",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"defaultValueCode" : "OP",
"fixedCode" : "OP",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-ContextControl"
}
},
{
"id" : "Encounter.subject.awarenessCode",
"path" : "Encounter.subject.awarenessCode",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Encounter.subject.awarenessCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/CE"
}
],
"binding" : {
"strength" : "extensible",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-TargetAwareness"
}
},
{
"id" : "Encounter.subject.relatedSubject",
"path" : "Encounter.subject.relatedSubject",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Encounter.subject.relatedSubject",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/RelatedSubject"
}
]
},
{
"id" : "Encounter.specimen",
"path" : "Encounter.specimen",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Encounter.specimen",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/Specimen"
}
]
},
{
"id" : "Encounter.performer",
"path" : "Encounter.performer",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Encounter.performer",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/Performer2"
}
]
},
{
"id" : "Encounter.author",
"path" : "Encounter.author",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Encounter.author",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/Author"
}
]
},
{
"id" : "Encounter.informant",
"path" : "Encounter.informant",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Encounter.informant",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Element"
}
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
]
},
{
"id" : "Encounter.informant.id",
"path" : "Encounter.informant.id",
"representation" : [
"xmlAttr"
],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}
],
"code" : "http://hl7.org/fhirpath/System.String"
}
],
"isModifier" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Encounter.informant.extension",
"path" : "Encounter.informant.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Encounter.informant.typeCode",
"path" : "Encounter.informant.typeCode",
"representation" : [
"xmlAttr"
],
"min" : 1,
"max" : "1",
"base" : {
"path" : "Encounter.informant.typeCode",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"defaultValueCode" : "INF",
"fixedCode" : "INF",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-ParticipationInformationGenerator"
}
},
{
"id" : "Encounter.informant.contextControlCode",
"path" : "Encounter.informant.contextControlCode",
"representation" : [
"xmlAttr"
],
"min" : 1,
"max" : "1",
"base" : {
"path" : "Encounter.informant.contextControlCode",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"defaultValueCode" : "OP",
"fixedCode" : "OP",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-ContextControl"
}
},
{
"id" : "Encounter.informant.assignedEntity",
"path" : "Encounter.informant.assignedEntity",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Encounter.informant.assignedEntity",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/AssignedEntity"
}
]
},
{
"id" : "Encounter.informant.relatedEntity",
"path" : "Encounter.informant.relatedEntity",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Encounter.informant.relatedEntity",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/RelatedEntity"
}
]
},
{
"id" : "Encounter.participant",
"path" : "Encounter.participant",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Encounter.participant",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/Participant2"
}
]
},
{
"id" : "Encounter.entryRelationship",
"path" : "Encounter.entryRelationship",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Encounter.entryRelationship",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Element"
}
],
"constraint" : [
{
"key" : "enc-er-1",
"severity" : "error",
"human" : "Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act",
"expression" : "(observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1"
},
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
]
},
{
"id" : "Encounter.entryRelationship.id",
"path" : "Encounter.entryRelationship.id",
"representation" : [
"xmlAttr"
],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}
],
"code" : "http://hl7.org/fhirpath/System.String"
}
],
"isModifier" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Encounter.entryRelationship.extension",
"path" : "Encounter.entryRelationship.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Encounter.entryRelationship.typeCode",
"path" : "Encounter.entryRelationship.typeCode",
"representation" : [
"xmlAttr"
],
"min" : 1,
"max" : "1",
"base" : {
"path" : "Encounter.entryRelationship.typeCode",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
]
},
{
"id" : "Encounter.entryRelationship.inversionInd",
"path" : "Encounter.entryRelationship.inversionInd",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Encounter.entryRelationship.inversionInd",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "boolean"
}
]
},
{
"id" : "Encounter.entryRelationship.contextConductionInd",
"path" : "Encounter.entryRelationship.contextConductionInd",
"representation" : [
"xmlAttr"
],
"min" : 1,
"max" : "1",
"base" : {
"path" : "Encounter.entryRelationship.contextConductionInd",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "boolean"
}
],
"defaultValueBoolean" : true
},
{
"id" : "Encounter.entryRelationship.sequenceNumber",
"path" : "Encounter.entryRelationship.sequenceNumber",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Encounter.entryRelationship.sequenceNumber",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/INT"
}
]
},
{
"id" : "Encounter.entryRelationship.negationInd",
"path" : "Encounter.entryRelationship.negationInd",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Encounter.entryRelationship.negationInd",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "boolean"
}
]
},
{
"id" : "Encounter.entryRelationship.seperatableInd",
"path" : "Encounter.entryRelationship.seperatableInd",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Encounter.entryRelationship.seperatableInd",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/BL"
}
]
},
{
"id" : "Encounter.entryRelationship.observation",
"path" : "Encounter.entryRelationship.observation",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Encounter.entryRelationship.observation",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/Observation"
}
]
},
{
"id" : "Encounter.entryRelationship.regionOfInterest",
"path" : "Encounter.entryRelationship.regionOfInterest",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Encounter.entryRelationship.regionOfInterest",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest"
}
]
},
{
"id" : "Encounter.entryRelationship.observationMedia",
"path" : "Encounter.entryRelationship.observationMedia",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Encounter.entryRelationship.observationMedia",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/ObservationMedia"
}
]
},
{
"id" : "Encounter.entryRelationship.substanceAdministration",
"path" : "Encounter.entryRelationship.substanceAdministration",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Encounter.entryRelationship.substanceAdministration",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration"
}
]
},
{
"id" : "Encounter.entryRelationship.supply",
"path" : "Encounter.entryRelationship.supply",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Encounter.entryRelationship.supply",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/Supply"
}
]
},
{
"id" : "Encounter.entryRelationship.procedure",
"path" : "Encounter.entryRelationship.procedure",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Encounter.entryRelationship.procedure",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/Procedure"
}
]
},
{
"id" : "Encounter.entryRelationship.encounter",
"path" : "Encounter.entryRelationship.encounter",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Encounter.entryRelationship.encounter",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/Encounter"
}
]
},
{
"id" : "Encounter.entryRelationship.organizer",
"path" : "Encounter.entryRelationship.organizer",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Encounter.entryRelationship.organizer",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/Organizer"
}
]
},
{
"id" : "Encounter.entryRelationship.act",
"path" : "Encounter.entryRelationship.act",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Encounter.entryRelationship.act",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/Act"
}
]
},
{
"id" : "Encounter.reference",
"path" : "Encounter.reference",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Encounter.reference",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Element"
}
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
]
},
{
"id" : "Encounter.reference.id",
"path" : "Encounter.reference.id",
"representation" : [
"xmlAttr"
],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}
],
"code" : "http://hl7.org/fhirpath/System.String"
}
],
"isModifier" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Encounter.reference.extension",
"path" : "Encounter.reference.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Encounter.reference.typeCode",
"path" : "Encounter.reference.typeCode",
"representation" : [
"xmlAttr"
],
"min" : 1,
"max" : "1",
"base" : {
"path" : "Encounter.reference.typeCode",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
]
},
{
"id" : "Encounter.reference.seperatableInd",
"path" : "Encounter.reference.seperatableInd",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Encounter.reference.seperatableInd",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/BL"
}
]
},
{
"id" : "Encounter.reference.externalAct",
"path" : "Encounter.reference.externalAct",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Encounter.reference.externalAct",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/ExternalAct"
}
]
},
{
"id" : "Encounter.reference.externalObservation",
"path" : "Encounter.reference.externalObservation",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Encounter.reference.externalObservation",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/ExternalObservation"
}
]
},
{
"id" : "Encounter.reference.externalProcedure",
"path" : "Encounter.reference.externalProcedure",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Encounter.reference.externalProcedure",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/ExternalProcedure"
}
]
},
{
"id" : "Encounter.reference.externalDocument",
"path" : "Encounter.reference.externalDocument",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Encounter.reference.externalDocument",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/ExternalDocument"
}
]
},
{
"id" : "Encounter.precondition",
"path" : "Encounter.precondition",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Encounter.precondition",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/Precondition"
}
]
}
]
},
"differential" : {
"element" : [
{
"id" : "Encounter",
"path" : "Encounter",
"min" : 1,
"max" : "1"
},
{
"id" : "Encounter.classCode",
"path" : "Encounter.classCode",
"representation" : [
"xmlAttr"
],
"min" : 1,
"max" : "1",
"type" : [
{
"code" : "code"
}
],
"fixedCode" : "ENC",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-ActClass"
}
},
{
"id" : "Encounter.moodCode",
"path" : "Encounter.moodCode",
"representation" : [
"xmlAttr"
],
"min" : 1,
"max" : "1",
"type" : [
{
"code" : "code"
}
]
},
{
"id" : "Encounter.realmCode",
"path" : "Encounter.realmCode",
"min" : 0,
"max" : "*",
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/CS"
}
]
},
{
"id" : "Encounter.typeId",
"path" : "Encounter.typeId",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/II"
}
]
},
{
"id" : "Encounter.templateId",
"path" : "Encounter.templateId",
"definition" : "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question",
"min" : 0,
"max" : "*",
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/II"
}
]
},
{
"id" : "Encounter.id",
"path" : "Encounter.id",
"min" : 0,
"max" : "*",
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/II"
}
]
},
{
"id" : "Encounter.code",
"path" : "Encounter.code",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/CD"
}
],
"binding" : {
"strength" : "extensible",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-ActEncounterCode"
}
},
{
"id" : "Encounter.text",
"path" : "Encounter.text",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/ED"
}
]
},
{
"id" : "Encounter.statusCode",
"path" : "Encounter.statusCode",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/CS"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-ActStatus"
}
},
{
"id" : "Encounter.effectiveTime",
"path" : "Encounter.effectiveTime",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/IVL-TS"
}
]
},
{
"id" : "Encounter.dischargeDispositionCode",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace",
"valueUri" : "urn:hl7-org:sdtc"
}
],
"path" : "Encounter.dischargeDispositionCode",
"short" : "sdtc:dischargeDispositionCode",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/CE"
}
]
},
{
"id" : "Encounter.priorityCode",
"path" : "Encounter.priorityCode",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/CE"
}
],
"binding" : {
"strength" : "extensible",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-ActPriority"
}
},
{
"id" : "Encounter.subject",
"path" : "Encounter.subject",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "Element"
}
]
},
{
"id" : "Encounter.subject.typeCode",
"path" : "Encounter.subject.typeCode",
"representation" : [
"xmlAttr"
],
"min" : 1,
"max" : "1",
"type" : [
{
"code" : "code"
}
],
"defaultValueCode" : "SBJ",
"fixedCode" : "SBJ",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-ParticipationTargetSubject"
}
},
{
"id" : "Encounter.subject.contextControlCode",
"path" : "Encounter.subject.contextControlCode",
"representation" : [
"xmlAttr"
],
"min" : 1,
"max" : "1",
"type" : [
{
"code" : "code"
}
],
"defaultValueCode" : "OP",
"fixedCode" : "OP",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-ContextControl"
}
},
{
"id" : "Encounter.subject.awarenessCode",
"path" : "Encounter.subject.awarenessCode",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/CE"
}
],
"binding" : {
"strength" : "extensible",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-TargetAwareness"
}
},
{
"id" : "Encounter.subject.relatedSubject",
"path" : "Encounter.subject.relatedSubject",
"min" : 1,
"max" : "1",
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/RelatedSubject"
}
]
},
{
"id" : "Encounter.specimen",
"path" : "Encounter.specimen",
"min" : 0,
"max" : "*",
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/Specimen"
}
]
},
{
"id" : "Encounter.performer",
"path" : "Encounter.performer",
"min" : 0,
"max" : "*",
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/Performer2"
}
]
},
{
"id" : "Encounter.author",
"path" : "Encounter.author",
"min" : 0,
"max" : "*",
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/Author"
}
]
},
{
"id" : "Encounter.informant",
"path" : "Encounter.informant",
"min" : 0,
"max" : "*",
"type" : [
{
"code" : "Element"
}
]
},
{
"id" : "Encounter.informant.typeCode",
"path" : "Encounter.informant.typeCode",
"representation" : [
"xmlAttr"
],
"min" : 1,
"max" : "1",
"type" : [
{
"code" : "code"
}
],
"defaultValueCode" : "INF",
"fixedCode" : "INF",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-ParticipationInformationGenerator"
}
},
{
"id" : "Encounter.informant.contextControlCode",
"path" : "Encounter.informant.contextControlCode",
"representation" : [
"xmlAttr"
],
"min" : 1,
"max" : "1",
"type" : [
{
"code" : "code"
}
],
"defaultValueCode" : "OP",
"fixedCode" : "OP",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-ContextControl"
}
},
{
"id" : "Encounter.informant.assignedEntity",
"path" : "Encounter.informant.assignedEntity",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/AssignedEntity"
}
]
},
{
"id" : "Encounter.informant.relatedEntity",
"path" : "Encounter.informant.relatedEntity",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/RelatedEntity"
}
]
},
{
"id" : "Encounter.participant",
"path" : "Encounter.participant",
"min" : 0,
"max" : "*",
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/Participant2"
}
]
},
{
"id" : "Encounter.entryRelationship",
"path" : "Encounter.entryRelationship",
"min" : 0,
"max" : "*",
"type" : [
{
"code" : "Element"
}
],
"constraint" : [
{
"key" : "enc-er-1",
"severity" : "error",
"human" : "Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act",
"expression" : "(observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1"
}
]
},
{
"id" : "Encounter.entryRelationship.typeCode",
"path" : "Encounter.entryRelationship.typeCode",
"representation" : [
"xmlAttr"
],
"min" : 1,
"max" : "1",
"type" : [
{
"code" : "code"
}
]
},
{
"id" : "Encounter.entryRelationship.inversionInd",
"path" : "Encounter.entryRelationship.inversionInd",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "boolean"
}
]
},
{
"id" : "Encounter.entryRelationship.contextConductionInd",
"path" : "Encounter.entryRelationship.contextConductionInd",
"representation" : [
"xmlAttr"
],
"min" : 1,
"max" : "1",
"type" : [
{
"code" : "boolean"
}
],
"defaultValueBoolean" : true
},
{
"id" : "Encounter.entryRelationship.sequenceNumber",
"path" : "Encounter.entryRelationship.sequenceNumber",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/INT"
}
]
},
{
"id" : "Encounter.entryRelationship.negationInd",
"path" : "Encounter.entryRelationship.negationInd",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "boolean"
}
]
},
{
"id" : "Encounter.entryRelationship.seperatableInd",
"path" : "Encounter.entryRelationship.seperatableInd",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/BL"
}
]
},
{
"id" : "Encounter.entryRelationship.observation",
"path" : "Encounter.entryRelationship.observation",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/Observation"
}
]
},
{
"id" : "Encounter.entryRelationship.regionOfInterest",
"path" : "Encounter.entryRelationship.regionOfInterest",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest"
}
]
},
{
"id" : "Encounter.entryRelationship.observationMedia",
"path" : "Encounter.entryRelationship.observationMedia",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/ObservationMedia"
}
]
},
{
"id" : "Encounter.entryRelationship.substanceAdministration",
"path" : "Encounter.entryRelationship.substanceAdministration",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration"
}
]
},
{
"id" : "Encounter.entryRelationship.supply",
"path" : "Encounter.entryRelationship.supply",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/Supply"
}
]
},
{
"id" : "Encounter.entryRelationship.procedure",
"path" : "Encounter.entryRelationship.procedure",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/Procedure"
}
]
},
{
"id" : "Encounter.entryRelationship.encounter",
"path" : "Encounter.entryRelationship.encounter",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/Encounter"
}
]
},
{
"id" : "Encounter.entryRelationship.organizer",
"path" : "Encounter.entryRelationship.organizer",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/Organizer"
}
]
},
{
"id" : "Encounter.entryRelationship.act",
"path" : "Encounter.entryRelationship.act",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/Act"
}
]
},
{
"id" : "Encounter.reference",
"path" : "Encounter.reference",
"min" : 0,
"max" : "*",
"type" : [
{
"code" : "Element"
}
]
},
{
"id" : "Encounter.reference.typeCode",
"path" : "Encounter.reference.typeCode",
"representation" : [
"xmlAttr"
],
"min" : 1,
"max" : "1",
"type" : [
{
"code" : "code"
}
]
},
{
"id" : "Encounter.reference.seperatableInd",
"path" : "Encounter.reference.seperatableInd",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/BL"
}
]
},
{
"id" : "Encounter.reference.externalAct",
"path" : "Encounter.reference.externalAct",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/ExternalAct"
}
]
},
{
"id" : "Encounter.reference.externalObservation",
"path" : "Encounter.reference.externalObservation",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/ExternalObservation"
}
]
},
{
"id" : "Encounter.reference.externalProcedure",
"path" : "Encounter.reference.externalProcedure",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/ExternalProcedure"
}
]
},
{
"id" : "Encounter.reference.externalDocument",
"path" : "Encounter.reference.externalDocument",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/ExternalDocument"
}
]
},
{
"id" : "Encounter.precondition",
"path" : "Encounter.precondition",
"min" : 0,
"max" : "*",
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/Precondition"
}
]
}
]
}
}
IG © 2019+ Health Level 7. Package hl7.cda.uv.core#2.1.0-draft1 based on FHIR 5.0.0-snapshot3. Generated 2023-01-16
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change