FHIR IG Statistics: StructureDefinition/cyehr-sd-encounter-r4

Resources that use this resource

Resources that this resource uses

Narrative

No narrative content found in resource

Source

{
  "resourceType": "StructureDefinition",
  "id": "cyehr-sd-encounter-r4",
  "url": "http://ig.ehealth4u.eu/fhir/StructureDefinition/cyehr-sd-encounter-r4",
  "name": "CYEHRSDEncounter",
  "title": "Cyprus EHR Encounter profile",
  "status": "draft",
  "publisher": "eHealth4U",
  "contact": [
    {
      "name": "eHealth Lab (University of Cyprus)",
      "telecom": [
        {
          "system": "email",
          "value": "ehealthl@ucy.ac.cy",
          "use": "work"
        }
      ]
    }
  ],
  "description": "This profile represents the outpatient visit based on the requirements of the national EHR system of Cyprus. The input of a new entry or the update of an existing entry shall be done only in the context of an encounter. Therefore, all EHR data shall reference a specific encounter in which they were first created or updated.",
  "fhirVersion": "4.0.1",
  "kind": "resource",
  "abstract": false,
  "type": "Encounter",
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Encounter",
  "derivation": "constraint",
  "differential": {
    "element": [
      {
        "id": "Encounter.meta",
        "path": "Encounter.meta"
      },
      {
        "id": "Encounter.meta.profile",
        "path": "Encounter.meta.profile",
        "slicing": {
          "discriminator": [
            {
              "type": "value",
              "path": "$this"
            }
          ],
          "rules": "open"
        },
        "min": 1
      },
      {
        "id": "Encounter.meta.profile:CyprusEHRProfile",
        "path": "Encounter.meta.profile",
        "sliceName": "CyprusEHRProfile",
        "min": 1,
        "max": "1",
        "fixedCanonical": "http://ig.ehealth4u.eu/fhir/StructureDefinition/cyehr-sd-encounter-r4"
      },
      {
        "id": "Encounter.identifier.type",
        "path": "Encounter.identifier.type",
        "type": [
          {
            "code": "CodeableConcept",
            "profile": [
              "http://hl7.org/fhir/uv/ips/StructureDefinition/CodeableConcept-uv-ips"
            ]
          }
        ]
      },
      {
        "id": "Encounter.identifier.type.coding.system",
        "path": "Encounter.identifier.type.coding.system",
        "min": 1
      },
      {
        "id": "Encounter.identifier.type.coding.code",
        "path": "Encounter.identifier.type.coding.code",
        "min": 1
      },
      {
        "id": "Encounter.identifier.type.coding.display",
        "path": "Encounter.identifier.type.coding.display",
        "min": 1
      },
      {
        "id": "Encounter.status",
        "path": "Encounter.status",
        "comment": "Note that internal business rules will determine the appropriate transitions that may occur between statuses (and also classes).\r\n\r\n CyprusEHR: Use only | in-progress | finished | entered-in-error"
      },
      {
        "id": "Encounter.statusHistory",
        "path": "Encounter.statusHistory",
        "comment": "The current status is always found in the current version of the resource, not the status history.\r\n\r\nCyprusEHR: Not to be used in the context of Cyprus EHR."
      },
      {
        "id": "Encounter.class",
        "path": "Encounter.class",
        "comment": "Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information.\r\n\r\n\r\nCyprusEHR: For eHealth4U we will only use \"ambulatory\" (i.e. outpatient).",
        "patternCoding": {
          "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
          "code": "AMB"
        }
      },
      {
        "id": "Encounter.class.system",
        "path": "Encounter.class.system",
        "min": 1
      },
      {
        "id": "Encounter.class.code",
        "path": "Encounter.class.code",
        "min": 1
      },
      {
        "id": "Encounter.class.display",
        "path": "Encounter.class.display",
        "min": 1
      },
      {
        "id": "Encounter.classHistory",
        "path": "Encounter.classHistory",
        "comment": "CyprusEHR: Not to be used in the context of Cyprus EHR."
      },
      {
        "id": "Encounter.type",
        "path": "Encounter.type",
        "comment": "Since there are many ways to further classify encounters, this element is 0..*.\r\n\r\n\r\nCyprusEHR: Not to be used in the context of Cyprus EHR."
      },
      {
        "id": "Encounter.serviceType",
        "path": "Encounter.serviceType",
        "comment": "Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.\r\n\r\n\r\nCyprusEHR: Not to be used in the context of Cyprus EHR."
      },
      {
        "id": "Encounter.priority",
        "path": "Encounter.priority",
        "comment": "Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.\r\n\r\nCyprusEHR: Not to be used in the context of Cyprus EHR."
      },
      {
        "id": "Encounter.subject",
        "path": "Encounter.subject",
        "min": 1,
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://hl7.org/fhir/StructureDefinition/Patient",
              "http://hl7.org/fhir/StructureDefinition/Group",
              "http://ig.ehealth4u.eu/fhir/StructureDefinition/cyehr-sd-patient"
            ]
          }
        ],
        "mustSupport": true
      },
      {
        "id": "Encounter.subject.identifier.type",
        "path": "Encounter.subject.identifier.type",
        "type": [
          {
            "code": "CodeableConcept",
            "profile": [
              "http://hl7.org/fhir/uv/ips/StructureDefinition/CodeableConcept-uv-ips"
            ]
          }
        ]
      },
      {
        "id": "Encounter.subject.identifier.type.coding.system",
        "path": "Encounter.subject.identifier.type.coding.system",
        "min": 1
      },
      {
        "id": "Encounter.subject.identifier.type.coding.code",
        "path": "Encounter.subject.identifier.type.coding.code",
        "min": 1
      },
      {
        "id": "Encounter.subject.identifier.type.coding.display",
        "path": "Encounter.subject.identifier.type.coding.display",
        "min": 1
      },
      {
        "id": "Encounter.episodeOfCare",
        "path": "Encounter.episodeOfCare",
        "min": 1,
        "max": "1",
        "mustSupport": true
      },
      {
        "id": "Encounter.episodeOfCare.identifier.type",
        "path": "Encounter.episodeOfCare.identifier.type",
        "type": [
          {
            "code": "CodeableConcept",
            "profile": [
              "http://hl7.org/fhir/uv/ips/StructureDefinition/CodeableConcept-uv-ips"
            ]
          }
        ]
      },
      {
        "id": "Encounter.episodeOfCare.identifier.type.coding.system",
        "path": "Encounter.episodeOfCare.identifier.type.coding.system",
        "min": 1
      },
      {
        "id": "Encounter.episodeOfCare.identifier.type.coding.code",
        "path": "Encounter.episodeOfCare.identifier.type.coding.code",
        "min": 1
      },
      {
        "id": "Encounter.episodeOfCare.identifier.type.coding.display",
        "path": "Encounter.episodeOfCare.identifier.type.coding.display",
        "min": 1
      },
      {
        "id": "Encounter.basedOn",
        "path": "Encounter.basedOn",
        "comment": "References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.\r\n\r\n\r\nCyprusEHR: Will be needed when the encounter is created based on a referral."
      },
      {
        "id": "Encounter.basedOn.identifier.type",
        "path": "Encounter.basedOn.identifier.type",
        "type": [
          {
            "code": "CodeableConcept",
            "profile": [
              "http://hl7.org/fhir/uv/ips/StructureDefinition/CodeableConcept-uv-ips"
            ]
          }
        ]
      },
      {
        "id": "Encounter.basedOn.identifier.type.coding.system",
        "path": "Encounter.basedOn.identifier.type.coding.system",
        "min": 1
      },
      {
        "id": "Encounter.basedOn.identifier.type.coding.code",
        "path": "Encounter.basedOn.identifier.type.coding.code",
        "min": 1
      },
      {
        "id": "Encounter.basedOn.identifier.type.coding.display",
        "path": "Encounter.basedOn.identifier.type.coding.display",
        "min": 1
      },
      {
        "id": "Encounter.participant",
        "path": "Encounter.participant",
        "comment": "CyprusEHR: Use individual element --> practitioner role (see comment on individual element).",
        "mustSupport": true
      },
      {
        "id": "Encounter.participant.type",
        "path": "Encounter.participant.type",
        "type": [
          {
            "code": "CodeableConcept",
            "profile": [
              "http://hl7.org/fhir/uv/ips/StructureDefinition/CodeableConcept-uv-ips"
            ]
          }
        ]
      },
      {
        "id": "Encounter.participant.type.coding.system",
        "path": "Encounter.participant.type.coding.system",
        "min": 1
      },
      {
        "id": "Encounter.participant.type.coding.code",
        "path": "Encounter.participant.type.coding.code",
        "min": 1
      },
      {
        "id": "Encounter.participant.type.coding.display",
        "path": "Encounter.participant.type.coding.display",
        "min": 1
      },
      {
        "id": "Encounter.participant.individual",
        "path": "Encounter.participant.individual",
        "comment": "References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.\r\n\r\n\r\nCyprusEHR: For eHealth4U use \"primary performer\"."
      },
      {
        "id": "Encounter.participant.individual.identifier.type",
        "path": "Encounter.participant.individual.identifier.type",
        "type": [
          {
            "code": "CodeableConcept",
            "profile": [
              "http://hl7.org/fhir/uv/ips/StructureDefinition/CodeableConcept-uv-ips"
            ]
          }
        ]
      },
      {
        "id": "Encounter.participant.individual.identifier.type.coding.system",
        "path": "Encounter.participant.individual.identifier.type.coding.system",
        "min": 1
      },
      {
        "id": "Encounter.participant.individual.identifier.type.coding.code",
        "path": "Encounter.participant.individual.identifier.type.coding.code",
        "min": 1
      },
      {
        "id": "Encounter.participant.individual.identifier.type.coding.display",
        "path": "Encounter.participant.individual.identifier.type.coding.display",
        "min": 1
      },
      {
        "id": "Encounter.appointment",
        "path": "Encounter.appointment",
        "comment": "References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.\r\n\r\n\r\nCyprusEHR: Not to be used in the context of Cyprus EHR."
      },
      {
        "id": "Encounter.length",
        "path": "Encounter.length",
        "comment": "May differ from the time the Encounter.period lasted because of leave of absence.\r\n\r\nCyprusEHR: Not to be used in the context of Cyprus EHR."
      },
      {
        "id": "Encounter.reasonCode",
        "path": "Encounter.reasonCode",
        "comment": "For systems that need to know which was the primary diagnosis, these will be marked with the standard extension primaryDiagnosis (which is a sequence value rather than a flag, 1 = primary diagnosis).\r\n\r\n\r\nCyprusEHR: Not to be used in the context of Cyprus EHR."
      },
      {
        "id": "Encounter.reasonReference",
        "path": "Encounter.reasonReference",
        "comment": "For systems that need to know which was the primary diagnosis, these will be marked with the standard extension primaryDiagnosis (which is a sequence value rather than a flag, 1 = primary diagnosis).\r\n\r\n\r\nCyprusEHR: Admission cause:\r\n\r\n- The doctor will be able to choose an existing procedure or observation result or a problem from the respective profiles.\r\n- The doctor will be able to create a new problem using the value sets from code element.\r\n- Any additional note (free text) will be added to the respective profile.note.",
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://hl7.org/fhir/StructureDefinition/Condition",
              "http://hl7.org/fhir/StructureDefinition/Procedure",
              "http://hl7.org/fhir/StructureDefinition/Observation",
              "http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation",
              "http://ig.ehealth4u.eu/fhir/StructureDefinition/cyehr-sd-problem-r4",
              "http://ig.ehealth4u.eu/fhir/StructureDefinition/cyehr-sd-procedure-r4",
              "http://ig.ehealth4u.eu/fhir/StructureDefinition/cyehr-sd-observationresults"
            ]
          }
        ],
        "mustSupport": true
      },
      {
        "id": "Encounter.reasonReference.reference",
        "path": "Encounter.reasonReference.reference",
        "min": 1
      },
      {
        "id": "Encounter.reasonReference.identifier.type",
        "path": "Encounter.reasonReference.identifier.type",
        "type": [
          {
            "code": "CodeableConcept",
            "profile": [
              "http://hl7.org/fhir/uv/ips/StructureDefinition/CodeableConcept-uv-ips"
            ]
          }
        ]
      },
      {
        "id": "Encounter.reasonReference.identifier.type.coding.system",
        "path": "Encounter.reasonReference.identifier.type.coding.system",
        "min": 1
      },
      {
        "id": "Encounter.reasonReference.identifier.type.coding.code",
        "path": "Encounter.reasonReference.identifier.type.coding.code",
        "min": 1
      },
      {
        "id": "Encounter.reasonReference.identifier.type.coding.display",
        "path": "Encounter.reasonReference.identifier.type.coding.display",
        "min": 1
      },
      {
        "id": "Encounter.diagnosis",
        "path": "Encounter.diagnosis",
        "slicing": {
          "discriminator": [
            {
              "type": "pattern",
              "path": "use"
            }
          ],
          "rules": "open"
        },
        "mustSupport": true
      },
      {
        "id": "Encounter.diagnosis.condition",
        "path": "Encounter.diagnosis.condition",
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://hl7.org/fhir/StructureDefinition/Condition",
              "http://hl7.org/fhir/StructureDefinition/Procedure",
              "http://ig.ehealth4u.eu/fhir/StructureDefinition/cyehr-sd-diagnosis-r4"
            ]
          }
        ]
      },
      {
        "id": "Encounter.diagnosis.condition.reference",
        "path": "Encounter.diagnosis.condition.reference",
        "min": 1
      },
      {
        "id": "Encounter.diagnosis.rank",
        "path": "Encounter.diagnosis.rank",
        "comment": "32 bit number; for values larger than this, use decimal\r\n\r\nCyprusEHR: Not to be used in the context of Cyprus EHR."
      },
      {
        "id": "Encounter.diagnosis:diagnosedProblem",
        "path": "Encounter.diagnosis",
        "sliceName": "diagnosedProblem",
        "mustSupport": true
      },
      {
        "id": "Encounter.diagnosis:diagnosedProblem.use",
        "path": "Encounter.diagnosis.use",
        "comment": "Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.\r\n\r\nCyprusEHR: An official diagnosis that is created in the context of an encounter as part of the \"First Impression\" section.",
        "min": 1,
        "patternCodeableConcept": {
          "coding": [
            {
              "system": "http://terminology.hl7.org/CodeSystem/diagnosis-role",
              "code": "DD"
            }
          ]
        }
      },
      {
        "id": "Encounter.diagnosis:differentialDiagnosis",
        "path": "Encounter.diagnosis",
        "sliceName": "differentialDiagnosis",
        "mustSupport": true
      },
      {
        "id": "Encounter.diagnosis:differentialDiagnosis.use",
        "path": "Encounter.diagnosis.use",
        "comment": "Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.\r\n\r\nCyprusEHR: Use this role when recoring differential diagnosis as part of an encounter as recorded in the \"First Impression\" section.",
        "min": 1,
        "patternCodeableConcept": {
          "coding": [
            {
              "system": "http://terminology.hl7.org/CodeSystem/ex-diagnosistype",
              "code": "differential"
            }
          ]
        }
      },
      {
        "id": "Encounter.account",
        "path": "Encounter.account",
        "comment": "The billing system may choose to allocate billable items associated with the Encounter to different referenced Accounts based on internal business rules.\r\n\r\nCyprusEHR: Not to be used in the context of Cyprus EHR."
      },
      {
        "id": "Encounter.hospitalization",
        "path": "Encounter.hospitalization",
        "comment": "An Encounter may cover more than just the inpatient stay. Contexts such as outpatients, community clinics, and aged care facilities are also included.\r\rThe duration recorded in the period of this encounter covers the entire scope of this hospitalization record.\r\n\r\n\r\nCyprusEHR: Not to be used in the context of Cyprus EHR."
      },
      {
        "id": "Encounter.location",
        "path": "Encounter.location",
        "mustSupport": true
      },
      {
        "id": "Encounter.location.location",
        "path": "Encounter.location.location",
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://hl7.org/fhir/StructureDefinition/Location",
              "http://ig.ehealth4u.eu/fhir/StructureDefinition/cyehr-sd-location-r4"
            ]
          }
        ]
      },
      {
        "id": "Encounter.location.location.identifier.type",
        "path": "Encounter.location.location.identifier.type",
        "type": [
          {
            "code": "CodeableConcept",
            "profile": [
              "http://hl7.org/fhir/uv/ips/StructureDefinition/CodeableConcept-uv-ips"
            ]
          }
        ]
      },
      {
        "id": "Encounter.location.location.identifier.type.coding.system",
        "path": "Encounter.location.location.identifier.type.coding.system",
        "min": 1
      },
      {
        "id": "Encounter.location.location.identifier.type.coding.code",
        "path": "Encounter.location.location.identifier.type.coding.code",
        "min": 1
      },
      {
        "id": "Encounter.location.location.identifier.type.coding.display",
        "path": "Encounter.location.location.identifier.type.coding.display",
        "min": 1
      },
      {
        "id": "Encounter.location.status",
        "path": "Encounter.location.status",
        "comment": "When the patient is no longer active at a location, then the period end date is entered, and the status may be changed to completed.\r\n\r\nCyprusEHR: Not to be used in the context of Cyprus EHR."
      },
      {
        "id": "Encounter.location.physicalType",
        "path": "Encounter.location.physicalType",
        "comment": "This information is de-normalized from the Location resource to support the easier understanding of the encounter resource and processing in messaging or query.\n\nThere may be many levels in the hierachy, and this may only pic specific levels that are required for a specific usage scenario.\r\n\r\nCyprusEHR: Not to be used in the context of Cyprus EHR."
      },
      {
        "id": "Encounter.location.period",
        "path": "Encounter.location.period",
        "comment": "A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. \"the patient was an inpatient of the hospital for this time range\") or one value from the range applies (e.g. \"give to the patient between these two times\").\n\nPeriod is not used for a duration (a measure of elapsed time). See [Duration](datatypes.html#Duration).\r\n\r\n\r\nCyprusEHR: Not to be used in the context of Cyprus EHR."
      },
      {
        "id": "Encounter.serviceProvider",
        "path": "Encounter.serviceProvider",
        "comment": "References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.\r\n\r\nCyprusEHR: Not to be used in the context of Cyprus EHR."
      },
      {
        "id": "Encounter.partOf",
        "path": "Encounter.partOf",
        "comment": "This is also used for associating a child's encounter back to the mother's encounter.\r\rRefer to the Notes section in the Patient resource for further details.\r\n\r\nCyprusEHR: Not to be used in the context of Cyprus EHR."
      }
    ]
  }
}