FHIR IG Statistics: StructureDefinition/HdBe-Encounter

Resources that use this resource

Resources that this resource uses

Narrative

No narrative content found in resource

Source

{
  "resourceType": "StructureDefinition",
  "id": "HdBe-Encounter",
  "url": "https://fhir.healthdata.be/StructureDefinition/HdBe-Encounter",
  "name": "HdBeEncounter",
  "title": "HdBe-Encounter",
  "status": "draft",
  "date": "2022-10-17T09:09:13.9562003+00:00",
  "publisher": "Healthdata.be (Sciensano)",
  "contact": [
    {
      "name": "Service portal – healthdata.be",
      "telecom": [
        {
          "system": "url",
          "value": "https://sciensano.service-now.com/sp",
          "use": "work"
        }
      ]
    }
  ],
  "description": "A contact is any interaction, regardless of the situation, between a patient and the healthcare professional, in which the healthcare professional has primary responsibility for diagnosing, evaluating and treating the patient’s condition and informing the patient. These can be visits, appointments or non face-to-face interactions.\r\n\r\nContacts can be visits to the general practitioner or other practices, home visits, admissions (in hospitals, nursing homes or care homes, psychiatric institutions or convalescent homes) or other relevant contacts. This includes past and future contacts.",
  "copyright": "Copyright and related rights waived via CC0, https://creativecommons.org/publicdomain/zero/1.0/. This does not apply to information from third parties, for example a medical terminology system. The implementer alone is responsible for identifying and obtaining any necessary licenses or authorizations to utilize third party IP in connection with the specification or otherwise.",
  "fhirVersion": "4.0.1",
  "mapping": [
    {
      "identity": "HdBe-Encounter",
      "uri": "https://fhir.healthdata.be/StructureDefinition/LogicalModel/HdBe-Encounter",
      "name": "HdBe logical model Encounter"
    },
    {
      "identity": "zib-encounter-v4.0.1-2020EN",
      "uri": "https://zibs.nl/wiki/Encounter-v4.0.1(2020EN)",
      "name": "zib Encounter-v4.0.1(2020EN)"
    },
    {
      "identity": "HdBe-HealthProfessional",
      "uri": "https://fhir.healthdata.be/StructureDefinition/LogicalModel/HdBe-HealthProfessional",
      "name": "HdBe logical model HealthProfessional"
    },
    {
      "identity": "zib-healthprofessional-v3.5-2020EN",
      "uri": "https://zibs.nl/wiki/HealthProfessional-v3.5(2020EN)",
      "name": "zib HealthProfessional-v3.5(2020EN)"
    }
  ],
  "kind": "resource",
  "abstract": false,
  "type": "Encounter",
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Encounter",
  "derivation": "constraint",
  "differential": {
    "element": [
      {
        "id": "Encounter",
        "path": "Encounter",
        "short": "Encounter",
        "alias": [
          "Contact"
        ],
        "mapping": [
          {
            "identity": "zib-encounter-v4.0.1-2020EN",
            "map": "NL-CM:15.1.1",
            "comment": "Encounter"
          },
          {
            "identity": "HdBe-Encounter",
            "map": "Encounter"
          }
        ]
      },
      {
        "id": "Encounter.status",
        "path": "Encounter.status",
        "comment": "This element is implictly mapped to the concepts StartDateTime and EndDateTime. Unless the status is explicitly recorded, the following guidance applies:\r\n\r\n* When StartDateTime is in the future, `.status` will usually be set to _planned_.\r\n* When StartDateTime is in the past and EndDateTime is present and in the future, `.status` will usually be set to _in-progress_.\r\n* When EndDateTime is present and in the past, `.status` will usually be set to _finished_.\r\n* When EndDateTime is not present, this means it was a point-in-time encounter and `.status` will usually be set to _finished_.\r\n* When a system is unable to infer the status from the StartDateTime and EndDateTime, `.status` will be set to _unknown_.\r\n\r\nThe _unknown_ code is not to be used to convey other statuses.  The _unknown_ code should be used when one of the statuses applies, but the authoring system doesn't know the current state of the procedure.\n\nThis element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.",
        "mapping": [
          {
            "identity": "zib-encounter-v4.0.1-2020EN",
            "map": "NL-CM:15.1.3",
            "comment": "StartDateTime (implicit, main mapping is on `Encounter.period`)"
          },
          {
            "identity": "HdBe-Encounter",
            "map": "Encounter.StartDateTime",
            "comment": "implicit, main mapping is on `Encounter.period`"
          },
          {
            "identity": "zib-encounter-v4.0.1-2020EN",
            "map": "NL-CM:15.1.4",
            "comment": "EndDateTime (implicit, main mapping is on `Encounter.period`)"
          },
          {
            "identity": "HdBe-Encounter",
            "map": "Encounter.EndDateTime",
            "comment": "implicit, main mapping is on `Encounter.period`"
          }
        ]
      },
      {
        "id": "Encounter.class",
        "path": "Encounter.class",
        "short": "ContactType",
        "definition": "The type of contact.",
        "alias": [
          "ContactType"
        ],
        "binding": {
          "strength": "extensible",
          "description": "Use ConceptMap ContactType-to-ActEncounterCode to translate CBB terminology from the functional model to profile terminology in ValueSet ActEncounterCode.",
          "valueSet": "http://terminology.hl7.org/ValueSet/v3-ActEncounterCode",
          "_valueSet": {
            "extension": [
              {
                "url": "http://hl7.org/fhir/StructureDefinition/11179-permitted-value-conceptmap",
                "valueCanonical": "https://fhir.healthdata.be/ConceptMap/ContactType-to-ActEncounterCode"
              }
            ]
          }
        },
        "mapping": [
          {
            "identity": "zib-encounter-v4.0.1-2020EN",
            "map": "NL-CM:15.1.2",
            "comment": "ContactType"
          },
          {
            "identity": "HdBe-Encounter",
            "map": "Encounter.ContactType"
          }
        ]
      },
      {
        "id": "Encounter.subject",
        "path": "Encounter.subject",
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://hl7.org/fhir/StructureDefinition/Patient",
              "http://hl7.org/fhir/StructureDefinition/Group",
              "https://fhir.healthdata.be/StructureDefinition/HdBe-Patient"
            ]
          }
        ]
      },
      {
        "id": "Encounter.participant",
        "path": "Encounter.participant",
        "slicing": {
          "discriminator": [
            {
              "type": "profile",
              "path": "individual.resolve()"
            }
          ],
          "rules": "open"
        }
      },
      {
        "id": "Encounter.participant:healthProfessional",
        "path": "Encounter.participant",
        "sliceName": "healthProfessional"
      },
      {
        "id": "Encounter.participant:healthProfessional.type",
        "path": "Encounter.participant.type",
        "short": "HealthProfessionalRole",
        "definition": "The role the health professional fulfils in the healthcare process. For health professionals, this could be for example attender, referrer or performer.",
        "alias": [
          "ZorgverlenerRol"
        ],
        "max": "1",
        "binding": {
          "strength": "extensible",
          "valueSet": "https://fhir.healthdata.be/ValueSet/HealthProfessionalRole"
        },
        "mapping": [
          {
            "identity": "zib-healthprofessional-v3.5-2020EN",
            "map": "NL-CM:17.1.5",
            "comment": "HealthProfessionalRole"
          },
          {
            "identity": "HdBe-HealthProfessional",
            "map": "HealthProfessional.HealthProfessionalRole"
          }
        ]
      },
      {
        "id": "Encounter.participant:healthProfessional.individual",
        "path": "Encounter.participant.individual",
        "short": "ContactWith",
        "definition": "The health professional with whom the contact took or will take place. The specialty and role of the health professional can be entered in the HealthProfessional information model.",
        "alias": [
          "ContactMet"
        ],
        "type": [
          {
            "code": "Reference",
            "profile": [
              "https://fhir.healthdata.be/StructureDefinition/pattern-HealthProfessionalReference"
            ],
            "targetProfile": [
              "http://hl7.org/fhir/StructureDefinition/Practitioner",
              "http://hl7.org/fhir/StructureDefinition/PractitionerRole",
              "http://hl7.org/fhir/StructureDefinition/RelatedPerson",
              "https://fhir.healthdata.be/StructureDefinition/HdBe-HealthProfessional-PractitionerRole"
            ]
          }
        ],
        "mapping": [
          {
            "identity": "zib-encounter-v4.0.1-2020EN",
            "map": "NL-CM:15.1.7",
            "comment": "ContactWith"
          },
          {
            "identity": "HdBe-Encounter",
            "map": "Encounter.ContactWith"
          }
        ]
      },
      {
        "id": "Encounter.period",
        "path": "Encounter.period",
        "comment": "If only a single point in time is known for the encounter rather than a period, both `period.start` and `period.end` are populated with this value (populating just `period.start` would indicate an ongoing period)."
      },
      {
        "id": "Encounter.period.start",
        "path": "Encounter.period.start",
        "short": "StartDateTime",
        "definition": "The date and time at which the contact took or will take place.",
        "alias": [
          "BeginDatumTijd"
        ],
        "mapping": [
          {
            "identity": "zib-encounter-v4.0.1-2020EN",
            "map": "NL-CM:15.1.3",
            "comment": "StartDateTime"
          },
          {
            "identity": "HdBe-Encounter",
            "map": "Encounter.StartDateTime"
          }
        ]
      },
      {
        "id": "Encounter.period.end",
        "path": "Encounter.period.end",
        "short": "EndDateTime",
        "definition": "The date and time at which the contact ended or will end. If the contact takes place over a period of time, this indicates the end of the period, in the case of an admission, for example.",
        "alias": [
          "EindDatumTijd"
        ],
        "mapping": [
          {
            "identity": "zib-encounter-v4.0.1-2020EN",
            "map": "NL-CM:15.1.4",
            "comment": "EndDateTime"
          },
          {
            "identity": "HdBe-Encounter",
            "map": "Encounter.EndDateTime"
          }
        ]
      },
      {
        "id": "Encounter.reasonCode",
        "path": "Encounter.reasonCode",
        "slicing": {
          "discriminator": [
            {
              "type": "exists",
              "path": "coding"
            }
          ],
          "rules": "open"
        }
      },
      {
        "id": "Encounter.reasonCode:deviatingResult",
        "path": "Encounter.reasonCode",
        "sliceName": "deviatingResult"
      },
      {
        "id": "Encounter.reasonCode:deviatingResult.extension:commentContactReason",
        "path": "Encounter.reasonCode.extension",
        "sliceName": "commentContactReason",
        "max": "1",
        "type": [
          {
            "code": "Extension",
            "profile": [
              "https://fhir.healthdata.be/StructureDefinition/ext-AnatomicalLocation.Laterality"
            ]
          }
        ],
        "isModifier": false
      },
      {
        "id": "Encounter.reasonCode:deviatingResult.extension:commentContactReason.value[x]",
        "path": "Encounter.reasonCode.extension.value[x]",
        "short": "CommentContactReason",
        "definition": "Explanation of the reason for the contact",
        "alias": [
          "ToelichtingRedenContact"
        ],
        "mapping": [
          {
            "identity": "HdBe-Encounter",
            "map": "NL-CM:15.1.17",
            "comment": "CommentContactReason"
          }
        ]
      },
      {
        "id": "Encounter.reasonCode:deviatingResult.coding",
        "path": "Encounter.reasonCode.coding",
        "max": "0"
      },
      {
        "id": "Encounter.reasonCode:deviatingResult.text",
        "path": "Encounter.reasonCode.text",
        "short": "DeviatingResult",
        "definition": "A deviating result or other textual explanation which serves as the reason for the contact.",
        "comment": "Note that this definition is wider than the zib concept DeviatingResult (NL-CM:15.1.12); although the zib concept deals only with deviating results as reason for the encounter, this element could be populated with _any_ reason for the encounter, including but not limited to deviating results. Implementers should be aware of the usage context of this profile to understand if this element is limited to a deviating result.",
        "alias": [
          "AfwijkendeUitslag"
        ],
        "mapping": [
          {
            "identity": "HdBe-Encounter",
            "map": "NL-CM:15.1.12",
            "comment": "DeviatingResult"
          }
        ]
      },
      {
        "id": "Encounter.reasonReference",
        "path": "Encounter.reasonReference",
        "slicing": {
          "discriminator": [
            {
              "type": "profile",
              "path": "resolve()"
            }
          ],
          "rules": "open"
        }
      },
      {
        "id": "Encounter.reasonReference.extension:commentContactReason",
        "path": "Encounter.reasonReference.extension",
        "sliceName": "commentContactReason",
        "max": "1",
        "type": [
          {
            "code": "Extension",
            "profile": [
              "https://fhir.healthdata.be/StructureDefinition/ext-Comment"
            ]
          }
        ]
      },
      {
        "id": "Encounter.reasonReference.extension:commentContactReason.value[x]",
        "path": "Encounter.reasonReference.extension.value[x]",
        "short": "CommentContactReason",
        "definition": "Explanation of the reason for the contact",
        "alias": [
          "ToelichtingRedenContact"
        ],
        "mapping": [
          {
            "identity": "zib-encounter-v4.0.1-2020EN",
            "map": "NL-CM:15.1.17",
            "comment": "CommentContactReason"
          },
          {
            "identity": "HdBe-Encounter",
            "map": "Encounter.ContactReason.CommentContactReason"
          }
        ]
      },
      {
        "id": "Encounter.reasonReference:problem",
        "path": "Encounter.reasonReference",
        "sliceName": "problem",
        "short": "Problem",
        "definition": "The problem that is the reason for the contact.",
        "alias": [
          "Probleem"
        ],
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "https://fhir.healthdata.be/StructureDefinition/HdBe-Problem"
            ]
          }
        ],
        "mapping": [
          {
            "identity": "zib-encounter-v4.0.1-2020EN",
            "map": "NL-CM:15.1.6",
            "comment": "Problem"
          },
          {
            "identity": "HdBe-Encounter",
            "map": "Encounter.ContactReason.Problem"
          }
        ]
      },
      {
        "id": "Encounter.reasonReference:procedure",
        "path": "Encounter.reasonReference",
        "sliceName": "procedure",
        "short": "Procedure",
        "definition": "The procedure carried out or will be carried out during the contact.",
        "alias": [
          "Verrichting"
        ],
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "https://fhir.healthdata.be/StructureDefinition/HdBe-Procedure-event"
            ]
          }
        ],
        "mapping": [
          {
            "identity": "zib-encounter-v4.0.1-2020EN",
            "map": "NL-CM:15.1.11",
            "comment": "Procedure"
          },
          {
            "identity": "HdBe-Encounter",
            "map": "Encounter.ContactReason.Procedure"
          }
        ]
      },
      {
        "id": "Encounter.hospitalization.admitSource",
        "path": "Encounter.hospitalization.admitSource",
        "short": "Origin",
        "definition": "Location from which the patient comes before the encounter. In most cases this will only be used when the patient is admitted.",
        "alias": [
          "Herkomst"
        ],
        "binding": {
          "strength": "extensible",
          "valueSet": "https://fhir.healthdata.be/ValueSet/Origin"
        },
        "mapping": [
          {
            "identity": "zib-encounter-v4.0.1-2020EN",
            "map": "NL-CM:15.1.14",
            "comment": "Origin"
          },
          {
            "identity": "HdBe-Encounter",
            "map": "Encounter.Origin"
          }
        ]
      },
      {
        "id": "Encounter.hospitalization.dischargeDisposition",
        "path": "Encounter.hospitalization.dischargeDisposition",
        "short": "Destination",
        "definition": "Location to which the patient will go after the encounter. In most cases this will only be used when the patient is discharged.",
        "alias": [
          "Bestemming"
        ],
        "binding": {
          "strength": "extensible",
          "valueSet": "https://fhir.healthdata.be/ValueSet/Destination"
        },
        "mapping": [
          {
            "identity": "zib-encounter-v4.0.1-2020EN",
            "map": "NL-CM:15.1.16",
            "comment": "Destination"
          },
          {
            "identity": "HdBe-Encounter",
            "map": "Encounter.Destination"
          }
        ]
      },
      {
        "id": "Encounter.location",
        "path": "Encounter.location",
        "max": "1"
      },
      {
        "id": "Encounter.location.location",
        "path": "Encounter.location.location",
        "short": "Location",
        "definition": "The physical location at which the contact took or will take place.",
        "alias": [
          "Locatie"
        ],
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://hl7.org/fhir/StructureDefinition/Location",
              "https://fhir.healthdata.be/StructureDefinition/HdBe-HealthcareOrganization"
            ]
          }
        ],
        "mapping": [
          {
            "identity": "zib-encounter-v4.0.1-2020EN",
            "map": "NL-CM:15.1.8",
            "comment": "Location"
          },
          {
            "identity": "HdBe-Encounter",
            "map": "Encounter.Location"
          }
        ]
      }
    ]
  }
}