{ "resourceType": "StructureDefinition", "id": "vkp-digital-Encounter-v06", "url": "http://ehelse.no/fhir/StructureDefinition/vkp-digital-Encounter-v06", "version": "0.6", "name": "vkp-digital-Encounter-v06", "status": "draft", "date": "2018-09-07", "description": "The digital (virtual) Encounter is caracterized as an encounter that uses some technological mean to perform the encounter instead of a face-to-face meeting.", "fhirVersion": "3.0.1", "kind": "resource", "abstract": false, "type": "Encounter", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Encounter", "derivation": "constraint", "differential": { "element": [ { "id": "Encounter", "path": "Encounter", "short": "An digital/virtual interaction during which services are provided to the patient", "definition": "The digital (virtual) Encounter is caracterized as an encounter that uses some technological mean to perform the encounter instead of a face-to-face meeting.\r\n\r\nAn interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.", "comment": "The use-case in question is performing a virtual encounter using a camera device to perform the encounter.", "alias": [ "digitalt tilsyn" ] }, { "id": "Encounter.extension", "path": "Encounter.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "rules": "open" } }, { "id": "Encounter.extension:note", "path": "Encounter.extension", "sliceName": "note", "short": "A journal note", "definition": "A journal note to document the digital encounter.\r\nCan be XHTML formatted text.\r\nIn the VKP project in Norway the note is used for: \r\nResponse summary: A text describing the resolution of the digital-Encounter event\r\n\r\nExample:\r\n~~~\r\n{\r\n \"url\":\"http://ehelse.no/fhir/StructureDefinition/vkp-annotation-v06\",\r\n \"extension\": [\r\n {\r\n \"url\":\"note\",\r\n \"valueAnnotation\":{\r\n \"authorReference\":{\r\n \"identifier\":{\r\n \"system\":\"urn:oid:2.16.578.1.12.4.1.4.1\",\r\n \"value\":\"04056600324\"\r\n },\r\n \"display\":\"Magnar Koman\"\r\n },\r\n \"time\":\"2018-06-25T08:00:00.936Z\",\r\n \"text\":\"Selve teksten til journalnotatet.\"\r\n }\r\n }\r\n ]\r\n}\r\n~~~", "max": "1", "type": [ { "code": "Extension", "profile": "http://ehelse.no/fhir/StructureDefinition/vkp-annotation-v06" } ] }, { "id": "Encounter.extension:signature", "path": "Encounter.extension", "sliceName": "signature", "short": "Signature for the journal note", "definition": "When a journal note is to document the digital encounter in the EHR it needs a string identifying who registered the note. A signature of who registered the information should be present in all events, even when there is no text in the journal note.\r\n\r\nCan be XHTML formatted text.\r\nIn the VKP project in Norway the signature is used for: \r\nSignature: Name of author plus a system specific signature identifying the user who submitted the Composition (user name in the system).\r\n\r\nExample:\r\n~~~\r\n{\r\n \"url\":\"http://ehelse.no/fhir/StructureDefinition/vkp-annotation-v06\",\r\n \"extension\": [\r\n {\r\n \"url\":\"signature\",\r\n \"valueAnnotation\":{\r\n \"time\":\"2018-06-25T08:00:00.936Z\",\r\n \"text\":\"Magnar Koman (signatur)\"\r\n }\r\n }\r\n ]\r\n}\r\n~~~", "max": "1", "type": [ { "code": "Extension", "profile": "http://ehelse.no/fhir/StructureDefinition/vkp-annotation-v06" } ] }, { "id": "Encounter.extension:device", "path": "Encounter.extension", "sliceName": "device", "definition": "The device used in the patient encounter. For example, a particular camera device\r\n\r\nVKP-norway: Should be a logical reference containing the IMEI/serial number of the device. display value should contain the name of the device type.\r\nCould also contain a display name of the device", "min": 1, "type": [ { "code": "Extension", "profile": "http://ehelse.no/fhir/StructureDefinition/vkp-encounterDevice-v06" } ] }, { "id": "Encounter.extension:device.extension", "path": "Encounter.extension.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "rules": "open" } }, { "id": "Encounter.extension:device.extension:deviceIdentifier", "path": "Encounter.extension.extension", "sliceName": "deviceIdentifier", "max": "1" }, { "id": "Encounter.extension:device.extension:display", "path": "Encounter.extension.extension", "sliceName": "display", "max": "1" }, { "id": "Encounter.identifier", "path": "Encounter.identifier", "definition": "Unique code or number identifying the Encounter\r\n\r\nVKP project uses UUID. \r\n\r\nExample:\r\n~~~\r\n\"identifier\": [\r\n {\r\n \"system\":\"urn:ietf:rfc:3986\",\r\n \"value\":\"urn:uuid:a76d9bbf-f293-4fb7-ad4c-2851cac77162\"\r\n }\r\n]\r\n~~~", "mustSupport": true }, { "id": "Encounter.identifier.system", "path": "Encounter.identifier.system", "fixedUri": "urn:ietf:rfc:3986" }, { "id": "Encounter.identifier.value", "path": "Encounter.identifier.value", "definition": "The actual uniqe identifier (UUID)\r\n\r\nThe portion of the identifier typically relevant to the user and which is unique within the context of the system." }, { "id": "Encounter.class", "path": "Encounter.class", "short": "Encounter class for digital Encounter", "definition": "VKP uses a valueset for encounter class for digital Encounter http://ehelse.no/fhir/ValueSet/vkp-encounter-class-v06", "binding": { "strength": "extensible", "valueSetReference": { "reference": "http://ehelse.no/fhir/ValueSet/vkp-encounter-class-v06" } } }, { "id": "Encounter.class.system", "path": "Encounter.class.system", "definition": "VKP uses http://ehelse.no/fhir/CodeSystem/vkp-encounter-class-v06\r\nThe identification of the code system that defines the meaning of the symbol in the code.", "fixedUri": "http://ehelse.no/fhir/CodeSystem/vkp-encounter-class-v06" }, { "id": "Encounter.classHistory", "path": "Encounter.classHistory", "mustSupport": true }, { "id": "Encounter.classHistory.extension", "path": "Encounter.classHistory.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "rules": "open" } }, { "id": "Encounter.classHistory.extension:device", "path": "Encounter.classHistory.extension", "sliceName": "device", "definition": "Devices used during the patient encounter. For example, a particular camera device.\r\n\r\nVKP-norway: Should contain a displaynames of the devices", "max": "1", "type": [ { "code": "Extension", "profile": "http://ehelse.no/fhir/StructureDefinition/vkp-encounterDevice-v06" } ] }, { "id": "Encounter.classHistory.extension:device.extension", "path": "Encounter.classHistory.extension.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "rules": "open" } }, { "id": "Encounter.classHistory.extension:device.extension:display", "path": "Encounter.classHistory.extension.extension", "sliceName": "display", "max": "1" }, { "id": "Encounter.classHistory.class", "path": "Encounter.classHistory.class", "short": "Encounter class for digital Encounter", "definition": "VKP uses a valueset for encounter class for digital Encounter http://ehelse.no/fhir/ValueSet/vkp-encounter-class-v06", "mustSupport": true, "binding": { "strength": "extensible", "valueSetReference": { "reference": "http://ehelse.no/fhir/ValueSet/vkp-encounter-class-v06" } } }, { "id": "Encounter.classHistory.class.system", "path": "Encounter.classHistory.class.system", "fixedUri": "http://ehelse.no/fhir/CodeSystem/vkp-encounter-class-v06", "mustSupport": true }, { "id": "Encounter.classHistory.class.code", "path": "Encounter.classHistory.class.code", "mustSupport": true }, { "id": "Encounter.classHistory.period", "path": "Encounter.classHistory.period", "definition": "Time period for the digital encounter, the system should provide both start and end times.\r\nIf the start-time is not known a single end time can be provided as a timestamp for the Encounter.\r\n\r\nExample code: \r\n~~~\r\n\"period\":{\r\n \"start\":\"2018-06-25T09:56:23.945+02:00\",\r\n \"end\":\"2018-06-25T10:01:03.936+02:00\"\r\n}\r\n~~~", "mustSupport": true }, { "id": "Encounter.classHistory.period.start", "path": "Encounter.classHistory.period.start", "mustSupport": true }, { "id": "Encounter.classHistory.period.end", "path": "Encounter.classHistory.period.end", "mustSupport": true }, { "id": "Encounter.type", "path": "Encounter.type", "short": "Event type", "definition": "Encounter type \r\ntilsyn|hendelse", "min": 1, "max": "1", "mustSupport": true, "binding": { "strength": "required", "valueSetReference": { "reference": "http://ehelse.no/fhir/ValueSet/vkp-encounter-type-v05" } } }, { "id": "Encounter.subject", "path": "Encounter.subject", "short": "The patient or group present at the encounter", "definition": "Reference to the patient that is subject to the encounter, identified by Norwegian national id number (Fødselsnummer or DNR).\r\n\r\nA link to a resource representing the person or the group to whom the medication will be given.\r\n\r\nVKP always references a Patient Resource using a norwegian national id number (Fødslesnummer or DNR) in a logical identifier in the subject.identifier element.\r\nThe Name of the patient should be given in the subject.display element.\r\n\r\nExample:\r\n~~~~\r\n\"subject\":{\r\n \"identifier\":{\r\n \"system\":\"urn:oid:2.16.578.1.12.4.1.4.1\",\r\n \"value\":\"05073500186\"\r\n },\r\n \"display\":\"Ærlend Sørgård\"\r\n}\r\n~~~~", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Group" }, { "code": "Reference", "targetProfile": "http://hl7.no/fhir/StructureDefinition/no-basis-Patient" }, { "code": "Reference", "targetProfile": "http://ehelse.no/fhir/StructureDefinition/vkp-Patient-v06" } ], "mustSupport": true }, { "id": "Encounter.subject.identifier", "path": "Encounter.subject.identifier", "min": 1, "mustSupport": true }, { "id": "Encounter.subject.identifier.system", "path": "Encounter.subject.identifier.system", "mustSupport": true }, { "id": "Encounter.subject.identifier.value", "path": "Encounter.subject.identifier.value", "mustSupport": true }, { "id": "Encounter.subject.display", "path": "Encounter.subject.display", "min": 1, "mustSupport": true }, { "id": "Encounter.participant", "path": "Encounter.participant", "definition": "Refernce to the individual that participated in the encounter, usually health care provider. Identified using Norwegian national id number (fødselsnummer).\r\nThe Name of the participant should be given in the subject.display element.\r\n\r\nExample: \r\n~~~~\r\n\"participant\": [\r\n {\r\n \"individual\":{\r\n \"identifier\":{\r\n \"system\":\"urn:oid:2.16.578.1.12.4.1.4.1\",\r\n \"value\":\"04056600324\"\r\n },\r\n \"display\":\"Magnar Koman\"\r\n }\r\n }\r\n]\r\n~~~~", "mustSupport": true }, { "id": "Encounter.participant.individual", "path": "Encounter.participant.individual", "short": "Refernce to the individual that participated in the encounter", "definition": "Refernce to the individual that participated in the encounter, usually health care provider. Identified using Norwegian national id number (fødselsnummer).\r\nThe Name of the participant should be given in the subject.display element.", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson" }, { "code": "Reference", "targetProfile": "http://hl7.no/fhir/StructureDefinition/no-basis-Practitioner" } ], "mustSupport": true }, { "id": "Encounter.participant.individual.identifier", "path": "Encounter.participant.individual.identifier", "definition": "Logical refernce to the individual that participated in the encounter, usually health care provider. Identified using Norwegian national id number (fødselsnummer).\r\nThe Name of the participant should be given in the subject.display element.\r\n\r\nAn identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.", "mustSupport": true }, { "id": "Encounter.participant.individual.identifier.system", "path": "Encounter.participant.individual.identifier.system", "short": "The official name of the FNR namespace", "definition": "The official name of the FNR namespace, identified by its oid value\r\n\r\nEstablishes the namespace for the value - that is, a URL that describes a set values that are unique.", "fixedUri": "urn:oid:2.16.578.1.12.4.1.4.1", "mustSupport": true }, { "id": "Encounter.participant.individual.identifier.value", "path": "Encounter.participant.individual.identifier.value", "short": "The FNR of the individual", "definition": "The FNR value identifying the participant\r\n\r\nThe portion of the identifier typically relevant to the user and which is unique within the context of the system.", "mustSupport": true }, { "id": "Encounter.participant.individual.display", "path": "Encounter.participant.individual.display", "short": "Tha name of the individual", "definition": "Tha name of the individual\r\n\r\nPlain text narrative that identifies the resource in addition to the resource reference.", "mustSupport": true }, { "id": "Encounter.period", "path": "Encounter.period", "short": "The start and end time of the digital encounter", "definition": "Time period for the digital encounter, the system should provide both start and end times.\r\nIf the start-time is not known a single end time can be provided as a timestamp for the Encounter.\r\n\r\nExample code: \r\n~~~\r\n\"period\":{\r\n \"start\":\"2018-06-25T09:56:23.945+02:00\",\r\n \"end\":\"2018-06-25T10:01:03.936+02:00\"\r\n}\r\n~~~", "min": 1, "mustSupport": true }, { "id": "Encounter.period.start", "path": "Encounter.period.start", "mustSupport": true }, { "id": "Encounter.period.end", "path": "Encounter.period.end", "mustSupport": true }, { "id": "Encounter.reason", "path": "Encounter.reason", "definition": "Reason the encounter takes place, coded according to http://ehelse.no/fhir/ValueSet/vkp-encounter-reason-v05", "max": "1", "mustSupport": true, "binding": { "strength": "required", "description": "vkp-encounter-reason-v05", "valueSetReference": { "reference": "http://ehelse.no/fhir/ValueSet/vkp-encounter-reason-v05" } } }, { "id": "Encounter.location", "path": "Encounter.location", "definition": "VKP uses this refererence to name location where the digital-Encounter takes place. Typically includes only location.location.display element with a textual description of the location.\r\n\r\nList of locations where the patient has been during this encounter.", "comment": "Virtual encounters can be recorded in the Encounter by specifying a location reference to a location of type \"kind\" such as \"client's home\" and an encounter.class = \"virtual\".\r\n\r\nVKP Example:\r\n~~~\r\n \"location\": [\r\n {\r\n \"location\":{\r\n \"display\":\"rom24 @ sykehjem\"\r\n }\r\n }\r\n ]\r\n~~~", "mustSupport": true }, { "id": "Encounter.location.location", "path": "Encounter.location.location", "definition": "A location reference. Only display value is supported by the VKP.\r\n\r\nThe location where the encounter takes place.", "mustSupport": true }, { "id": "Encounter.location.location.display", "path": "Encounter.location.location.display", "definition": "The Display value for the location. In vkp the format is usually \"[room or room-number] @ [location name]\".\r\n\r\nPlain text narrative that identifies the resource in addition to the resource reference.", "example": [ { "label": "display", "valueString": "\"rom24 @ sykehjem\"" } ], "mustSupport": true } ] } }