PROTECT-CHILD Pediatric Transplant Data Implementation Guide
0.1.0-ci-build -
PROTECT-CHILD Pediatric Transplant Data Implementation Guide
0.1.0-ci-build - ci-build
PROTECT-CHILD Pediatric Transplant Data Implementation Guide
0.1.0-ci-build - ci-build
PROTECT-CHILD Pediatric Transplant Data Implementation Guide, published by Protect Child. This guide is not an authorized publication; it is the continuous build for version 0.1.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-eu/protect-child/ and changes regularly. See the Directory of published versions
| Official URL: https://hl7.eu/fhir/ig/hl7.eu.fhir.protect-child/StructureDefinition/transplant | Version: 0.1.0-ci-build | |||
| Draft as of 2026-02-09 | Computable Name: Transplant | |||
Encounter profile representing a transplant, linking the transplant recipient and donor and aligned with the transplant table.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Path | Status | Usage | ValueSet | Version | Source |
| Encounter.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Encounter.status | Base | required | EncounterStatus | 📍4.0.1 | FHIR Std. |
| Encounter.class | Base | extensible | ActEncounterCode | 📦3.0.0 | THO v7.0 |
| Encounter.type | Base | required | Transplant Type ValueSet | 📦0.1.0-ci-build | This IG |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Encounter | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Encounter | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Encounter | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from Encounter
| Path | Status | Usage | ValueSet | Version | Source |
| Encounter.type | Base | required | Transplant Type ValueSet | 📦0.1.0-ci-build | This IG |
| Name | Flags | Card. | Type | Description & Constraints Filter:   | ||||
|---|---|---|---|---|---|---|---|---|
  Encounter |
0..* | Encounter | An interaction during which services are provided to the patient | |||||
  id |
Σ | 0..1 | id | Logical id of this artifact | ||||
 meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
  Slices for extension |
6..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
   extension:donor_id |
S | 1..1 | Reference(Transplant Donor) | donor_id – reference to the donor URL: https://hl7.eu/fhir/ig/hl7.eu.fhir.protect-child/StructureDefinition/transplant-donor-ref | ||||
| extension:d_r_weight_ration |
S | 1..1 | decimal | d_r_weight_ration – donor/recipient graft weight ratio URL: https://hl7.eu/fhir/ig/hl7.eu.fhir.protect-child/StructureDefinition/transplant-donor-recipient-weight-ratio | ||||
| extension:vessel_mismatch_d_r |
S | 1..1 | boolean | vessel_mismatch_d_r – vessel mismatch (Yes/No) URL: https://hl7.eu/fhir/ig/hl7.eu.fhir.protect-child/StructureDefinition/transplant-vessel-mismatch | ||||
| extension:cold_ischemia_time |
S | 1..1 | integer | cold_ischemia_time – cold ischaemia time (minutes) URL: https://hl7.eu/fhir/ig/hl7.eu.fhir.protect-child/StructureDefinition/transplant-cold-ischaemia-time | ||||
| extension:time_diag_to_tx |
S | 1..1 | integer | time_diag_to_tx – months between diagnosis and transplant URL: https://hl7.eu/fhir/ig/hl7.eu.fhir.protect-child/StructureDefinition/transplant-time-diagnosis-to-transplant | ||||
| extension:warm_ischemia_time_1 |
0..1 | integer | 1_warm_ischemia_time – first warm ischaemia time (minutes) URL: https://hl7.eu/fhir/ig/hl7.eu.fhir.protect-child/StructureDefinition/transplant-first-warm-ischemia-time | |||||
| extension:warm_ischemia_time_2 |
0..1 | integer | 2_warm_ischemia_time – second warm ischaemia time (kidney only, minutes) URL: https://hl7.eu/fhir/ig/hl7.eu.fhir.protect-child/StructureDefinition/transplant-second-warm-ischemia-time | |||||
| extension:vascular_anomalies |
1..1 | string | vascular_anomalies – vascular anatomical variants (specify) URL: https://hl7.eu/fhir/ig/hl7.eu.fhir.protect-child/StructureDefinition/transplant-vascular-anomalies | |||||
| extension:type_surgical_biliary_anastomosis |
0..1 | CodeableConcept | type_surgical_biliary_anastomosis – biliary reconstruction type (liver only) URL: https://hl7.eu/fhir/ig/hl7.eu.fhir.protect-child/StructureDefinition/transplant-biliary-anastomosis-type Binding: Type of surgical biliary anastomosis ValueSet (preferred) | |||||
| extension:intraoperative_complications |
0..* | CodeableConcept | intraoperative_complications – complications during surgery (liver only) URL: https://hl7.eu/fhir/ig/hl7.eu.fhir.protect-child/StructureDefinition/transplant-intraoperative-complications Binding: Intraoperative Complications ValueSet (preferred) | |||||
| extension:intraoperative_complications_other |
0..1 | string | intraoperative_complications_other – free text for other complications URL: https://hl7.eu/fhir/ig/hl7.eu.fhir.protect-child/StructureDefinition/transplant-intraoperative-complications-other | |||||
| extension:nephrectomy_original_kidney |
0..1 | boolean | nephrectomy_original_kidney – nephrectomy of native kidney (kidney only) URL: https://hl7.eu/fhir/ig/hl7.eu.fhir.protect-child/StructureDefinition/transplant-nephrectomy-original-kidney | |||||
 extension:kidney_side |
0..1 | CodeableConcept | kidney_side – transplanted kidney side (left/right/both) URL: https://hl7.eu/fhir/ig/hl7.eu.fhir.protect-child/StructureDefinition/transplant-kidney-side Binding: Kidney Side ValueSet (preferred) | |||||
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
SΣ | 1..* | Identifier | transplant_id – transplant identifier from the data model | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system |
SΣ | 1..1 | uri | Namespace for the transplant identifier Example General: http://www.acme.com/identifiers/patient | ||||
| value |
SΣ | 1..1 | string | Transplant ID (transplant_id) Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
  assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| status |
?!SΣ | 1..1 | code | Status of the transplant encounter Binding: EncounterStatus (required): Current state of the encounter. | ||||
| statusHistory |
0..* | BackboneElement | List of past encounter statuses | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| status |
1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. | |||||
| period |
1..1 | Period | The time that the episode was in the specified status | |||||
| class |
SΣ | 1..1 | Coding | Classification of encounter (e.g. inpatient) Binding: ActEncounterCode (extensible): Classification of the encounter. | ||||
| classHistory |
0..* | BackboneElement | List of past encounter classes | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| class |
1..1 | Coding | inpatient | outpatient | ambulatory | emergency + Binding: ActEncounterCode (extensible): Classification of the encounter. | |||||
| period |
1..1 | Period | The time that the episode was in the specified class | |||||
| type |
SΣ | 1..1 | CodeableConcept | tx_type – transplant type (liver, kidney, combined) Binding: Transplant Type ValueSet (required): The type of encounter. | ||||
| serviceType |
Σ | 0..1 | CodeableConcept | Specific type of service Binding: ServiceType (example): Broad categorization of the service that is to be provided. | ||||
| priority |
0..1 | CodeableConcept | Indicates the urgency of the encounter Binding: ActPriority (example): Indicates the urgency of the encounter. | |||||
| subject |
SΣ | 1..1 | Reference(Transplant Recipient) | patient_id – the transplant recipient (PatientTransplant) | ||||
| episodeOfCare |
Σ | 0..* | Reference(EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against | ||||
| basedOn |
0..* | Reference(ServiceRequest) | The ServiceRequest that initiated this encounter | |||||
| participant |
Σ | 0..* | BackboneElement | List of participants involved in the encounter | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type |
Σ | 0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. | ||||
| period |
0..1 | Period | Period of time during the encounter that the participant participated | |||||
| individual |
Σ | 0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson) | Persons involved in the encounter other than the patient | ||||
| appointment |
Σ | 0..* | Reference(Appointment) | The appointment that scheduled this encounter | ||||
| period |
S | 1..1 | Period | The start and end time of the encounter | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| start |
SΣC | 1..1 | dateTime | date_tx – date (and optionally time) of the transplant | ||||
| end |
ΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
| length |
0..1 | Duration | Quantity of time the encounter lasted (less time absent) | |||||
| reasonCode |
Σ | 0..* | CodeableConcept | Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. | ||||
| reasonReference |
Σ | 0..* | Reference(Condition | Procedure | Observation | ImmunizationRecommendation) | Reason the encounter takes place (reference) | ||||
| diagnosis |
Σ | 0..* | BackboneElement | The list of diagnosis relevant to this encounter | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| condition |
Σ | 1..1 | Reference(Condition | Procedure) | The diagnosis or procedure relevant to the encounter | ||||
| use |
0..1 | CodeableConcept | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents. | |||||
| rank |
0..1 | positiveInt | Ranking of the diagnosis (for each role type) | |||||
| account |
0..* | Reference(Account) | The set of accounts that may be used for billing for this Encounter | |||||
| hospitalization |
0..1 | BackboneElement | Details about the admission to a healthcare service | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| preAdmissionIdentifier |
0..1 | Identifier | Pre-admission identifier | |||||
| origin |
0..1 | Reference(Location | Organization) | The location/organization from which the patient came before admission | |||||
| admitSource |
0..1 | CodeableConcept | From where patient was admitted (physician referral, transfer) Binding: AdmitSource (preferred): From where the patient was admitted. | |||||
| reAdmission |
0..1 | CodeableConcept | The type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission Binding: hl7VS-re-admissionIndicator (example): The reason for re-admission of this hospitalization encounter. | |||||
| dietPreference |
0..* | CodeableConcept | Diet preferences reported by the patient Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements. | |||||
| specialCourtesy |
0..* | CodeableConcept | Special courtesies (VIP, board member) Binding: SpecialCourtesy (preferred): Special courtesies. | |||||
| specialArrangement |
0..* | CodeableConcept | Wheelchair, translator, stretcher, etc. Binding: SpecialArrangements (preferred): Special arrangements. | |||||
| destination |
0..1 | Reference(Location | Organization) | Location/organization to which the patient is discharged | |||||
| dischargeDisposition |
0..1 | CodeableConcept | Category or kind of location after discharge Binding: DischargeDisposition (example): Discharge Disposition. | |||||
| location |
0..* | BackboneElement | List of locations where the patient has been | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| location |
1..1 | Reference(Location) | Location the encounter takes place | |||||
| status |
0..1 | code | planned | active | reserved | completed Binding: EncounterLocationStatus (required): The status of the location. | |||||
| physicalType |
0..1 | CodeableConcept | The physical type of the location (usually the level in the location hierachy - bed room ward etc.) Binding: LocationType (example): Physical form of the location. | |||||
| period |
0..1 | Period | Time period during which the patient was present at the location | |||||
| serviceProvider |
0..1 | Reference(Organization) | The organization (facility) responsible for this encounter | |||||
| partOf |
0..1 | Reference(Encounter) | Another Encounter this encounter is part of | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Encounter.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Encounter.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Encounter.identifier.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Encounter.status | Base | required | EncounterStatus | 📍4.0.1 | FHIR Std. |
| Encounter.statusHistory.status | Base | required | EncounterStatus | 📍4.0.1 | FHIR Std. |
| Encounter.class | Base | extensible | ActEncounterCode | 📦3.0.0 | THO v7.0 |
| Encounter.classHistory.class | Base | extensible | ActEncounterCode | 📦3.0.0 | THO v7.0 |
| Encounter.type | Base | required | Transplant Type ValueSet | 📦0.1.0-ci-build | This IG |
| Encounter.serviceType | Base | example | Service type | 📍4.0.1 | FHIR Std. |
| Encounter.priority | Base | example | ActPriority | 📦3.0.0 | THO v7.0 |
| Encounter.participant.type | Base | extensible | Participant type | 📍4.0.1 | FHIR Std. |
| Encounter.reasonCode | Base | preferred | Encounter Reason Codes | 📍4.0.1 | FHIR Std. |
| Encounter.diagnosis.use | Base | preferred | DiagnosisRole | 📍4.0.1 | FHIR Std. |
| Encounter.hospitalization.admitSource | Base | preferred | Admit source | 📍4.0.1 | FHIR Std. |
| Encounter.hospitalization.reAdmission | Base | example | hl7VS-re-admissionIndicator | 📦2.0.0 | THO v7.0 |
| Encounter.hospitalization.dietPreference | Base | example | Diet | 📍4.0.1 | FHIR Std. |
| Encounter.hospitalization.specialCourtesy | Base | preferred | Special courtesy | 📍4.0.1 | FHIR Std. |
| Encounter.hospitalization.specialArrangement | Base | preferred | Special arrangements | 📍4.0.1 | FHIR Std. |
| Encounter.hospitalization.dischargeDisposition | Base | example | Discharge disposition | 📍4.0.1 | FHIR Std. |
| Encounter.location.status | Base | required | EncounterLocationStatus | 📍4.0.1 | FHIR Std. |
| Encounter.location.physicalType | Base | example | Location type | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Encounter | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Encounter | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Encounter | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from Encounter
Summary
Mandatory: 13 elements
Must-Support: 14 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Key Elements View
| Path | Status | Usage | ValueSet | Version | Source |
| Encounter.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Encounter.status | Base | required | EncounterStatus | 📍4.0.1 | FHIR Std. |
| Encounter.class | Base | extensible | ActEncounterCode | 📦3.0.0 | THO v7.0 |
| Encounter.type | Base | required | Transplant Type ValueSet | 📦0.1.0-ci-build | This IG |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Encounter | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Encounter | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Encounter | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Differential View
This structure is derived from Encounter
| Path | Status | Usage | ValueSet | Version | Source |
| Encounter.type | Base | required | Transplant Type ValueSet | 📦0.1.0-ci-build | This IG |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Encounter |
0..* | Encounter | An interaction during which services are provided to the patient | |||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
6..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:donor_id |
S | 1..1 | Reference(Transplant Donor) | donor_id – reference to the donor URL: https://hl7.eu/fhir/ig/hl7.eu.fhir.protect-child/StructureDefinition/transplant-donor-ref | ||||
| extension:d_r_weight_ration |
S | 1..1 | decimal | d_r_weight_ration – donor/recipient graft weight ratio URL: https://hl7.eu/fhir/ig/hl7.eu.fhir.protect-child/StructureDefinition/transplant-donor-recipient-weight-ratio | ||||
| extension:vessel_mismatch_d_r |
S | 1..1 | boolean | vessel_mismatch_d_r – vessel mismatch (Yes/No) URL: https://hl7.eu/fhir/ig/hl7.eu.fhir.protect-child/StructureDefinition/transplant-vessel-mismatch | ||||
| extension:cold_ischemia_time |
S | 1..1 | integer | cold_ischemia_time – cold ischaemia time (minutes) URL: https://hl7.eu/fhir/ig/hl7.eu.fhir.protect-child/StructureDefinition/transplant-cold-ischaemia-time | ||||
| extension:time_diag_to_tx |
S | 1..1 | integer | time_diag_to_tx – months between diagnosis and transplant URL: https://hl7.eu/fhir/ig/hl7.eu.fhir.protect-child/StructureDefinition/transplant-time-diagnosis-to-transplant | ||||
| extension:warm_ischemia_time_1 |
0..1 | integer | 1_warm_ischemia_time – first warm ischaemia time (minutes) URL: https://hl7.eu/fhir/ig/hl7.eu.fhir.protect-child/StructureDefinition/transplant-first-warm-ischemia-time | |||||
| extension:warm_ischemia_time_2 |
0..1 | integer | 2_warm_ischemia_time – second warm ischaemia time (kidney only, minutes) URL: https://hl7.eu/fhir/ig/hl7.eu.fhir.protect-child/StructureDefinition/transplant-second-warm-ischemia-time | |||||
| extension:vascular_anomalies |
1..1 | string | vascular_anomalies – vascular anatomical variants (specify) URL: https://hl7.eu/fhir/ig/hl7.eu.fhir.protect-child/StructureDefinition/transplant-vascular-anomalies | |||||
| extension:type_surgical_biliary_anastomosis |
0..1 | CodeableConcept | type_surgical_biliary_anastomosis – biliary reconstruction type (liver only) URL: https://hl7.eu/fhir/ig/hl7.eu.fhir.protect-child/StructureDefinition/transplant-biliary-anastomosis-type Binding: Type of surgical biliary anastomosis ValueSet (preferred) | |||||
| extension:intraoperative_complications |
0..* | CodeableConcept | intraoperative_complications – complications during surgery (liver only) URL: https://hl7.eu/fhir/ig/hl7.eu.fhir.protect-child/StructureDefinition/transplant-intraoperative-complications Binding: Intraoperative Complications ValueSet (preferred) | |||||
| extension:intraoperative_complications_other |
0..1 | string | intraoperative_complications_other – free text for other complications URL: https://hl7.eu/fhir/ig/hl7.eu.fhir.protect-child/StructureDefinition/transplant-intraoperative-complications-other | |||||
| extension:nephrectomy_original_kidney |
0..1 | boolean | nephrectomy_original_kidney – nephrectomy of native kidney (kidney only) URL: https://hl7.eu/fhir/ig/hl7.eu.fhir.protect-child/StructureDefinition/transplant-nephrectomy-original-kidney | |||||
| extension:kidney_side |
0..1 | CodeableConcept | kidney_side – transplanted kidney side (left/right/both) URL: https://hl7.eu/fhir/ig/hl7.eu.fhir.protect-child/StructureDefinition/transplant-kidney-side Binding: Kidney Side ValueSet (preferred) | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
SΣ | 1..* | Identifier | transplant_id – transplant identifier from the data model | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system |
SΣ | 1..1 | uri | Namespace for the transplant identifier Example General: http://www.acme.com/identifiers/patient | ||||
| value |
SΣ | 1..1 | string | Transplant ID (transplant_id) Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| status |
?!SΣ | 1..1 | code | Status of the transplant encounter Binding: EncounterStatus (required): Current state of the encounter. | ||||
| statusHistory |
0..* | BackboneElement | List of past encounter statuses | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| status |
1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. | |||||
| period |
1..1 | Period | The time that the episode was in the specified status | |||||
| class |
SΣ | 1..1 | Coding | Classification of encounter (e.g. inpatient) Binding: ActEncounterCode (extensible): Classification of the encounter. | ||||
| classHistory |
0..* | BackboneElement | List of past encounter classes | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| class |
1..1 | Coding | inpatient | outpatient | ambulatory | emergency + Binding: ActEncounterCode (extensible): Classification of the encounter. | |||||
| period |
1..1 | Period | The time that the episode was in the specified class | |||||
| type |
SΣ | 1..1 | CodeableConcept | tx_type – transplant type (liver, kidney, combined) Binding: Transplant Type ValueSet (required): The type of encounter. | ||||
| serviceType |
Σ | 0..1 | CodeableConcept | Specific type of service Binding: ServiceType (example): Broad categorization of the service that is to be provided. | ||||
| priority |
0..1 | CodeableConcept | Indicates the urgency of the encounter Binding: ActPriority (example): Indicates the urgency of the encounter. | |||||
| subject |
SΣ | 1..1 | Reference(Transplant Recipient) | patient_id – the transplant recipient (PatientTransplant) | ||||
| episodeOfCare |
Σ | 0..* | Reference(EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against | ||||
| basedOn |
0..* | Reference(ServiceRequest) | The ServiceRequest that initiated this encounter | |||||
| participant |
Σ | 0..* | BackboneElement | List of participants involved in the encounter | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type |
Σ | 0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. | ||||
| period |
0..1 | Period | Period of time during the encounter that the participant participated | |||||
| individual |
Σ | 0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson) | Persons involved in the encounter other than the patient | ||||
| appointment |
Σ | 0..* | Reference(Appointment) | The appointment that scheduled this encounter | ||||
| period |
S | 1..1 | Period | The start and end time of the encounter | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| start |
SΣC | 1..1 | dateTime | date_tx – date (and optionally time) of the transplant | ||||
| end |
ΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
| length |
0..1 | Duration | Quantity of time the encounter lasted (less time absent) | |||||
| reasonCode |
Σ | 0..* | CodeableConcept | Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. | ||||
| reasonReference |
Σ | 0..* | Reference(Condition | Procedure | Observation | ImmunizationRecommendation) | Reason the encounter takes place (reference) | ||||
| diagnosis |
Σ | 0..* | BackboneElement | The list of diagnosis relevant to this encounter | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| condition |
Σ | 1..1 | Reference(Condition | Procedure) | The diagnosis or procedure relevant to the encounter | ||||
| use |
0..1 | CodeableConcept | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents. | |||||
| rank |
0..1 | positiveInt | Ranking of the diagnosis (for each role type) | |||||
| account |
0..* | Reference(Account) | The set of accounts that may be used for billing for this Encounter | |||||
| hospitalization |
0..1 | BackboneElement | Details about the admission to a healthcare service | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| preAdmissionIdentifier |
0..1 | Identifier | Pre-admission identifier | |||||
| origin |
0..1 | Reference(Location | Organization) | The location/organization from which the patient came before admission | |||||
| admitSource |
0..1 | CodeableConcept | From where patient was admitted (physician referral, transfer) Binding: AdmitSource (preferred): From where the patient was admitted. | |||||
| reAdmission |
0..1 | CodeableConcept | The type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission Binding: hl7VS-re-admissionIndicator (example): The reason for re-admission of this hospitalization encounter. | |||||
| dietPreference |
0..* | CodeableConcept | Diet preferences reported by the patient Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements. | |||||
| specialCourtesy |
0..* | CodeableConcept | Special courtesies (VIP, board member) Binding: SpecialCourtesy (preferred): Special courtesies. | |||||
| specialArrangement |
0..* | CodeableConcept | Wheelchair, translator, stretcher, etc. Binding: SpecialArrangements (preferred): Special arrangements. | |||||
| destination |
0..1 | Reference(Location | Organization) | Location/organization to which the patient is discharged | |||||
| dischargeDisposition |
0..1 | CodeableConcept | Category or kind of location after discharge Binding: DischargeDisposition (example): Discharge Disposition. | |||||
| location |
0..* | BackboneElement | List of locations where the patient has been | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| location |
1..1 | Reference(Location) | Location the encounter takes place | |||||
| status |
0..1 | code | planned | active | reserved | completed Binding: EncounterLocationStatus (required): The status of the location. | |||||
| physicalType |
0..1 | CodeableConcept | The physical type of the location (usually the level in the location hierachy - bed room ward etc.) Binding: LocationType (example): Physical form of the location. | |||||
| period |
0..1 | Period | Time period during which the patient was present at the location | |||||
| serviceProvider |
0..1 | Reference(Organization) | The organization (facility) responsible for this encounter | |||||
| partOf |
0..1 | Reference(Encounter) | Another Encounter this encounter is part of | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Encounter.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Encounter.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Encounter.identifier.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Encounter.status | Base | required | EncounterStatus | 📍4.0.1 | FHIR Std. |
| Encounter.statusHistory.status | Base | required | EncounterStatus | 📍4.0.1 | FHIR Std. |
| Encounter.class | Base | extensible | ActEncounterCode | 📦3.0.0 | THO v7.0 |
| Encounter.classHistory.class | Base | extensible | ActEncounterCode | 📦3.0.0 | THO v7.0 |
| Encounter.type | Base | required | Transplant Type ValueSet | 📦0.1.0-ci-build | This IG |
| Encounter.serviceType | Base | example | Service type | 📍4.0.1 | FHIR Std. |
| Encounter.priority | Base | example | ActPriority | 📦3.0.0 | THO v7.0 |
| Encounter.participant.type | Base | extensible | Participant type | 📍4.0.1 | FHIR Std. |
| Encounter.reasonCode | Base | preferred | Encounter Reason Codes | 📍4.0.1 | FHIR Std. |
| Encounter.diagnosis.use | Base | preferred | DiagnosisRole | 📍4.0.1 | FHIR Std. |
| Encounter.hospitalization.admitSource | Base | preferred | Admit source | 📍4.0.1 | FHIR Std. |
| Encounter.hospitalization.reAdmission | Base | example | hl7VS-re-admissionIndicator | 📦2.0.0 | THO v7.0 |
| Encounter.hospitalization.dietPreference | Base | example | Diet | 📍4.0.1 | FHIR Std. |
| Encounter.hospitalization.specialCourtesy | Base | preferred | Special courtesy | 📍4.0.1 | FHIR Std. |
| Encounter.hospitalization.specialArrangement | Base | preferred | Special arrangements | 📍4.0.1 | FHIR Std. |
| Encounter.hospitalization.dischargeDisposition | Base | example | Discharge disposition | 📍4.0.1 | FHIR Std. |
| Encounter.location.status | Base | required | EncounterLocationStatus | 📍4.0.1 | FHIR Std. |
| Encounter.location.physicalType | Base | example | Location type | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Encounter | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Encounter | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Encounter | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from Encounter
Summary
Mandatory: 13 elements
Must-Support: 14 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Other representations of profile: CSV, Excel, Schematron
