Clinical Document Architecture V2.0.1
2.1.0 - CI Build

Clinical Document Architecture V2.0.1, published by Health Level 7. This is not an authorized publication; it is the continuous build for version 2.1.0). This version is based on the current content of https://github.com/HL7/cda-core-2.0/ and changes regularly. See the Directory of published versions

Logical Model: CDAR2.EncompassingEncounter - JSON Profile

JSON representation of the EncompassingEncounter logical model.

Raw json | Download


{
  "resourceType" : "StructureDefinition",
  "id" : "EncompassingEncounter",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n      <p>This optional class represents the setting of the clinical encounter during which the documented act(s) or ServiceEvent occurred. Documents are not necessarily generated during an encounter, such as when a clinician, in response to an abnormal lab result, attempts to contact the patient but can't, and writes a Progress Note.</p>\n      <p>In some cases, the setting of the encounter is inherent in the ClinicalDocument.code, such as where ClinicalDocument.code is &quot;Diabetes Clinic Progress Note&quot;. The setting of an encounter can also be transmitted in the HealthCareFacility.code attribute. If HealthCareFacility.code is sent, it should be equivalent to or further specialize the value inherent in the ClinicalDocument.code (such as where the ClinicalDocument.code is simply &quot;Clinic Progress Note&quot; and the value of HealthCareFacility.code is &quot;cardiology clinic&quot;), and shall not conflict with the value inherent in the ClinicalDocument.code, as such a conflict would constitute an ambiguous situation.</p>\n      <p>EncompassingEncounter.dischargeDispositionCode can be used to depict the disposition of the patient at the time of hospital discharge (e.g., discharged to home, expired, against medical advice, etc.).</p>\n    </div>"
  },
  "extension" : [
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace",
      "valueUri" : "urn:hl7-org:v3"
    }
  ],
  "url" : "http://hl7.org/fhir/cda/StructureDefinition/EncompassingEncounter",
  "version" : "2.1.0",
  "name" : "CDAR2.EncompassingEncounter",
  "title" : "EncompassingEncounter (CDA Class)",
  "status" : "active",
  "experimental" : false,
  "date" : "2021-04-15T20:51:17+00:00",
  "publisher" : "Health Level 7",
  "description" : "This optional class represents the setting of the clinical encounter during which the documented act(s) or ServiceEvent occurred. Documents are not necessarily generated during an encounter, such as when a clinician, in response to an abnormal lab result, attempts to contact the patient but can't, and writes a Progress Note.\nIn some cases, the setting of the encounter is inherent in the ClinicalDocument.code, such as where ClinicalDocument.code is \"Diabetes Clinic Progress Note\". The setting of an encounter can also be transmitted in the HealthCareFacility.code attribute. If HealthCareFacility.code is sent, it should be equivalent to or further specialize the value inherent in the ClinicalDocument.code (such as where the ClinicalDocument.code is simply \"Clinic Progress Note\" and the value of HealthCareFacility.code is \"cardiology clinic\"), and shall not conflict with the value inherent in the ClinicalDocument.code, as such a conflict would constitute an ambiguous situation.\nEncompassingEncounter.dischargeDispositionCode can be used to depict the disposition of the patient at the time of hospital discharge (e.g., discharged to home, expired, against medical advice, etc.).",
  "fhirVersion" : "4.0.1",
  "kind" : "logical",
  "abstract" : false,
  "type" : "EncompassingEncounter",
  "baseDefinition" : "http://hl7.org/fhir/StructureDefinition/Base",
  "derivation" : "specialization",
  "snapshot" : {
    "element" : [
      {
        "id" : "EncompassingEncounter",
        "path" : "EncompassingEncounter",
        "min" : 1,
        "max" : "1",
        "base" : {
          "path" : "Base",
          "min" : 0,
          "max" : "*"
        },
        "isModifier" : false
      },
      {
        "id" : "EncompassingEncounter.classCode",
        "path" : "EncompassingEncounter.classCode",
        "representation" : [
          "xmlAttr"
        ],
        "min" : 1,
        "max" : "1",
        "base" : {
          "path" : "EncompassingEncounter.classCode",
          "min" : 1,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "code"
          }
        ],
        "defaultValueCode" : "ENC",
        "fixedCode" : "ENC",
        "binding" : {
          "strength" : "required",
          "valueSet" : "http://terminology.hl7.org/ValueSet/v3-ActClass"
        }
      },
      {
        "id" : "EncompassingEncounter.moodCode",
        "path" : "EncompassingEncounter.moodCode",
        "representation" : [
          "xmlAttr"
        ],
        "min" : 1,
        "max" : "1",
        "base" : {
          "path" : "EncompassingEncounter.moodCode",
          "min" : 1,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "code"
          }
        ],
        "defaultValueCode" : "EVN",
        "fixedCode" : "EVN",
        "binding" : {
          "strength" : "required",
          "valueSet" : "http://terminology.hl7.org/ValueSet/v3-ActMood"
        }
      },
      {
        "id" : "EncompassingEncounter.templateId",
        "path" : "EncompassingEncounter.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" : "EncompassingEncounter.templateId",
          "min" : 0,
          "max" : "*"
        },
        "type" : [
          {
            "code" : "http://hl7.org/fhir/cda/StructureDefinition/II"
          }
        ]
      },
      {
        "id" : "EncompassingEncounter.id",
        "path" : "EncompassingEncounter.id",
        "min" : 0,
        "max" : "*",
        "base" : {
          "path" : "EncompassingEncounter.id",
          "min" : 0,
          "max" : "*"
        },
        "type" : [
          {
            "code" : "http://hl7.org/fhir/cda/StructureDefinition/II"
          }
        ]
      },
      {
        "id" : "EncompassingEncounter.code",
        "path" : "EncompassingEncounter.code",
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "EncompassingEncounter.code",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "http://hl7.org/fhir/cda/StructureDefinition/CE"
          }
        ],
        "binding" : {
          "strength" : "extensible",
          "valueSet" : "http://terminology.hl7.org/ValueSet/v3-ActEncounterCode"
        }
      },
      {
        "id" : "EncompassingEncounter.effectiveTime",
        "path" : "EncompassingEncounter.effectiveTime",
        "min" : 1,
        "max" : "1",
        "base" : {
          "path" : "EncompassingEncounter.effectiveTime",
          "min" : 1,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "http://hl7.org/fhir/cda/StructureDefinition/IVL-TS"
          }
        ]
      },
      {
        "id" : "EncompassingEncounter.admissionReferralSourceCode",
        "extension" : [
          {
            "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace",
            "valueUri" : "urn:hl7-org:sdtc"
          }
        ],
        "path" : "EncompassingEncounter.admissionReferralSourceCode",
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "EncompassingEncounter.admissionReferralSourceCode",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "http://hl7.org/fhir/cda/StructureDefinition/CE"
          }
        ]
      },
      {
        "id" : "EncompassingEncounter.dischargeDispositionCode",
        "path" : "EncompassingEncounter.dischargeDispositionCode",
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "EncompassingEncounter.dischargeDispositionCode",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "http://hl7.org/fhir/cda/StructureDefinition/CE"
          }
        ],
        "binding" : {
          "strength" : "extensible",
          "valueSet" : "http://terminology.hl7.org/ValueSet/v3-EncounterDischargeDisposition"
        }
      },
      {
        "id" : "EncompassingEncounter.responsibleParty",
        "path" : "EncompassingEncounter.responsibleParty",
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "EncompassingEncounter.responsibleParty",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "Element"
          }
        ]
      },
      {
        "id" : "EncompassingEncounter.responsibleParty.typeCode",
        "path" : "EncompassingEncounter.responsibleParty.typeCode",
        "representation" : [
          "xmlAttr"
        ],
        "min" : 1,
        "max" : "1",
        "base" : {
          "path" : "EncompassingEncounter.responsibleParty.typeCode",
          "min" : 1,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "code"
          }
        ],
        "defaultValueCode" : "RESP",
        "fixedCode" : "RESP",
        "binding" : {
          "strength" : "required",
          "valueSet" : "http://terminology.hl7.org/ValueSet/v3-ParticipationType"
        }
      },
      {
        "id" : "EncompassingEncounter.responsibleParty.assignedEntity",
        "path" : "EncompassingEncounter.responsibleParty.assignedEntity",
        "min" : 1,
        "max" : "1",
        "base" : {
          "path" : "EncompassingEncounter.responsibleParty.assignedEntity",
          "min" : 1,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "http://hl7.org/fhir/cda/StructureDefinition/AssignedEntity"
          }
        ]
      },
      {
        "id" : "EncompassingEncounter.encounterParticipant",
        "path" : "EncompassingEncounter.encounterParticipant",
        "min" : 0,
        "max" : "*",
        "base" : {
          "path" : "EncompassingEncounter.encounterParticipant",
          "min" : 0,
          "max" : "*"
        },
        "type" : [
          {
            "code" : "http://hl7.org/fhir/cda/StructureDefinition/EncounterParticipant"
          }
        ]
      },
      {
        "id" : "EncompassingEncounter.location",
        "path" : "EncompassingEncounter.location",
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "EncompassingEncounter.location",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "Element"
          }
        ]
      },
      {
        "id" : "EncompassingEncounter.location.typeCode",
        "path" : "EncompassingEncounter.location.typeCode",
        "representation" : [
          "xmlAttr"
        ],
        "min" : 1,
        "max" : "1",
        "base" : {
          "path" : "EncompassingEncounter.location.typeCode",
          "min" : 1,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "code"
          }
        ],
        "defaultValueCode" : "LOC",
        "fixedCode" : "LOC",
        "binding" : {
          "strength" : "required",
          "valueSet" : "http://terminology.hl7.org/ValueSet/v3-ParticipationTargetLocation"
        }
      },
      {
        "id" : "EncompassingEncounter.location.healthCareFacility",
        "path" : "EncompassingEncounter.location.healthCareFacility",
        "min" : 1,
        "max" : "1",
        "base" : {
          "path" : "EncompassingEncounter.location.healthCareFacility",
          "min" : 1,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "http://hl7.org/fhir/cda/StructureDefinition/HealthCareFacility"
          }
        ]
      }
    ]
  },
  "differential" : {
    "element" : [
      {
        "id" : "EncompassingEncounter",
        "path" : "EncompassingEncounter",
        "min" : 1,
        "max" : "1"
      },
      {
        "id" : "EncompassingEncounter.classCode",
        "path" : "EncompassingEncounter.classCode",
        "representation" : [
          "xmlAttr"
        ],
        "min" : 1,
        "max" : "1",
        "type" : [
          {
            "code" : "code"
          }
        ],
        "defaultValueCode" : "ENC",
        "fixedCode" : "ENC",
        "binding" : {
          "strength" : "required",
          "valueSet" : "http://terminology.hl7.org/ValueSet/v3-ActClass"
        }
      },
      {
        "id" : "EncompassingEncounter.moodCode",
        "path" : "EncompassingEncounter.moodCode",
        "representation" : [
          "xmlAttr"
        ],
        "min" : 1,
        "max" : "1",
        "type" : [
          {
            "code" : "code"
          }
        ],
        "defaultValueCode" : "EVN",
        "fixedCode" : "EVN",
        "binding" : {
          "strength" : "required",
          "valueSet" : "http://terminology.hl7.org/ValueSet/v3-ActMood"
        }
      },
      {
        "id" : "EncompassingEncounter.templateId",
        "path" : "EncompassingEncounter.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" : "EncompassingEncounter.id",
        "path" : "EncompassingEncounter.id",
        "min" : 0,
        "max" : "*",
        "type" : [
          {
            "code" : "http://hl7.org/fhir/cda/StructureDefinition/II"
          }
        ]
      },
      {
        "id" : "EncompassingEncounter.code",
        "path" : "EncompassingEncounter.code",
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "http://hl7.org/fhir/cda/StructureDefinition/CE"
          }
        ],
        "binding" : {
          "strength" : "extensible",
          "valueSet" : "http://terminology.hl7.org/ValueSet/v3-ActEncounterCode"
        }
      },
      {
        "id" : "EncompassingEncounter.effectiveTime",
        "path" : "EncompassingEncounter.effectiveTime",
        "min" : 1,
        "max" : "1",
        "type" : [
          {
            "code" : "http://hl7.org/fhir/cda/StructureDefinition/IVL-TS"
          }
        ]
      },
      {
        "id" : "EncompassingEncounter.admissionReferralSourceCode",
        "extension" : [
          {
            "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace",
            "valueUri" : "urn:hl7-org:sdtc"
          }
        ],
        "path" : "EncompassingEncounter.admissionReferralSourceCode",
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "http://hl7.org/fhir/cda/StructureDefinition/CE"
          }
        ]
      },
      {
        "id" : "EncompassingEncounter.dischargeDispositionCode",
        "path" : "EncompassingEncounter.dischargeDispositionCode",
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "http://hl7.org/fhir/cda/StructureDefinition/CE"
          }
        ],
        "binding" : {
          "strength" : "extensible",
          "valueSet" : "http://terminology.hl7.org/ValueSet/v3-EncounterDischargeDisposition"
        }
      },
      {
        "id" : "EncompassingEncounter.responsibleParty",
        "path" : "EncompassingEncounter.responsibleParty",
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "Element"
          }
        ]
      },
      {
        "id" : "EncompassingEncounter.responsibleParty.typeCode",
        "path" : "EncompassingEncounter.responsibleParty.typeCode",
        "representation" : [
          "xmlAttr"
        ],
        "min" : 1,
        "max" : "1",
        "type" : [
          {
            "code" : "code"
          }
        ],
        "defaultValueCode" : "RESP",
        "fixedCode" : "RESP",
        "binding" : {
          "strength" : "required",
          "valueSet" : "http://terminology.hl7.org/ValueSet/v3-ParticipationType"
        }
      },
      {
        "id" : "EncompassingEncounter.responsibleParty.assignedEntity",
        "path" : "EncompassingEncounter.responsibleParty.assignedEntity",
        "min" : 1,
        "max" : "1",
        "type" : [
          {
            "code" : "http://hl7.org/fhir/cda/StructureDefinition/AssignedEntity"
          }
        ]
      },
      {
        "id" : "EncompassingEncounter.encounterParticipant",
        "path" : "EncompassingEncounter.encounterParticipant",
        "min" : 0,
        "max" : "*",
        "type" : [
          {
            "code" : "http://hl7.org/fhir/cda/StructureDefinition/EncounterParticipant"
          }
        ]
      },
      {
        "id" : "EncompassingEncounter.location",
        "path" : "EncompassingEncounter.location",
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "Element"
          }
        ]
      },
      {
        "id" : "EncompassingEncounter.location.typeCode",
        "path" : "EncompassingEncounter.location.typeCode",
        "representation" : [
          "xmlAttr"
        ],
        "min" : 1,
        "max" : "1",
        "type" : [
          {
            "code" : "code"
          }
        ],
        "defaultValueCode" : "LOC",
        "fixedCode" : "LOC",
        "binding" : {
          "strength" : "required",
          "valueSet" : "http://terminology.hl7.org/ValueSet/v3-ParticipationTargetLocation"
        }
      },
      {
        "id" : "EncompassingEncounter.location.healthCareFacility",
        "path" : "EncompassingEncounter.location.healthCareFacility",
        "min" : 1,
        "max" : "1",
        "type" : [
          {
            "code" : "http://hl7.org/fhir/cda/StructureDefinition/HealthCareFacility"
          }
        ]
      }
    ]
  }
}