hl7-eu-logo
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, 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

Resource Profile: Immunological Data Report ( Experimental )

Official URL: https://hl7.eu/fhir/ig/hl7.eu.fhir.protect-child/StructureDefinition/immunological-data-report Version: 0.1.0-ci-build
Draft as of 2026-09-28 Computable Name: ImmunologicalDataReport

Groups the immunological results recorded on one DMv1.2 immunological_data row: blood typing, HLA typing, anti-HLA antibodies and ANCA. Each result is its own Observation in result, because one row mixes several tests that have their own specimen, date and performer. The biopsy findings on the same row (banff_category, ihc_if_c4d, if, c4d) become a separate GraftBiopsy carrying the same immunological_data_id. The subject is the recipient, or the Donor for donor-side typing (donor_id); every result SHALL have the same subject as the report.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DiagnosticReport 0..* DiagnosticReportEuCore Diagnostic Report EU core
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension Content/Rules for all slices
.... extension:DiagnosticReportCompositionR5 0..1 (Complex) Associated Composition
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.composition
Constraints: ext-1
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.composition"
..... value[x] 1..1 Reference(Composition (EU core)) Reference to a Composition resource for the DiagnosticReport structure
.... extension:note 0..* (Complex) R5: Comments about the diagnostic report (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.note
Constraints: ext-1
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.note"
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: https://hl7.eu/fhir/ig/hl7.eu.fhir.protect-child/NamingSystem/protect-child-id
.... value Σ 1..1 string The value that is unique
Example General: 123456
... status ?!SΣ 1..1 code Status of the Report
Binding: DiagnosticReportStatus (required): The status of the diagnostic report.
... category SΣ 1..1 CodeableConcept Service category
Binding: DiagnosticServiceSectionCodes (example): Codes for diagnostic service sections.

Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0074
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: IMM
..... display 1..1 string Representation defined by the system
Fixed Value: Immunology
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... text 0..1 string Plain text representation of the concept
... code SΣ 1..1 CodeableConcept Type of Diagnostic Report
Binding: LOINCDiagnosticReportCodes (preferred): Codes that describe Diagnostic Reports.
Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: https://hl7.eu/fhir/ig/hl7.eu.fhir.protect-child/CodeSystem/immunological-data-panel-cs
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: immunological-data-panel
..... display 1..1 string Representation defined by the system
Fixed Value: Immunological data report
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... text 0..1 string Plain text representation of the concept
... subject SΣ 1..1 Reference(Transplant Recipient | Transplant Donor) Recipient, or Donor for donor-side typing (donor_id)
... encounter SΣ 1..1 Reference(Visit) visit_id — recipient Visit at which the data was recorded (also for donor-side typing)
... Slices for effective[x] SΣ 0..1 Clinically relevant time/time-period for report.
Slice: Unordered, Closed by type:$this
.... effectiveDateTime dateTime
.... effectivePeriod Period
.... effective[x]:effectivePeriod SΣ 0..1 Period Effective period of the report
.... effective[x]:effectiveDateTime SΣ 0..1 dateTime Clinically relevant time/time-period for report.
... Slices for performer Σ 0..* Reference(PractitionerRole (EU core) | Practitioner (EU core) | Organization (EU core) | CareTeam) Responsible Diagnostic Service.
Slice: Unordered, Open by profile:resolve()
.... performer:organization Σ 0..* Reference(Organization (EU core)) The organization producer of this report
... Slices for resultsInterpreter Σ 0..* Reference(PractitionerRole (EU core) | Practitioner (EU core) | Organization (EU core) | CareTeam) Primary result interpreter
Slice: Unordered, Open by profile:resolve()
.... resultsInterpreter:author Σ 0..* Reference(PractitionerRole (EU core)) Primary result interpreter
... result S 0..* Reference(Blood Group Observation | HLA Typing | Anti-HLA Antibody Screen | Anti-HLA Antibody | ANCA Observation) One Observation per result

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DiagnosticReport.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
DiagnosticReport.status Base required DiagnosticReportStatus 📍4.0.1 FHIR Std.
DiagnosticReport.category Base example Diagnostic Service Section Codes 📍4.0.1 FHIR Std.
DiagnosticReport.code Base preferred LOINC Diagnostic Report Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error DiagnosticReport If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error DiagnosticReport 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 DiagnosticReport 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 DiagnosticReport If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice DiagnosticReport 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 DiagnosticReport.extension:DiagnosticReportCompositionR5, DiagnosticReport.extension:note, DiagnosticReport.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from DiagnosticReportEuCore

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DiagnosticReport 0..* DiagnosticReportEuCore Diagnostic Report EU core
... identifier S 1..1 Identifier immunological_data_id
.... system 1..1 uri The namespace for the identifier value
Fixed Value: https://hl7.eu/fhir/ig/hl7.eu.fhir.protect-child/NamingSystem/protect-child-id
.... value 1..1 string The value that is unique
... status S 1..1 code Status of the Report
... category S 1..1 CodeableConcept Service category
Required Pattern: At least the following
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0074
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: IMM
..... display 1..1 string Representation defined by the system
Fixed Value: Immunology
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... system 1..1 uri Identity of the terminology system
Fixed Value: https://hl7.eu/fhir/ig/hl7.eu.fhir.protect-child/CodeSystem/immunological-data-panel-cs
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: immunological-data-panel
..... display 1..1 string Representation defined by the system
Fixed Value: Immunological data report
... subject S 1..1 Reference(Transplant Recipient | Transplant Donor) Recipient, or Donor for donor-side typing (donor_id)
... encounter S 1..1 Reference(Visit) visit_id — recipient Visit at which the data was recorded (also for donor-side typing)
... Slices for effective[x] S 0..1 dateTime, Period Clinically relevant time/time-period for report.
Slice: Unordered, Open by type:$this
.... effective[x]:effectivePeriod S 0..1 Period Effective period of the report
.... effective[x]:effectiveDateTime S 0..1 dateTime Clinically relevant time/time-period for report.
... result S 0..* Reference(Blood Group Observation | HLA Typing | Anti-HLA Antibody Screen | Anti-HLA Antibody | ANCA Observation) One Observation per result

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DiagnosticReport 0..* DiagnosticReportEuCore Diagnostic Report EU core
... 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
... 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 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:DiagnosticReportCompositionR5 0..1 (Complex) Associated Composition
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.composition
Constraints: ext-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.composition"
..... value[x] 1..1 Reference(Composition (EU core)) Reference to a Composition resource for the DiagnosticReport structure
.... extension:note 0..* (Complex) R5: Comments about the diagnostic report (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.note
Constraints: ext-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.note"
..... value[x] 0..1 Annotation Comments about the diagnostic report
...... id 0..1 string Unique id for inter-element referencing
...... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... Slices for extension Content/Rules for all slices
....... extension:annotation-type 0..* (Complex) The type of annotation
URL: http://hl7.org/fhir/StructureDefinition/annotationType
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..0 Extension
Slice: Unordered, Open by value:url
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/annotationType"
........ value[x] 1..1 CodeableConcept Type of note
Binding: Hl7VSCommentType (3.0.0) (example)
...... author[x] Σ 0..1 Individual responsible for the annotation
....... authorReference Reference(Practitioner | Patient | RelatedPerson | Organization)
....... authorString string
...... time Σ 0..1 dateTime When the annotation was made
...... text Σ 1..1 markdown The annotation - text content (as markdown)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 1..1 Identifier immunological_data_id
.... 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 Σ 1..1 uri The namespace for the identifier value
Fixed Value: https://hl7.eu/fhir/ig/hl7.eu.fhir.protect-child/NamingSystem/protect-child-id
.... value Σ 1..1 string The value that is unique
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)
... basedOn 0..* Reference(CarePlan | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) What was requested
... status ?!SΣ 1..1 code Status of the Report
Binding: DiagnosticReportStatus (required): The status of the diagnostic report.
... category SΣ 1..1 CodeableConcept Service category
Binding: DiagnosticServiceSectionCodes (example): Codes for diagnostic service sections.

Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0074
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: IMM
..... display 1..1 string Representation defined by the system
Fixed Value: Immunology
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... text 0..1 string Plain text representation of the concept
... code SΣ 1..1 CodeableConcept Type of Diagnostic Report
Binding: LOINCDiagnosticReportCodes (preferred): Codes that describe Diagnostic Reports.
Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: https://hl7.eu/fhir/ig/hl7.eu.fhir.protect-child/CodeSystem/immunological-data-panel-cs
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: immunological-data-panel
..... display 1..1 string Representation defined by the system
Fixed Value: Immunological data report
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... text 0..1 string Plain text representation of the concept
... subject SΣ 1..1 Reference(Transplant Recipient | Transplant Donor) Recipient, or Donor for donor-side typing (donor_id)
... encounter SΣ 1..1 Reference(Visit) visit_id — recipient Visit at which the data was recorded (also for donor-side typing)
... Slices for effective[x] SΣ 0..1 Clinically relevant time/time-period for report.
Slice: Unordered, Closed by type:$this
.... effectiveDateTime dateTime
.... effectivePeriod Period
.... effective[x]:effectivePeriod SΣ 0..1 Period Effective period of the report
.... effective[x]:effectiveDateTime SΣ 0..1 dateTime Clinically relevant time/time-period for report.
... issued Σ 0..1 instant Date and time this report was issued
... Slices for performer Σ 0..* Reference(PractitionerRole (EU core) | Practitioner (EU core) | Organization (EU core) | CareTeam) Responsible Diagnostic Service.
Slice: Unordered, Open by profile:resolve()
.... performer:organization Σ 0..* Reference(Organization (EU core)) The organization producer of this report
... Slices for resultsInterpreter Σ 0..* Reference(PractitionerRole (EU core) | Practitioner (EU core) | Organization (EU core) | CareTeam) Primary result interpreter
Slice: Unordered, Open by profile:resolve()
.... resultsInterpreter:author Σ 0..* Reference(PractitionerRole (EU core)) Primary result interpreter
... specimen 0..* Reference(Specimen) Specimens this report is based on.
... result S 0..* Reference(Blood Group Observation | HLA Typing | Anti-HLA Antibody Screen | Anti-HLA Antibody | ANCA Observation) One Observation per result
... imagingStudy 0..* Reference(ImagingStudy) Study subject to this report
... media Σ 0..* BackboneElement Additional data (like images, diagrams or documents) associated with this report
.... 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
.... comment 0..1 string Comment about the image or data (e.g. explanation)
.... link Σ 1..1 Reference(Media) Reference to the image or data
... conclusion 0..1 string Clinical conclusion (interpretation) of test results
... conclusionCode 0..* CodeableConcept Codes for the clinical conclusion of test results
Binding: SNOMEDCTClinicalFindings (example): Diagnosis codes provided as adjuncts to the report.
... presentedForm 0..* Attachment Entire report as issued (pdf recommended)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DiagnosticReport.language Base preferred Common Languages 📍4.0.1 FHIR Std.
DiagnosticReport.extension:note.​value[x].extension:annotation-type.​value[x] Base example hl7VS-commentType 📍3.0.0 THO v7.4
DiagnosticReport.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
DiagnosticReport.identifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
DiagnosticReport.status Base required DiagnosticReportStatus 📍4.0.1 FHIR Std.
DiagnosticReport.category Base example Diagnostic Service Section Codes 📍4.0.1 FHIR Std.
DiagnosticReport.code Base preferred LOINC Diagnostic Report Codes 📍4.0.1 FHIR Std.
DiagnosticReport.conclusionCode Base example SNOMED CT Clinical Findings 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error DiagnosticReport If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error DiagnosticReport 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 DiagnosticReport 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 DiagnosticReport If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice DiagnosticReport 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()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DiagnosticReport 0..* DiagnosticReportEuCore Diagnostic Report EU core
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension Content/Rules for all slices
.... extension:DiagnosticReportCompositionR5 0..1 (Complex) Associated Composition
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.composition
Constraints: ext-1
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.composition"
..... value[x] 1..1 Reference(Composition (EU core)) Reference to a Composition resource for the DiagnosticReport structure
.... extension:note 0..* (Complex) R5: Comments about the diagnostic report (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.note
Constraints: ext-1
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.note"
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: https://hl7.eu/fhir/ig/hl7.eu.fhir.protect-child/NamingSystem/protect-child-id
.... value Σ 1..1 string The value that is unique
Example General: 123456
... status ?!SΣ 1..1 code Status of the Report
Binding: DiagnosticReportStatus (required): The status of the diagnostic report.
... category SΣ 1..1 CodeableConcept Service category
Binding: DiagnosticServiceSectionCodes (example): Codes for diagnostic service sections.

Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0074
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: IMM
..... display 1..1 string Representation defined by the system
Fixed Value: Immunology
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... text 0..1 string Plain text representation of the concept
... code SΣ 1..1 CodeableConcept Type of Diagnostic Report
Binding: LOINCDiagnosticReportCodes (preferred): Codes that describe Diagnostic Reports.
Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: https://hl7.eu/fhir/ig/hl7.eu.fhir.protect-child/CodeSystem/immunological-data-panel-cs
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: immunological-data-panel
..... display 1..1 string Representation defined by the system
Fixed Value: Immunological data report
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... text 0..1 string Plain text representation of the concept
... subject SΣ 1..1 Reference(Transplant Recipient | Transplant Donor) Recipient, or Donor for donor-side typing (donor_id)
... encounter SΣ 1..1 Reference(Visit) visit_id — recipient Visit at which the data was recorded (also for donor-side typing)
... Slices for effective[x] SΣ 0..1 Clinically relevant time/time-period for report.
Slice: Unordered, Closed by type:$this
.... effectiveDateTime dateTime
.... effectivePeriod Period
.... effective[x]:effectivePeriod SΣ 0..1 Period Effective period of the report
.... effective[x]:effectiveDateTime SΣ 0..1 dateTime Clinically relevant time/time-period for report.
... Slices for performer Σ 0..* Reference(PractitionerRole (EU core) | Practitioner (EU core) | Organization (EU core) | CareTeam) Responsible Diagnostic Service.
Slice: Unordered, Open by profile:resolve()
.... performer:organization Σ 0..* Reference(Organization (EU core)) The organization producer of this report
... Slices for resultsInterpreter Σ 0..* Reference(PractitionerRole (EU core) | Practitioner (EU core) | Organization (EU core) | CareTeam) Primary result interpreter
Slice: Unordered, Open by profile:resolve()
.... resultsInterpreter:author Σ 0..* Reference(PractitionerRole (EU core)) Primary result interpreter
... result S 0..* Reference(Blood Group Observation | HLA Typing | Anti-HLA Antibody Screen | Anti-HLA Antibody | ANCA Observation) One Observation per result

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DiagnosticReport.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
DiagnosticReport.status Base required DiagnosticReportStatus 📍4.0.1 FHIR Std.
DiagnosticReport.category Base example Diagnostic Service Section Codes 📍4.0.1 FHIR Std.
DiagnosticReport.code Base preferred LOINC Diagnostic Report Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error DiagnosticReport If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error DiagnosticReport 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 DiagnosticReport 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 DiagnosticReport If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice DiagnosticReport 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 DiagnosticReport.extension:DiagnosticReportCompositionR5, DiagnosticReport.extension:note, DiagnosticReport.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

This structure is derived from DiagnosticReportEuCore

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DiagnosticReport 0..* DiagnosticReportEuCore Diagnostic Report EU core
... identifier S 1..1 Identifier immunological_data_id
.... system 1..1 uri The namespace for the identifier value
Fixed Value: https://hl7.eu/fhir/ig/hl7.eu.fhir.protect-child/NamingSystem/protect-child-id
.... value 1..1 string The value that is unique
... status S 1..1 code Status of the Report
... category S 1..1 CodeableConcept Service category
Required Pattern: At least the following
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0074
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: IMM
..... display 1..1 string Representation defined by the system
Fixed Value: Immunology
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... system 1..1 uri Identity of the terminology system
Fixed Value: https://hl7.eu/fhir/ig/hl7.eu.fhir.protect-child/CodeSystem/immunological-data-panel-cs
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: immunological-data-panel
..... display 1..1 string Representation defined by the system
Fixed Value: Immunological data report
... subject S 1..1 Reference(Transplant Recipient | Transplant Donor) Recipient, or Donor for donor-side typing (donor_id)
... encounter S 1..1 Reference(Visit) visit_id — recipient Visit at which the data was recorded (also for donor-side typing)
... Slices for effective[x] S 0..1 dateTime, Period Clinically relevant time/time-period for report.
Slice: Unordered, Open by type:$this
.... effective[x]:effectivePeriod S 0..1 Period Effective period of the report
.... effective[x]:effectiveDateTime S 0..1 dateTime Clinically relevant time/time-period for report.
... result S 0..* Reference(Blood Group Observation | HLA Typing | Anti-HLA Antibody Screen | Anti-HLA Antibody | ANCA Observation) One Observation per result

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DiagnosticReport 0..* DiagnosticReportEuCore Diagnostic Report EU core
... 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
... 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 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:DiagnosticReportCompositionR5 0..1 (Complex) Associated Composition
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.composition
Constraints: ext-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.composition"
..... value[x] 1..1 Reference(Composition (EU core)) Reference to a Composition resource for the DiagnosticReport structure
.... extension:note 0..* (Complex) R5: Comments about the diagnostic report (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.note
Constraints: ext-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.note"
..... value[x] 0..1 Annotation Comments about the diagnostic report
...... id 0..1 string Unique id for inter-element referencing
...... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... Slices for extension Content/Rules for all slices
....... extension:annotation-type 0..* (Complex) The type of annotation
URL: http://hl7.org/fhir/StructureDefinition/annotationType
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..0 Extension
Slice: Unordered, Open by value:url
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/annotationType"
........ value[x] 1..1 CodeableConcept Type of note
Binding: Hl7VSCommentType (3.0.0) (example)
...... author[x] Σ 0..1 Individual responsible for the annotation
....... authorReference Reference(Practitioner | Patient | RelatedPerson | Organization)
....... authorString string
...... time Σ 0..1 dateTime When the annotation was made
...... text Σ 1..1 markdown The annotation - text content (as markdown)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 1..1 Identifier immunological_data_id
.... 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 Σ 1..1 uri The namespace for the identifier value
Fixed Value: https://hl7.eu/fhir/ig/hl7.eu.fhir.protect-child/NamingSystem/protect-child-id
.... value Σ 1..1 string The value that is unique
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)
... basedOn 0..* Reference(CarePlan | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) What was requested
... status ?!SΣ 1..1 code Status of the Report
Binding: DiagnosticReportStatus (required): The status of the diagnostic report.
... category SΣ 1..1 CodeableConcept Service category
Binding: DiagnosticServiceSectionCodes (example): Codes for diagnostic service sections.

Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0074
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: IMM
..... display 1..1 string Representation defined by the system
Fixed Value: Immunology
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... text 0..1 string Plain text representation of the concept
... code SΣ 1..1 CodeableConcept Type of Diagnostic Report
Binding: LOINCDiagnosticReportCodes (preferred): Codes that describe Diagnostic Reports.
Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: https://hl7.eu/fhir/ig/hl7.eu.fhir.protect-child/CodeSystem/immunological-data-panel-cs
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: immunological-data-panel
..... display 1..1 string Representation defined by the system
Fixed Value: Immunological data report
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... text 0..1 string Plain text representation of the concept
... subject SΣ 1..1 Reference(Transplant Recipient | Transplant Donor) Recipient, or Donor for donor-side typing (donor_id)
... encounter SΣ 1..1 Reference(Visit) visit_id — recipient Visit at which the data was recorded (also for donor-side typing)
... Slices for effective[x] SΣ 0..1 Clinically relevant time/time-period for report.
Slice: Unordered, Closed by type:$this
.... effectiveDateTime dateTime
.... effectivePeriod Period
.... effective[x]:effectivePeriod SΣ 0..1 Period Effective period of the report
.... effective[x]:effectiveDateTime SΣ 0..1 dateTime Clinically relevant time/time-period for report.
... issued Σ 0..1 instant Date and time this report was issued
... Slices for performer Σ 0..* Reference(PractitionerRole (EU core) | Practitioner (EU core) | Organization (EU core) | CareTeam) Responsible Diagnostic Service.
Slice: Unordered, Open by profile:resolve()
.... performer:organization Σ 0..* Reference(Organization (EU core)) The organization producer of this report
... Slices for resultsInterpreter Σ 0..* Reference(PractitionerRole (EU core) | Practitioner (EU core) | Organization (EU core) | CareTeam) Primary result interpreter
Slice: Unordered, Open by profile:resolve()
.... resultsInterpreter:author Σ 0..* Reference(PractitionerRole (EU core)) Primary result interpreter
... specimen 0..* Reference(Specimen) Specimens this report is based on.
... result S 0..* Reference(Blood Group Observation | HLA Typing | Anti-HLA Antibody Screen | Anti-HLA Antibody | ANCA Observation) One Observation per result
... imagingStudy 0..* Reference(ImagingStudy) Study subject to this report
... media Σ 0..* BackboneElement Additional data (like images, diagrams or documents) associated with this report
.... 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
.... comment 0..1 string Comment about the image or data (e.g. explanation)
.... link Σ 1..1 Reference(Media) Reference to the image or data
... conclusion 0..1 string Clinical conclusion (interpretation) of test results
... conclusionCode 0..* CodeableConcept Codes for the clinical conclusion of test results
Binding: SNOMEDCTClinicalFindings (example): Diagnosis codes provided as adjuncts to the report.
... presentedForm 0..* Attachment Entire report as issued (pdf recommended)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DiagnosticReport.language Base preferred Common Languages 📍4.0.1 FHIR Std.
DiagnosticReport.extension:note.​value[x].extension:annotation-type.​value[x] Base example hl7VS-commentType 📍3.0.0 THO v7.4
DiagnosticReport.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
DiagnosticReport.identifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
DiagnosticReport.status Base required DiagnosticReportStatus 📍4.0.1 FHIR Std.
DiagnosticReport.category Base example Diagnostic Service Section Codes 📍4.0.1 FHIR Std.
DiagnosticReport.code Base preferred LOINC Diagnostic Report Codes 📍4.0.1 FHIR Std.
DiagnosticReport.conclusionCode Base example SNOMED CT Clinical Findings 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error DiagnosticReport If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error DiagnosticReport 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 DiagnosticReport 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 DiagnosticReport If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice DiagnosticReport 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()

 

Other representations of profile: CSV, Excel, Schematron