FHIR IG analytics
| Package | hl7.fhir.be.patient-monitoring |
| Resource Type | StructureDefinition |
| Id | StructureDefinition-homehosp-encounter-lm.json |
| FHIR Version | R4 |
| Source | https://build.fhir.org/ig/hl7-be/patient-monitoring/StructureDefinition-homehosp-encounter-lm.html |
| URL | http://hl7belgium.org/fhir/patient-monitoring/StructureDefinition/homehosp-encounter-lm |
| Version | 0.1.0 |
| Status | draft |
| Date | 2026-05-27T09:31:20+00:00 |
| Name | HomeHospEncounter |
| Title | Home Hospitalization Encounter Logical Model |
| Realm | be |
| Authority | hl7 |
| Description | Logical model representing the FHIR Encounter resource as used in the OPAT and ONCO home hospitalization caresets. The Encounter serves two purposes: (1) recording whether the home visit took place and whether the patient was home, and (2) communicating the status of each ordered care activity back to the hospital. Only orders given by the hospital should be communicated back via this Encounter; other nursing activities are excluded. |
| Type | http://hl7belgium.org/fhir/patient-monitoring/StructureDefinition/HomeHospEncounter |
| Kind | logical |
Resources that use this resource
Resources that this resource uses
Narrative
Note: links and images are rebased to the (stated) source
| Name | Flags | Card. | Type | Description & Constraints |
|---|
  HomeHospEncounter | | 0..* | Base | Home Hospitalization Encounter Logical Model
Instances of this logical model can be the target of a Reference |
  status | | 1..1 | code | Status of the encounter - reported from Home nurse back to hospital | Answers: finished | cancelled | entered-in-error |
| class | | 1..1 | code | Classification of the encounter | Fixed value: HH (home health) from http://terminology.hl7.org/CodeSystem/v3-ActCode |
 period | | 1..1 | BackboneElement | The start (and optionally end) time of the encounter |
 start | | 1..1 | dateTime | Start date/time of the home visit |
 end | | 0..1 | dateTime | End date/time of the home visit |
| participant | | 1..* | BackboneElement | The home nurse performing the visit
|
| type | | 1..1 | code | Participant type | Fixed value: PPRF (primary performer) from http://terminology.hl7.org/CodeSystem/v3-ParticipationType |
 individual | | 1..1 | Reference(BePractitioner) | Reference or display name and RIZIV number of the performing home nurse |
| reasonCode | | 1..* | BackboneElement | The ordered care activities being reported on. One reasonCode entry per ordered activity (e.g. medication administration + catheter care). Only orders from the hospital should be included.
|
| primaryProcedure | | 1..1 | code | Primary SNOMED code for the ordered care activity | Possible values: 18629005 Administration of drug or medicament | 18949003 Change of dressing | 705995006 Replace needleless connector | 448439004 Replace statlock | 302358004 Replace gripper needle | 233553003 Remove gripper needle | 103715008 Remove catheter | 82078001 Blood sample collection |
| administrationSubtype | | 0..1 | code | Subtype for drug administration (use when primaryProcedure = 18629005) | Possible values: 14152002 Intravenous infusion | 386358000 IV administration | 76601001 Intramuscular injection | 276844002 Subcutaneous injection | 243132000 Inhaled administration |
| statusText | | 0..1 | string | Free-text status note for this care activity (e.g. why it was not performed) |
| completed | | 1..1 | code | Was this ordered care activity completed? | Answers: 31874001 True (completed) | 64100000 False (not completed) |
| serviceProvider | | 0..1 | Reference(BeOrganization) | Reference or display name of the home nursing organisation (e.g. Wit-Gele Kruis Vlaams-Brabant) |
| reasonReference | | 0..* | Reference(Home Hospitalization QuestionnaireResponse Logical Model) | Reference(s) to the QuestionnaireResponse(s) associated with this encounter
|
Documentation for this format |
Source1
{
"resourceType": "StructureDefinition",
"id": "homehosp-encounter-lm",
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/logical-target",
"valueBoolean": true
}
],
"url": "http://hl7belgium.org/fhir/patient-monitoring/StructureDefinition/homehosp-encounter-lm",
"identifier": [
{
"system": "urn:ietf:rfc:3986",
"value": "urn:oid:2.16.840.1.113883.4.642.40.54.42.22"
}
],
"version": "0.1.0",
"name": "HomeHospEncounter",
"title": "Home Hospitalization Encounter Logical Model",
"status": "draft",
"date": "2026-05-27T09:31:20+00:00",
"publisher": "HL7 Belgium",
"contact": [
{
"name": "HL7 Belgium",
"telecom": [
{
"system": "url",
"value": "http://example.com/committees"
},
{
"system": "email",
"value": "my-group@example.com"
}
]
},
{
"name": "Bob Smith",
"telecom": [
{
"system": "email",
"value": "bobsmith@example.com",
"use": "work"
}
]
}
],
"description": "Logical model representing the FHIR Encounter resource as used in the OPAT and ONCO home hospitalization caresets. The Encounter serves two purposes: (1) recording whether the home visit took place and whether the patient was home, and (2) communicating the status of each ordered care activity back to the hospital. Only orders given by the hospital should be communicated back via this Encounter; other nursing activities are excluded.",
"jurisdiction": [
{
"coding": [
{
"system": "urn:iso:std:iso:3166",
"code": "BE",
"display": "Belgium"
}
]
}
],
"fhirVersion": "4.0.1",
"kind": "logical",
"abstract": false,
"type": "http://hl7belgium.org/fhir/patient-monitoring/StructureDefinition/HomeHospEncounter",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Base",
"derivation": "specialization",
"snapshot": {
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
"valueString": "4.0.1"
}
],
"element": [
{
"id": "HomeHospEncounter",
"path": "HomeHospEncounter",
"short": "Home Hospitalization Encounter Logical Model",
"definition": "Logical model representing the FHIR Encounter resource as used in the OPAT and ONCO home hospitalization caresets. The Encounter serves two purposes: (1) recording whether the home visit took place and whether the patient was home, and (2) communicating the status of each ordered care activity back to the hospital. Only orders given by the hospital should be communicated back via this Encounter; other nursing activities are excluded.",
"min": 0,
"max": "*",
"base": {
"path": "Base",
"min": 0,
"max": "*"
},
"isModifier": false
},
{
"id": "HomeHospEncounter.status",
"path": "HomeHospEncounter.status",
"short": "Status of the encounter - reported from Home nurse back to hospital | Answers: finished | cancelled | entered-in-error",
"definition": "Status of the encounter - reported from Home nurse back to hospital | Answers: finished | cancelled | entered-in-error",
"min": 1,
"max": "1",
"base": {
"path": "HomeHospEncounter.status",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
]
},
{
"id": "HomeHospEncounter.class",
"path": "HomeHospEncounter.class",
"short": "Classification of the encounter | Fixed value: HH (home health) from http://terminology.hl7.org/CodeSystem/v3-ActCode",
"definition": "Classification of the encounter | Fixed value: HH (home health) from http://terminology.hl7.org/CodeSystem/v3-ActCode",
"min": 1,
"max": "1",
"base": {
"path": "HomeHospEncounter.class",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
]
},
{
"id": "HomeHospEncounter.period",
"path": "HomeHospEncounter.period",
"short": "The start (and optionally end) time of the encounter",
"definition": "The start (and optionally end) time of the encounter",
"min": 1,
"max": "1",
"base": {
"path": "HomeHospEncounter.period",
"min": 1,
"max": "1"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
]
},
{
"id": "HomeHospEncounter.period.id",
"path": "HomeHospEncounter.period.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": "HomeHospEncounter.period.extension",
"path": "HomeHospEncounter.period.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())",
"xpath": "@value|f:*|h:div",
"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()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "HomeHospEncounter.period.modifierExtension",
"path": "HomeHospEncounter.period.modifierExtension",
"short": "Extensions that cannot be ignored even if unrecognized",
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"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.",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"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())",
"xpath": "@value|f:*|h:div",
"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()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": true,
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "HomeHospEncounter.period.start",
"path": "HomeHospEncounter.period.start",
"short": "Start date/time of the home visit",
"definition": "Start date/time of the home visit",
"min": 1,
"max": "1",
"base": {
"path": "HomeHospEncounter.period.start",
"min": 1,
"max": "1"
},
"type": [
{
"code": "dateTime"
}
]
},
{
"id": "HomeHospEncounter.period.end",
"path": "HomeHospEncounter.period.end",
"short": "End date/time of the home visit",
"definition": "End date/time of the home visit",
"min": 0,
"max": "1",
"base": {
"path": "HomeHospEncounter.period.end",
"min": 0,
"max": "1"
},
"type": [
{
"code": "dateTime"
}
]
},
{
"id": "HomeHospEncounter.participant",
"path": "HomeHospEncounter.participant",
"short": "The home nurse performing the visit",
"definition": "The home nurse performing the visit",
"min": 1,
"max": "*",
"base": {
"path": "HomeHospEncounter.participant",
"min": 1,
"max": "*"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
]
},
{
"id": "HomeHospEncounter.participant.id",
"path": "HomeHospEncounter.participant.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": "HomeHospEncounter.participant.extension",
"path": "HomeHospEncounter.participant.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())",
"xpath": "@value|f:*|h:div",
"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()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "HomeHospEncounter.participant.modifierExtension",
"path": "HomeHospEncounter.participant.modifierExtension",
"short": "Extensions that cannot be ignored even if unrecognized",
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"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.",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"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())",
"xpath": "@value|f:*|h:div",
"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()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": true,
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "HomeHospEncounter.participant.type",
"path": "HomeHospEncounter.participant.type",
"short": "Participant type | Fixed value: PPRF (primary performer) from http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
"definition": "Participant type | Fixed value: PPRF (primary performer) from http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
"min": 1,
"max": "1",
"base": {
"path": "HomeHospEncounter.participant.type",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
]
},
{
"id": "HomeHospEncounter.participant.individual",
"path": "HomeHospEncounter.participant.individual",
"short": "Reference or display name and RIZIV number of the performing home nurse",
"definition": "Reference or display name and RIZIV number of the performing home nurse",
"min": 1,
"max": "1",
"base": {
"path": "HomeHospEncounter.participant.individual",
"min": 1,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-practitioner"
]
}
]
},
{
"id": "HomeHospEncounter.reasonCode",
"path": "HomeHospEncounter.reasonCode",
"short": "The ordered care activities being reported on. One reasonCode entry per ordered activity (e.g. medication administration + catheter care). Only orders from the hospital should be included.",
"definition": "The ordered care activities being reported on. One reasonCode entry per ordered activity (e.g. medication administration + catheter care). Only orders from the hospital should be included.",
"min": 1,
"max": "*",
"base": {
"path": "HomeHospEncounter.reasonCode",
"min": 1,
"max": "*"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
]
},
{
"id": "HomeHospEncounter.reasonCode.id",
"path": "HomeHospEncounter.reasonCode.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": "HomeHospEncounter.reasonCode.extension",
"path": "HomeHospEncounter.reasonCode.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())",
"xpath": "@value|f:*|h:div",
"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()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "HomeHospEncounter.reasonCode.modifierExtension",
"path": "HomeHospEncounter.reasonCode.modifierExtension",
"short": "Extensions that cannot be ignored even if unrecognized",
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"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.",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"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())",
"xpath": "@value|f:*|h:div",
"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()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": true,
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "HomeHospEncounter.reasonCode.primaryProcedure",
"path": "HomeHospEncounter.reasonCode.primaryProcedure",
"short": "Primary SNOMED code for the ordered care activity | Possible values: 18629005 Administration of drug or medicament | 18949003 Change of dressing | 705995006 Replace needleless connector | 448439004 Replace statlock | 302358004 Replace gripper needle | 233553003 Remove gripper needle | 103715008 Remove catheter | 82078001 Blood sample collection",
"definition": "Primary SNOMED code for the ordered care activity | Possible values: 18629005 Administration of drug or medicament | 18949003 Change of dressing | 705995006 Replace needleless connector | 448439004 Replace statlock | 302358004 Replace gripper needle | 233553003 Remove gripper needle | 103715008 Remove catheter | 82078001 Blood sample collection",
"min": 1,
"max": "1",
"base": {
"path": "HomeHospEncounter.reasonCode.primaryProcedure",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
]
},
{
"id": "HomeHospEncounter.reasonCode.administrationSubtype",
"path": "HomeHospEncounter.reasonCode.administrationSubtype",
"short": "Subtype for drug administration (use when primaryProcedure = 18629005) | Possible values: 14152002 Intravenous infusion | 386358000 IV administration | 76601001 Intramuscular injection | 276844002 Subcutaneous injection | 243132000 Inhaled administration",
"definition": "Subtype for drug administration (use when primaryProcedure = 18629005) | Possible values: 14152002 Intravenous infusion | 386358000 IV administration | 76601001 Intramuscular injection | 276844002 Subcutaneous injection | 243132000 Inhaled administration",
"min": 0,
"max": "1",
"base": {
"path": "HomeHospEncounter.reasonCode.administrationSubtype",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
]
},
{
"id": "HomeHospEncounter.reasonCode.statusText",
"path": "HomeHospEncounter.reasonCode.statusText",
"short": "Free-text status note for this care activity (e.g. why it was not performed)",
"definition": "Free-text status note for this care activity (e.g. why it was not performed)",
"min": 0,
"max": "1",
"base": {
"path": "HomeHospEncounter.reasonCode.statusText",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "HomeHospEncounter.reasonCode.completed",
"path": "HomeHospEncounter.reasonCode.completed",
"short": "Was this ordered care activity completed? | Answers: 31874001 True (completed) | 64100000 False (not completed)",
"definition": "Was this ordered care activity completed? | Answers: 31874001 True (completed) | 64100000 False (not completed)",
"min": 1,
"max": "1",
"base": {
"path": "HomeHospEncounter.reasonCode.completed",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
]
},
{
"id": "HomeHospEncounter.serviceProvider",
"path": "HomeHospEncounter.serviceProvider",
"short": "Reference or display name of the home nursing organisation (e.g. Wit-Gele Kruis Vlaams-Brabant)",
"definition": "Reference or display name of the home nursing organisation (e.g. Wit-Gele Kruis Vlaams-Brabant)",
"min": 0,
"max": "1",
"base": {
"path": "HomeHospEncounter.serviceProvider",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-organization"
]
}
]
},
{
"id": "HomeHospEncounter.reasonReference",
"path": "HomeHospEncounter.reasonReference",
"short": "Reference(s) to the QuestionnaireResponse(s) associated with this encounter",
"definition": "Reference(s) to the QuestionnaireResponse(s) associated with this encounter",
"min": 0,
"max": "*",
"base": {
"path": "HomeHospEncounter.reasonReference",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7belgium.org/fhir/patient-monitoring/StructureDefinition/homehosp-questionnaire-response-lm"
]
}
]
}
]
},
"differential": {
"element": [
{
"id": "HomeHospEncounter",
"path": "HomeHospEncounter",
"short": "Home Hospitalization Encounter Logical Model",
"definition": "Logical model representing the FHIR Encounter resource as used in the OPAT and ONCO home hospitalization caresets. The Encounter serves two purposes: (1) recording whether the home visit took place and whether the patient was home, and (2) communicating the status of each ordered care activity back to the hospital. Only orders given by the hospital should be communicated back via this Encounter; other nursing activities are excluded."
},
{
"id": "HomeHospEncounter.status",
"path": "HomeHospEncounter.status",
"short": "Status of the encounter - reported from Home nurse back to hospital | Answers: finished | cancelled | entered-in-error",
"definition": "Status of the encounter - reported from Home nurse back to hospital | Answers: finished | cancelled | entered-in-error",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
]
},
{
"id": "HomeHospEncounter.class",
"path": "HomeHospEncounter.class",
"short": "Classification of the encounter | Fixed value: HH (home health) from http://terminology.hl7.org/CodeSystem/v3-ActCode",
"definition": "Classification of the encounter | Fixed value: HH (home health) from http://terminology.hl7.org/CodeSystem/v3-ActCode",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
]
},
{
"id": "HomeHospEncounter.period",
"path": "HomeHospEncounter.period",
"short": "The start (and optionally end) time of the encounter",
"definition": "The start (and optionally end) time of the encounter",
"min": 1,
"max": "1",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "HomeHospEncounter.period.start",
"path": "HomeHospEncounter.period.start",
"short": "Start date/time of the home visit",
"definition": "Start date/time of the home visit",
"min": 1,
"max": "1",
"type": [
{
"code": "dateTime"
}
]
},
{
"id": "HomeHospEncounter.period.end",
"path": "HomeHospEncounter.period.end",
"short": "End date/time of the home visit",
"definition": "End date/time of the home visit",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
]
},
{
"id": "HomeHospEncounter.participant",
"path": "HomeHospEncounter.participant",
"short": "The home nurse performing the visit",
"definition": "The home nurse performing the visit",
"min": 1,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "HomeHospEncounter.participant.type",
"path": "HomeHospEncounter.participant.type",
"short": "Participant type | Fixed value: PPRF (primary performer) from http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
"definition": "Participant type | Fixed value: PPRF (primary performer) from http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
]
},
{
"id": "HomeHospEncounter.participant.individual",
"path": "HomeHospEncounter.participant.individual",
"short": "Reference or display name and RIZIV number of the performing home nurse",
"definition": "Reference or display name and RIZIV number of the performing home nurse",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": [
"https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-practitioner"
]
}
]
},
{
"id": "HomeHospEncounter.reasonCode",
"path": "HomeHospEncounter.reasonCode",
"short": "The ordered care activities being reported on. One reasonCode entry per ordered activity (e.g. medication administration + catheter care). Only orders from the hospital should be included.",
"definition": "The ordered care activities being reported on. One reasonCode entry per ordered activity (e.g. medication administration + catheter care). Only orders from the hospital should be included.",
"min": 1,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "HomeHospEncounter.reasonCode.primaryProcedure",
"path": "HomeHospEncounter.reasonCode.primaryProcedure",
"short": "Primary SNOMED code for the ordered care activity | Possible values: 18629005 Administration of drug or medicament | 18949003 Change of dressing | 705995006 Replace needleless connector | 448439004 Replace statlock | 302358004 Replace gripper needle | 233553003 Remove gripper needle | 103715008 Remove catheter | 82078001 Blood sample collection",
"definition": "Primary SNOMED code for the ordered care activity | Possible values: 18629005 Administration of drug or medicament | 18949003 Change of dressing | 705995006 Replace needleless connector | 448439004 Replace statlock | 302358004 Replace gripper needle | 233553003 Remove gripper needle | 103715008 Remove catheter | 82078001 Blood sample collection",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
]
},
{
"id": "HomeHospEncounter.reasonCode.administrationSubtype",
"path": "HomeHospEncounter.reasonCode.administrationSubtype",
"short": "Subtype for drug administration (use when primaryProcedure = 18629005) | Possible values: 14152002 Intravenous infusion | 386358000 IV administration | 76601001 Intramuscular injection | 276844002 Subcutaneous injection | 243132000 Inhaled administration",
"definition": "Subtype for drug administration (use when primaryProcedure = 18629005) | Possible values: 14152002 Intravenous infusion | 386358000 IV administration | 76601001 Intramuscular injection | 276844002 Subcutaneous injection | 243132000 Inhaled administration",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
]
},
{
"id": "HomeHospEncounter.reasonCode.statusText",
"path": "HomeHospEncounter.reasonCode.statusText",
"short": "Free-text status note for this care activity (e.g. why it was not performed)",
"definition": "Free-text status note for this care activity (e.g. why it was not performed)",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "HomeHospEncounter.reasonCode.completed",
"path": "HomeHospEncounter.reasonCode.completed",
"short": "Was this ordered care activity completed? | Answers: 31874001 True (completed) | 64100000 False (not completed)",
"definition": "Was this ordered care activity completed? | Answers: 31874001 True (completed) | 64100000 False (not completed)",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
]
},
{
"id": "HomeHospEncounter.serviceProvider",
"path": "HomeHospEncounter.serviceProvider",
"short": "Reference or display name of the home nursing organisation (e.g. Wit-Gele Kruis Vlaams-Brabant)",
"definition": "Reference or display name of the home nursing organisation (e.g. Wit-Gele Kruis Vlaams-Brabant)",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": [
"https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-organization"
]
}
]
},
{
"id": "HomeHospEncounter.reasonReference",
"path": "HomeHospEncounter.reasonReference",
"short": "Reference(s) to the QuestionnaireResponse(s) associated with this encounter",
"definition": "Reference(s) to the QuestionnaireResponse(s) associated with this encounter",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7belgium.org/fhir/patient-monitoring/StructureDefinition/homehosp-questionnaire-response-lm"
]
}
]
}
]
}
}
FHIR
FHIRsmith