Nictiz FHIR NL STU3 Zib2017
1.3.15 - CI Build
Nictiz FHIR NL STU3 Zib2017 - Local Development build (v1.3.15) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Active as of 2024-04-09 |
Definitions for the zib-LaboratoryTestResult-DiagnosticReport resource profile.
Guidance on how to interpret the contents of this table can be found here
0. DiagnosticReport | |
Definition | The findings and interpretation of diagnostic tests performed on patients, groups of patients, devices, and locations, and/or specimens derived from these. The report includes clinical context such as requesting and provider information, and some mix of atomic results, images, textual and coded interpretations, and formatted representation of diagnostic reports. The HCIM LaboratoryResult also supports simple and more complex situations. For a simple result there will be a single LaboratoryTestResult.LaboratoryTest.TestName in Observation.code and no LaboratoryTestresult.Test. For a more complex situation there will be a LaboratoryTestResult.Test and any number of related LaboratoryTestResult.LaboratoryTest, e.g. parts of a panel or battery. Each related LaboratoryTest shall be conveyed in Observation.related or Observation.component. The deciding factor in choosing between related or component is: does the observation have use as independent observation (Observation.related) or is the observation only relevant in the context of its parent (Observation.component). Note that (textual) reports on individual (panels of) observations, like conclusions, go into a different resource DiagnosticReport. The DiagnosticReport then contains the references to the Observation resources it concerns. |
Short | LaboratoryTestResult |
Alternate Names | LaboratoriumUitslag |
2. DiagnosticReport.identifier | |
Short | Identifier |
Note | This is a business identifier, not a resource identifier (see discussion) |
Alternate Names | Identificatie |
4. DiagnosticReport.basedOn | |
Short | Fulfills plan, proposal or order including requester information. |
Comments | Requester information should be captured and exchanged in the resource ProcedureRequest referenced by basedOn. Requester is the healthcare provider and/or organization where or by whom the LaboratoryTestResult was requested. There are a few required elements in ProcedureRequest - ProcedureRequest.status (use fixed value "active", unless you know what the actual value is) - ProcedureRequest.intent (use fixed value "order", unless you know what the actual value is) - ProcedureRequest.code (use extension http://hl7.org/fhir/STU3/extension-iso21090-nullflavor.html met valueCode UNK, unless you know what the actual value is) - ProcedureRequest.subject (equal to DiagnosticReport.subject) - ProcedureRequest.requester.agent (contains the requesting HealthProfessional) |
Alternate Names | Aanvrager |
6. DiagnosticReport.status | |
Short | ResultStatus |
Alternate Names | ResultaatStatus |
8. DiagnosticReport.status.extension | |
Slicing | This element introduces a set of slices on DiagnosticReport.status.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
10. DiagnosticReport.status.extension:ResultStatus | |
Slice Name | ResultStatus |
Definition | Defines a more specific value to a code. Especially useful for FHIRs required ValueSets. |
Short | Provides the specific HCIM code for ResultStatus |
Control | 0..1 |
Binding | Unless not suitable, these codes SHALL be taken from ResultaatStatusCodelijst (extensible to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.13.1.8--20171231000000 ) |
Type | Extension(HCIM extension code-specification) (Extension Type: CodeableConcept) |
Alternate Names | ResultaatStatus |
12. DiagnosticReport.category | |
Control | 1..? |
14. DiagnosticReport.category.coding | |
Control | 2..? |
Slicing | This element introduces a set of slices on DiagnosticReport.category.coding . The slices are unordered and Open, and can be differentiated using the following discriminators: |
16. DiagnosticReport.category.coding:laboratoryTestResultCode | |
Slice Name | laboratoryTestResultCode |
Definition | Category code used for indexing/retrieval of the ZIB LaboratoryTestResult. The system and code and display values are fixed. |
Short | LaboratoryTestResultCode |
Control | 1..1 |
18. DiagnosticReport.category.coding:laboratoryTestResultCode.system | |
Fixed Value | http://snomed.info/sct |
20. DiagnosticReport.category.coding:laboratoryTestResultCode.code | |
Fixed Value | 4241000179101 |
22. DiagnosticReport.category.coding:laboratoryTestResultCode.display | |
Default Value | Laboratory report (record artifact) |
24. DiagnosticReport.category.coding:resultType | |
Slice Name | resultType |
Definition | The type of result defines the laboratory specialty under which the test is categorized. |
Short | ResultType |
Control | 1..1 |
Binding | Unless not suitable, these codes SHALL be taken from ResultaatTypeCodelijst (extensible to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.13.1.1--20171231000000 )ResultaatTypeCodelijst |
Alternate Names | ResultaatType |
26. DiagnosticReport.code | |
Definition | For laboratory tests comprising multiple subtests and often requested together as a whole, this concept contains the name of the compound request (often indicated as a ‘panel’, ‘battery’ or ‘cluster’). Examples include: blood gases and EBV serology. |
Short | PanelOrBattery |
Binding | Unless not suitable, these codes SHALL be taken from OnderzoekCodelijst (extensible to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.13.1.5--20171231000000 )PanelOrBatteryCodelist |
Alternate Names | Onderzoek |
28. DiagnosticReport.subject | |
Type | Reference(nl-core-patient) |
30. DiagnosticReport.context | |
Type | Reference(nl-core-episodeofcare, HCIM Encounter, gp-Encounter) |
32. DiagnosticReport.effective[x] | |
[x] Note | See Choice of Data Types for further information about how to use [x] |
34. DiagnosticReport.performer | |
36. DiagnosticReport.performer.role | |
38. DiagnosticReport.performer.role.coding | |
Slicing | This element introduces a set of slices on DiagnosticReport.performer.role.coding . The slices are unordered and Open, and can be differentiated using the following discriminators: |
40. DiagnosticReport.performer.role.coding:healthProfessionalRole | |
Slice Name | healthProfessionalRole |
Definition | The role the healthcare provider fulfils in the healthcare process. For healthcare providers, this could be for example main practitioner, referrer or general practitioner. |
Short | HealthProfessionalRole |
Binding | Unless not suitable, these codes SHALL be taken from ZorgverlenerRolCodelijst (extensible to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.17.1.5--20171231000000 ) |
Alternate Names | ZorgverlenerRol |
42. DiagnosticReport.performer.actor | |
Type | Reference(nl-core-organization, nl-core-practitioner) |
44. DiagnosticReport.performer.actor.extension | |
Slicing | This element introduces a set of slices on DiagnosticReport.performer.actor.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
46. DiagnosticReport.performer.actor.extension:practitionerRole | |
Slice Name | practitionerRole |
Control | 0..1 |
Type | Extension(PractitionerRole Reference) (Extension Type: Reference) |
48. DiagnosticReport.specimen | |
Short | Specimen |
Type | Reference(HCIM LaboratoryTestResult Specimen, http://nictiz.nl/fhir/StructureDefinition/zib-LaboratoryTestResult-Isolate ) |
Alternate Names | Monster |
50. DiagnosticReport.result | |
Type | Reference(HCIM LaboratoryTestResult Observation) |
52. DiagnosticReport.conclusion | |
Definition | Concise and clinically contextualized impression / summary of the diagnostic report. Comments, such as a textual interpretation or advice accompanying the result, for example. |
Short | ResultInterpretation and/or Comment |
Alternate Names | UitslagInterpretatie en/of Toelichting |
Guidance on how to interpret the contents of this table can be found here
0. DiagnosticReport | |
Definition | The findings and interpretation of diagnostic tests performed on patients, groups of patients, devices, and locations, and/or specimens derived from these. The report includes clinical context such as requesting and provider information, and some mix of atomic results, images, textual and coded interpretations, and formatted representation of diagnostic reports. The HCIM LaboratoryResult also supports simple and more complex situations. For a simple result there will be a single LaboratoryTestResult.LaboratoryTest.TestName in Observation.code and no LaboratoryTestresult.Test. For a more complex situation there will be a LaboratoryTestResult.Test and any number of related LaboratoryTestResult.LaboratoryTest, e.g. parts of a panel or battery. Each related LaboratoryTest shall be conveyed in Observation.related or Observation.component. The deciding factor in choosing between related or component is: does the observation have use as independent observation (Observation.related) or is the observation only relevant in the context of its parent (Observation.component). Note that (textual) reports on individual (panels of) observations, like conclusions, go into a different resource DiagnosticReport. The DiagnosticReport then contains the references to the Observation resources it concerns. The findings and interpretation of diagnostic tests performed on patients, groups of patients, devices, and locations, and/or specimens derived from these. The report includes clinical context such as requesting and provider information, and some mix of atomic results, images, textual and coded interpretations, and formatted representation of diagnostic reports. |
Short | LaboratoryTestResultA Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports |
Comments | This is intended to capture a single report, and is not suitable for use in displaying summary information that covers multiple reports. For example, this resource has not been designed for laboratory cumulative reporting formats nor detailed structured reports for sequencing. |
Control | 0..* |
Alternate Names | Report, Test, Result, Results, Labs, Laboratory, LaboratoriumUitslag |
Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty() )dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative ( contained.text.empty() )dom-4: 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-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource ( contained.where(('#'+id in %resource.descendants().reference).not()).empty() )dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty()) dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (contained.text.empty()) dom-4: 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-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (contained.where(('#'+id in %resource.descendants().reference).not()).empty()) |
2. DiagnosticReport.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. |
Short | A set of rules under which this content was created |
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation. |
Control | 0..1 |
Type | uri |
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
4. DiagnosticReport.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order 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 is allowed to 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. |
Short | Extensions that cannot be ignored |
Comments | 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR |
Alternate Names | extensions, user content |
6. DiagnosticReport.identifier | |
Definition | Identifiers assigned to this report by the performer or other systems. |
Short | IdentifierBusiness identifier for report |
Comments | Usually assigned by the Information System of the diagnostic service provider (filler id). |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..* |
Type | Identifier |
Summary | true |
Requirements | Need to know what identifier to use when making queries about this report from the source laboratory, and for linking to the report outside FHIR context. |
Alternate Names | ReportID, Filler ID, Placer ID, Identificatie |
8. DiagnosticReport.basedOn | |
Definition | Details concerning a test or procedure requested. |
Short | Fulfills plan, proposal or order including requester information.What was requested |
Comments | Requester information should be captured and exchanged in the resource ProcedureRequest referenced by basedOn. Requester is the healthcare provider and/or organization where or by whom the LaboratoryTestResult was requested. There are a few required elements in ProcedureRequest - ProcedureRequest.status (use fixed value "active", unless you know what the actual value is) - ProcedureRequest.intent (use fixed value "order", unless you know what the actual value is) - ProcedureRequest.code (use extension http://hl7.org/fhir/STU3/extension-iso21090-nullflavor.html met valueCode UNK, unless you know what the actual value is) - ProcedureRequest.subject (equal to DiagnosticReport.subject) - ProcedureRequest.requester.agent (contains the requesting HealthProfessional) Note: Usually there is one test request for each result, however in some circumstances multiple test requests may be represented using a single test result resource. Note that there are also cases where one request leads to multiple reports. |
Control | 0..* |
Type | Reference(CarePlan, ImmunizationRecommendation, MedicationRequest, NutritionOrder, ProcedureRequest, ReferralRequest) |
Requirements | This allows tracing of authorization for the report and tracking whether proposals/recommendations were acted upon. |
Alternate Names | Request, Aanvrager |
10. DiagnosticReport.status | |
Definition | The status of the diagnostic report as a whole. |
Short | ResultStatusregistered | partial | preliminary | final + |
Comments | This is labeled as "Is Modifier" because applications need to take appropriate action if a report is withdrawn. |
Control | 1..1 |
Binding | The codes SHALL be taken from DiagnosticReportStatushttp://hl7.org/fhir/ValueSet/diagnostic-report-status (required to http://hl7.org/fhir/ValueSet/diagnostic-report-status )The status of the diagnostic report as a whole. |
Type | code |
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Diagnostic services routinely issue provisional/incomplete reports, and sometimes withdraw previously released reports. |
Alternate Names | ResultaatStatus |
12. DiagnosticReport.status.extension | |
Definition | An Extension May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Short | ExtensionAdditional Content defined by implementations |
Comments | 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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Slicing | This element introduces a set of slices on DiagnosticReport.status.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
14. DiagnosticReport.status.extension:ResultStatus | |
Slice Name | ResultStatus |
Definition | Defines a more specific value to a code. Especially useful for FHIRs required ValueSets. |
Short | Provides the specific HCIM code for ResultStatus |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(HCIM extension code-specification) (Extension Type: CodeableConcept) |
Alternate Names | Bevat de specifieke code conform de zib, bij een FHIR-element die een verplichte koppeling heeft met een bepaalde FHIR waardelijst of een FHIR element die niet gecodeerd is gedefinieerd, terwijl de zib dit wel doet., ResultaatStatus |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
16. DiagnosticReport.category | |
Definition | A code that classifies the clinical discipline, department or diagnostic service that created the report (e.g. cardiology, biochemistry, hematology, MRI). This is used for searching, sorting and display purposes. |
Short | Service category |
Comments | The level of granularity is defined by the category concepts in the value set. More fine-grained filtering can be performed using the metadata and/or terminology hierarchy in DiagnosticReport.code. |
Control | 10..1 |
Binding | For example codes, see Diagnostic Service Section Codeshttp://hl7.org/fhir/ValueSet/diagnostic-service-sections (example to http://hl7.org/fhir/ValueSet/diagnostic-service-sections )Codes for diagnostic service sections. |
Type | CodeableConcept |
Summary | true |
Alternate Names | Department, Sub-department, Service, Discipline |
18. DiagnosticReport.category.coding | |
Definition | A reference to a code defined by a terminology system. |
Short | Code defined by a terminology system |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
Control | 20..* |
Type | Coding |
Summary | true |
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. |
Slicing | This element introduces a set of slices on DiagnosticReport.category.coding . The slices are unordered and Open, and can be differentiated using the following discriminators: |
20. DiagnosticReport.category.coding:laboratoryTestResultCode | |
Slice Name | laboratoryTestResultCode |
Definition | Category code used for indexing/retrieval of the ZIB LaboratoryTestResult. The system and code and display values are fixed. A reference to a code defined by a terminology system. |
Short | LaboratoryTestResultCodeCode defined by a terminology system |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
Control | 10..1* |
Type | Coding |
Summary | true |
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. |
22. DiagnosticReport.category.coding:laboratoryTestResultCode.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Short | Identity of the terminology system |
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously. |
Control | 0..1 |
Type | uri |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Fixed Value | http://snomed.info/sct |
24. DiagnosticReport.category.coding:laboratoryTestResultCode.code | |
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
Short | Symbol in syntax defined by the system |
Control | 0..1 |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Need to refer to a particular code in the system. |
Fixed Value | 4241000179101 |
26. DiagnosticReport.category.coding:laboratoryTestResultCode.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Short | Representation defined by the system |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
28. DiagnosticReport.category.coding:resultType | |
Slice Name | resultType |
Definition | The type of result defines the laboratory specialty under which the test is categorized. A reference to a code defined by a terminology system. |
Short | ResultTypeCode defined by a terminology system |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
Control | 10..1* |
Binding | Unless not suitable, these codes SHALL be taken from For codes, see ResultaatTypeCodelijst (extensible to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.13.1.1--20171231000000 )ResultaatTypeCodelijst |
Type | Coding |
Summary | true |
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. |
Alternate Names | ResultaatType |
30. DiagnosticReport.code | |
Definition | For laboratory tests comprising multiple subtests and often requested together as a whole, this concept contains the name of the compound request (often indicated as a ‘panel’, ‘battery’ or ‘cluster’). Examples include: blood gases and EBV serology. A code or name that describes this diagnostic report. |
Short | PanelOrBatteryName/Code for this diagnostic report |
Control | 1..1 |
Binding | Unless not suitable, these codes SHALL be taken from The codes SHOULD be taken from OnderzoekCodelijsthttp://hl7.org/fhir/ValueSet/report-codes (extensible to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.13.1.5--20171231000000 )PanelOrBatteryCodelist Codes that describe Diagnostic Reports. |
Type | CodeableConcept |
Summary | true |
Alternate Names | Type, Onderzoek |
32. DiagnosticReport.subject | |
Definition | The subject of the report. Usually, but not always, this is a patient. However diagnostic services also perform analyses on specimens collected from a variety of other sources. |
Short | The subject of the report - usually, but not always, the patient |
Control | 0..1 |
Type | Reference(nl-core-patient, Patient, Group, Device, Location) |
Summary | true |
Requirements | SHALL know the subject context. |
Alternate Names | Patient |
34. DiagnosticReport.context | |
Definition | The healthcare event (e.g. a patient and healthcare provider interaction) which this DiagnosticReport per is about. |
Short | Health care event when test ordered |
Comments | This will typically be the encounter the event occurred within, but some events may be initiated prior to or after the official completion of an encounter or episode but still be tied to the context of the encounter or episode (e.g. pre-admission lab tests). |
Control | 0..1 |
Type | Reference(nl-core-episodeofcare, HCIM Encounter, gp-Encounter, Encounter, EpisodeOfCare) |
Summary | true |
Requirements | Links the request to the Encounter context. |
Alternate Names | Encounter |
36. DiagnosticReport.effective[x] | |
Definition | The time or time-period the observed values are related to. When the subject of the report is a patient, this is usually either the time of the procedure or of specimen collection(s), but very often the source of the date/time is not known, only the date/time itself. |
Short | Clinically relevant time/time-period for report |
Comments | If the diagnostic procedure was performed on the patient, this is the time it was performed. If there are specimens, the diagnostically relevant time can be derived from the specimen collection times, but the specimen information is not always available, and the exact relationship between the specimens and the diagnostically relevant time is not always automatic. |
Control | 0..1 |
Type | Choice of: dateTime, Period |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Need to know where in the patient history to file/present this report. |
Alternate Names | Observation time, Effective Time, Occurrence |
38. DiagnosticReport.performer | |
Definition | Indicates who or what participated in producing the report. |
Short | Participants in producing the report |
Control | 0..* |
Type | BackboneElement |
Summary | true |
Alternate Names | Laboratory, Service, Practitioner, Department, Company |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()) )ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count())) |
40. DiagnosticReport.performer.modifierExtension | |
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 that contains it. Usually modifier elements provide negation or qualification. In order 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 is allowed to 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. |
Short | Extensions that cannot be ignored |
Comments | 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR |
Summary | true |
Alternate Names | extensions, user content, modifiers |
42. DiagnosticReport.performer.actor | |
Definition | The reference to the practitioner or organization involved in producing the report. For example, the diagnostic service that is responsible for issuing the report. |
Short | Practitioner or Organization participant |
Comments | This is not necessarily the source of the atomic data items. It is the entity that takes responsibility for the clinical report. |
Control | 1..1 |
Type | Reference(nl-core-organization, nl-core-practitioner, Practitioner, Organization) |
Summary | true |
Requirements | Need to know whom to contact if there are queries about the results. Also may need to track the source of reports for secondary data analysis. |
44. DiagnosticReport.performer.actor.extension | |
Definition | An Extension May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Short | ExtensionAdditional Content defined by implementations |
Comments | 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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Slicing | This element introduces a set of slices on DiagnosticReport.performer.actor.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
46. DiagnosticReport.performer.actor.extension:practitionerRole | |
Slice Name | practitionerRole |
Definition | Optional Extension Element - found in all resources. |
Short | Optional Extensions Element |
Control | 0..1 |
Type | Extension(PractitionerRole Reference) (Extension Type: Reference) |
48. DiagnosticReport.specimen | |
Definition | Details about the specimens on which this diagnostic report is based. |
Short | SpecimenSpecimens this report is based on |
Comments | If the specimen is sufficiently specified with a code in the test result name, then this additional data may be redundant. If there are multiple specimens, these may be represented per observation or group. |
Control | 0..* |
Type | Reference(HCIM LaboratoryTestResult Specimen, http://nictiz.nl/fhir/StructureDefinition/zib-LaboratoryTestResult-Isolate , Specimen) |
Requirements | Need to be able to report information about the collected specimens on which the report is based. |
Alternate Names | Monster |
50. DiagnosticReport.result | |
Definition | Observations that are part of this diagnostic report. Observations can be simple name/value pairs (e.g. "atomic" results), or they can be grouping observations that include references to other members of the group (e.g. "panels"). |
Short | Observations - simple, or complex nested groups |
Control | 0..* |
Type | Reference(HCIM LaboratoryTestResult Observation, Observation) |
Requirements | Need to support individual results, or report groups of results, where the result grouping is arbitrary, but meaningful. This structure is recursive - observations can contain observations. |
Alternate Names | Data, Atomic Value, Result, Atomic result, Data, Test, Analyte, Battery, Organizer |
52. DiagnosticReport.conclusion | |
Definition | Concise and clinically contextualized impression / summary of the diagnostic report. Comments, such as a textual interpretation or advice accompanying the result, for example. Concise and clinically contextualized impression / summary of the diagnostic report. |
Short | ResultInterpretation and/or CommentClinical Interpretation of test results |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Requirements | Need to be able to provide a conclusion that is not lost among the basic result data. |
Alternate Names | Report, UitslagInterpretatie en/of Toelichting |
Guidance on how to interpret the contents of this table can be found here
0. DiagnosticReport | |||||
Definition | The findings and interpretation of diagnostic tests performed on patients, groups of patients, devices, and locations, and/or specimens derived from these. The report includes clinical context such as requesting and provider information, and some mix of atomic results, images, textual and coded interpretations, and formatted representation of diagnostic reports. The HCIM LaboratoryResult also supports simple and more complex situations. For a simple result there will be a single LaboratoryTestResult.LaboratoryTest.TestName in Observation.code and no LaboratoryTestresult.Test. For a more complex situation there will be a LaboratoryTestResult.Test and any number of related LaboratoryTestResult.LaboratoryTest, e.g. parts of a panel or battery. Each related LaboratoryTest shall be conveyed in Observation.related or Observation.component. The deciding factor in choosing between related or component is: does the observation have use as independent observation (Observation.related) or is the observation only relevant in the context of its parent (Observation.component). Note that (textual) reports on individual (panels of) observations, like conclusions, go into a different resource DiagnosticReport. The DiagnosticReport then contains the references to the Observation resources it concerns. | ||||
Short | LaboratoryTestResult | ||||
Comments | This is intended to capture a single report, and is not suitable for use in displaying summary information that covers multiple reports. For example, this resource has not been designed for laboratory cumulative reporting formats nor detailed structured reports for sequencing. | ||||
Control | 0..* | ||||
Alternate Names | Report, Test, Result, Results, Labs, Laboratory, LaboratoriumUitslag | ||||
Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty() )dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative ( contained.text.empty() )dom-4: 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-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource ( contained.where(('#'+id in %resource.descendants().reference).not()).empty() ) | ||||
2. DiagnosticReport.id | |||||
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||||
Short | Logical id of this artifact | ||||
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||||
Control | 0..1 | ||||
Type | id | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
4. DiagnosticReport.meta | |||||
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. | ||||
Short | Metadata about the resource | ||||
Control | 0..1 | ||||
Type | Meta | ||||
Summary | true | ||||
6. DiagnosticReport.implicitRules | |||||
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. | ||||
Short | A set of rules under which this content was created | ||||
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation. | ||||
Control | 0..1 | ||||
Type | uri | ||||
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
8. DiagnosticReport.language | |||||
Definition | The base language in which the resource is written. | ||||
Short | Language of the resource content | ||||
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). | ||||
Control | 0..1 | ||||
Binding | Unless not suitable, these codes SHALL be taken from Common Languages (extensible to http://hl7.org/fhir/ValueSet/languages )A human language.
| ||||
Type | code | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
10. DiagnosticReport.text | |||||
Definition | A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. | ||||
Short | Text summary of the resource, for human interpretation | ||||
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later. | ||||
Control | 0..1 This element is affected by the following invariants: dom-1 | ||||
Type | Narrative | ||||
Alternate Names | narrative, html, xhtml, display | ||||
12. DiagnosticReport.contained | |||||
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. | ||||
Short | Contained, inline Resources | ||||
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. | ||||
Control | 0..* | ||||
Type | Resource | ||||
Alternate Names | inline resources, anonymous resources, contained resources | ||||
14. DiagnosticReport.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the resource. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Short | Additional Content defined by implementations | ||||
Comments | 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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensions, user content | ||||
16. DiagnosticReport.modifierExtension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order 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 is allowed to 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. | ||||
Short | Extensions that cannot be ignored | ||||
Comments | 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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
Alternate Names | extensions, user content | ||||
18. DiagnosticReport.identifier | |||||
Definition | Identifiers assigned to this report by the performer or other systems. | ||||
Short | Identifier | ||||
Comments | Usually assigned by the Information System of the diagnostic service provider (filler id). | ||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||
Control | 0..* | ||||
Type | Identifier | ||||
Summary | true | ||||
Requirements | Need to know what identifier to use when making queries about this report from the source laboratory, and for linking to the report outside FHIR context. | ||||
Alternate Names | ReportID, Filler ID, Placer ID, Identificatie | ||||
20. DiagnosticReport.basedOn | |||||
Definition | Details concerning a test or procedure requested. | ||||
Short | Fulfills plan, proposal or order including requester information. | ||||
Comments | Requester information should be captured and exchanged in the resource ProcedureRequest referenced by basedOn. Requester is the healthcare provider and/or organization where or by whom the LaboratoryTestResult was requested. There are a few required elements in ProcedureRequest - ProcedureRequest.status (use fixed value "active", unless you know what the actual value is) - ProcedureRequest.intent (use fixed value "order", unless you know what the actual value is) - ProcedureRequest.code (use extension http://hl7.org/fhir/STU3/extension-iso21090-nullflavor.html met valueCode UNK, unless you know what the actual value is) - ProcedureRequest.subject (equal to DiagnosticReport.subject) - ProcedureRequest.requester.agent (contains the requesting HealthProfessional) | ||||
Control | 0..* | ||||
Type | Reference(CarePlan, ImmunizationRecommendation, MedicationRequest, NutritionOrder, ProcedureRequest, ReferralRequest) | ||||
Requirements | This allows tracing of authorization for the report and tracking whether proposals/recommendations were acted upon. | ||||
Alternate Names | Request, Aanvrager | ||||
22. DiagnosticReport.status | |||||
Definition | The status of the diagnostic report as a whole. | ||||
Short | ResultStatus | ||||
Comments | This is labeled as "Is Modifier" because applications need to take appropriate action if a report is withdrawn. | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from DiagnosticReportStatus (required to http://hl7.org/fhir/ValueSet/diagnostic-report-status )The status of the diagnostic report as a whole. | ||||
Type | code | ||||
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | Diagnostic services routinely issue provisional/incomplete reports, and sometimes withdraw previously released reports. | ||||
Alternate Names | ResultaatStatus | ||||
24. DiagnosticReport.status.id | |||||
Definition | unique id for the element within a resource (for internal references) | ||||
Short | xml:id (or equivalent in JSON) | ||||
Control | 0..1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
26. DiagnosticReport.status.extension | |||||
Definition | An Extension | ||||
Short | Extension | ||||
Control | 0..* | ||||
Type | Extension | ||||
Slicing | This element introduces a set of slices on DiagnosticReport.status.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: | ||||
28. DiagnosticReport.status.extension:ResultStatus | |||||
Slice Name | ResultStatus | ||||
Definition | Defines a more specific value to a code. Especially useful for FHIRs required ValueSets. | ||||
Short | Provides the specific HCIM code for ResultStatus | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(HCIM extension code-specification) (Extension Type: CodeableConcept) | ||||
Alternate Names | Bevat de specifieke code conform de zib, bij een FHIR-element die een verplichte koppeling heeft met een bepaalde FHIR waardelijst of een FHIR element die niet gecodeerd is gedefinieerd, terwijl de zib dit wel doet., ResultaatStatus | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
30. DiagnosticReport.status.value | |||||
Definition | Primitive value for code | ||||
Short | Primitive value for code | ||||
Control | 0..1 | ||||
Type | code | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
32. DiagnosticReport.category | |||||
Definition | A code that classifies the clinical discipline, department or diagnostic service that created the report (e.g. cardiology, biochemistry, hematology, MRI). This is used for searching, sorting and display purposes. | ||||
Short | Service category | ||||
Comments | The level of granularity is defined by the category concepts in the value set. More fine-grained filtering can be performed using the metadata and/or terminology hierarchy in DiagnosticReport.code. | ||||
Control | 1..1 | ||||
Binding | For example codes, see Diagnostic Service Section Codes (example to http://hl7.org/fhir/ValueSet/diagnostic-service-sections )Codes for diagnostic service sections. | ||||
Type | CodeableConcept | ||||
Summary | true | ||||
Alternate Names | Department, Sub-department, Service, Discipline | ||||
34. DiagnosticReport.category.id | |||||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Short | xml:id (or equivalent in JSON) | ||||
Control | 0..1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
36. DiagnosticReport.category.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Short | Additional Content defined by implementations | ||||
Comments | 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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensions, user content | ||||
Slicing | This element introduces a set of slices on DiagnosticReport.category.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: | ||||
38. DiagnosticReport.category.coding | |||||
Definition | A reference to a code defined by a terminology system. | ||||
Short | Code defined by a terminology system | ||||
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. | ||||
Control | 2..* | ||||
Type | Coding | ||||
Summary | true | ||||
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. | ||||
Slicing | This element introduces a set of slices on DiagnosticReport.category.coding . The slices are unordered and Open, and can be differentiated using the following discriminators: | ||||
40. DiagnosticReport.category.coding:laboratoryTestResultCode | |||||
Slice Name | laboratoryTestResultCode | ||||
Definition | Category code used for indexing/retrieval of the ZIB LaboratoryTestResult. The system and code and display values are fixed. | ||||
Short | LaboratoryTestResultCode | ||||
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. | ||||
Control | 1..1 | ||||
Type | Coding | ||||
Summary | true | ||||
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. | ||||
42. DiagnosticReport.category.coding:laboratoryTestResultCode.id | |||||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Short | xml:id (or equivalent in JSON) | ||||
Control | 0..1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
44. DiagnosticReport.category.coding:laboratoryTestResultCode.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Short | Additional Content defined by implementations | ||||
Comments | 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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensions, user content | ||||
Slicing | This element introduces a set of slices on DiagnosticReport.category.coding.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: | ||||
46. DiagnosticReport.category.coding:laboratoryTestResultCode.system | |||||
Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||||
Short | Identity of the terminology system | ||||
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously. | ||||
Control | 0..1 | ||||
Type | uri | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||||
Fixed Value | http://snomed.info/sct | ||||
48. DiagnosticReport.category.coding:laboratoryTestResultCode.version | |||||
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. | ||||
Short | Version of the system - if relevant | ||||
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. | ||||
Note | This is a business versionId, not a resource version id (see discussion) | ||||
Control | 0..1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
50. DiagnosticReport.category.coding:laboratoryTestResultCode.code | |||||
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). | ||||
Short | Symbol in syntax defined by the system | ||||
Control | 0..1 | ||||
Type | code | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | Need to refer to a particular code in the system. | ||||
Fixed Value | 4241000179101 | ||||
52. DiagnosticReport.category.coding:laboratoryTestResultCode.display | |||||
Definition | A representation of the meaning of the code in the system, following the rules of the system. | ||||
Short | Representation defined by the system | ||||
Control | 0..1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||
54. DiagnosticReport.category.coding:laboratoryTestResultCode.userSelected | |||||
Definition | Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). | ||||
Short | If this coding was chosen directly by the user | ||||
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. | ||||
Control | 0..1 | ||||
Type | boolean | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. | ||||
56. DiagnosticReport.category.coding:resultType | |||||
Slice Name | resultType | ||||
Definition | The type of result defines the laboratory specialty under which the test is categorized. | ||||
Short | ResultType | ||||
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. | ||||
Control | 1..1 | ||||
Binding | Unless not suitable, these codes SHALL be taken from ResultaatTypeCodelijst (extensible to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.13.1.1--20171231000000 )ResultaatTypeCodelijst | ||||
Type | Coding | ||||
Summary | true | ||||
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. | ||||
Alternate Names | ResultaatType | ||||
58. DiagnosticReport.category.text | |||||
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. | ||||
Short | Plain text representation of the concept | ||||
Comments | Very often the text is the same as a displayName of one of the codings. | ||||
Control | 0..1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. | ||||
60. DiagnosticReport.code | |||||
Definition | For laboratory tests comprising multiple subtests and often requested together as a whole, this concept contains the name of the compound request (often indicated as a ‘panel’, ‘battery’ or ‘cluster’). Examples include: blood gases and EBV serology. | ||||
Short | PanelOrBattery | ||||
Control | 1..1 | ||||
Binding | Unless not suitable, these codes SHALL be taken from OnderzoekCodelijst (extensible to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.13.1.5--20171231000000 )PanelOrBatteryCodelist | ||||
Type | CodeableConcept | ||||
Summary | true | ||||
Alternate Names | Type, Onderzoek | ||||
62. DiagnosticReport.subject | |||||
Definition | The subject of the report. Usually, but not always, this is a patient. However diagnostic services also perform analyses on specimens collected from a variety of other sources. | ||||
Short | The subject of the report - usually, but not always, the patient | ||||
Control | 0..1 | ||||
Type | Reference(nl-core-patient) | ||||
Summary | true | ||||
Requirements | SHALL know the subject context. | ||||
Alternate Names | Patient | ||||
64. DiagnosticReport.context | |||||
Definition | The healthcare event (e.g. a patient and healthcare provider interaction) which this DiagnosticReport per is about. | ||||
Short | Health care event when test ordered | ||||
Comments | This will typically be the encounter the event occurred within, but some events may be initiated prior to or after the official completion of an encounter or episode but still be tied to the context of the encounter or episode (e.g. pre-admission lab tests). | ||||
Control | 0..1 | ||||
Type | Reference(nl-core-episodeofcare, HCIM Encounter, gp-Encounter) | ||||
Summary | true | ||||
Requirements | Links the request to the Encounter context. | ||||
Alternate Names | Encounter | ||||
66. DiagnosticReport.effective[x] | |||||
Definition | The time or time-period the observed values are related to. When the subject of the report is a patient, this is usually either the time of the procedure or of specimen collection(s), but very often the source of the date/time is not known, only the date/time itself. | ||||
Short | Clinically relevant time/time-period for report | ||||
Comments | If the diagnostic procedure was performed on the patient, this is the time it was performed. If there are specimens, the diagnostically relevant time can be derived from the specimen collection times, but the specimen information is not always available, and the exact relationship between the specimens and the diagnostically relevant time is not always automatic. | ||||
Control | 0..1 | ||||
Type | Choice of: dateTime, Period | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | Need to know where in the patient history to file/present this report. | ||||
Alternate Names | Observation time, Effective Time, Occurrence | ||||
68. DiagnosticReport.issued | |||||
Definition | The date and time that this version of the report was released from the source diagnostic service. | ||||
Short | DateTime this version was released | ||||
Comments | May be different from the update time of the resource itself, because that is the status of the record (potentially a secondary copy), not the actual release time of the report. | ||||
Control | 0..1 | ||||
Type | instant | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | Clinicians need to be able to check the date that the report was released. | ||||
Alternate Names | Date Created, Date published, Date Issued | ||||
70. DiagnosticReport.performer | |||||
Definition | Indicates who or what participated in producing the report. | ||||
Short | Participants in producing the report | ||||
Control | 0..* | ||||
Type | BackboneElement | ||||
Summary | true | ||||
Alternate Names | Laboratory, Service, Practitioner, Department, Company | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()) ) | ||||
72. DiagnosticReport.performer.id | |||||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Short | xml:id (or equivalent in JSON) | ||||
Control | 0..1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
74. DiagnosticReport.performer.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Short | Additional Content defined by implementations | ||||
Comments | 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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensions, user content | ||||
76. DiagnosticReport.performer.modifierExtension | |||||
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 that contains it. Usually modifier elements provide negation or qualification. In order 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 is allowed to 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. | ||||
Short | Extensions that cannot be ignored | ||||
Comments | 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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
Summary | true | ||||
Alternate Names | extensions, user content, modifiers | ||||
78. DiagnosticReport.performer.role | |||||
Definition | Describes the type of participation (e.g. a responsible party, author, or verifier). | ||||
Short | Type of performer | ||||
Control | 0..1 | ||||
Binding | For example codes, see Procedure Performer Role Codes (example to http://hl7.org/fhir/ValueSet/performer-role )Indicate a role of diagnostic report performer | ||||
Type | CodeableConcept | ||||
Summary | true | ||||
80. DiagnosticReport.performer.role.id | |||||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Short | xml:id (or equivalent in JSON) | ||||
Control | 0..1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
82. DiagnosticReport.performer.role.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Short | Additional Content defined by implementations | ||||
Comments | 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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensions, user content | ||||
Slicing | This element introduces a set of slices on DiagnosticReport.performer.role.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: | ||||
84. DiagnosticReport.performer.role.coding | |||||
Definition | A reference to a code defined by a terminology system. | ||||
Short | Code defined by a terminology system | ||||
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. | ||||
Control | 0..* | ||||
Type | Coding | ||||
Summary | true | ||||
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. | ||||
Slicing | This element introduces a set of slices on DiagnosticReport.performer.role.coding . The slices are unordered and Open, and can be differentiated using the following discriminators: | ||||
86. DiagnosticReport.performer.role.coding:healthProfessionalRole | |||||
Slice Name | healthProfessionalRole | ||||
Definition | The role the healthcare provider fulfils in the healthcare process. For healthcare providers, this could be for example main practitioner, referrer or general practitioner. | ||||
Short | HealthProfessionalRole | ||||
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. | ||||
Control | 0..* | ||||
Binding | Unless not suitable, these codes SHALL be taken from ZorgverlenerRolCodelijst (extensible to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.17.1.5--20171231000000 ) | ||||
Type | Coding | ||||
Summary | true | ||||
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. | ||||
Alternate Names | ZorgverlenerRol | ||||
88. DiagnosticReport.performer.role.text | |||||
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. | ||||
Short | Plain text representation of the concept | ||||
Comments | Very often the text is the same as a displayName of one of the codings. | ||||
Control | 0..1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. | ||||
90. DiagnosticReport.performer.actor | |||||
Definition | The reference to the practitioner or organization involved in producing the report. For example, the diagnostic service that is responsible for issuing the report. | ||||
Short | Practitioner or Organization participant | ||||
Comments | This is not necessarily the source of the atomic data items. It is the entity that takes responsibility for the clinical report. | ||||
Control | 1..1 | ||||
Type | Reference(nl-core-organization, nl-core-practitioner) | ||||
Summary | true | ||||
Requirements | Need to know whom to contact if there are queries about the results. Also may need to track the source of reports for secondary data analysis. | ||||
92. DiagnosticReport.performer.actor.id | |||||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Short | xml:id (or equivalent in JSON) | ||||
Control | 0..1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
94. DiagnosticReport.performer.actor.extension | |||||
Definition | An Extension | ||||
Short | Extension | ||||
Control | 0..* | ||||
Type | Extension | ||||
Slicing | This element introduces a set of slices on DiagnosticReport.performer.actor.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: | ||||
96. DiagnosticReport.performer.actor.extension:practitionerRole | |||||
Slice Name | practitionerRole | ||||
Definition | Optional Extension Element - found in all resources. | ||||
Short | Optional Extensions Element | ||||
Control | 0..1 | ||||
Type | Extension(PractitionerRole Reference) (Extension Type: Reference) | ||||
98. DiagnosticReport.performer.actor.reference | |||||
Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. | ||||
Short | Literal reference, Relative, internal or absolute URL | ||||
Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. | ||||
Control | 0..1 This element is affected by the following invariants: ref-1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
100. DiagnosticReport.performer.actor.identifier | |||||
Definition | An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. | ||||
Short | Logical reference, when literal reference is not known | ||||
Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. | ||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||
Control | 0..1 | ||||
Type | Identifier | ||||
Summary | true | ||||
102. DiagnosticReport.performer.actor.display | |||||
Definition | Plain text narrative that identifies the resource in addition to the resource reference. | ||||
Short | Text alternative for the resource | ||||
Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. | ||||
Control | 0..1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
104. DiagnosticReport.specimen | |||||
Definition | Details about the specimens on which this diagnostic report is based. | ||||
Short | Specimen | ||||
Comments | If the specimen is sufficiently specified with a code in the test result name, then this additional data may be redundant. If there are multiple specimens, these may be represented per observation or group. | ||||
Control | 0..* | ||||
Type | Reference(HCIM LaboratoryTestResult Specimen, http://nictiz.nl/fhir/StructureDefinition/zib-LaboratoryTestResult-Isolate ) | ||||
Requirements | Need to be able to report information about the collected specimens on which the report is based. | ||||
Alternate Names | Monster | ||||
106. DiagnosticReport.result | |||||
Definition | Observations that are part of this diagnostic report. Observations can be simple name/value pairs (e.g. "atomic" results), or they can be grouping observations that include references to other members of the group (e.g. "panels"). | ||||
Short | Observations - simple, or complex nested groups | ||||
Control | 0..* | ||||
Type | Reference(HCIM LaboratoryTestResult Observation) | ||||
Requirements | Need to support individual results, or report groups of results, where the result grouping is arbitrary, but meaningful. This structure is recursive - observations can contain observations. | ||||
Alternate Names | Data, Atomic Value, Result, Atomic result, Data, Test, Analyte, Battery, Organizer | ||||
108. DiagnosticReport.imagingStudy | |||||
Definition | One or more links to full details of any imaging performed during the diagnostic investigation. Typically, this is imaging performed by DICOM enabled modalities, but this is not required. A fully enabled PACS viewer can use this information to provide views of the source images. | ||||
Short | Reference to full details of imaging associated with the diagnostic report | ||||
Comments | ImagingStudy and ImageManifest and the image element are somewhat overlapping - typically, the list of image references in the image element will also be found in one of the imaging study resources. However each caters to different types of displays for different types of purposes. Neither, either, or both may be provided. | ||||
Control | 0..* | ||||
Type | Reference(ImagingStudy, ImagingManifest) | ||||
110. DiagnosticReport.image | |||||
Definition | A list of key images associated with this report. The images are generally created during the diagnostic process, and may be directly of the patient, or of treated specimens (i.e. slides of interest). | ||||
Short | Key images associated with this report | ||||
Control | 0..* | ||||
Type | BackboneElement | ||||
Summary | true | ||||
Requirements | Many diagnostic services include images in the report as part of their service. | ||||
Alternate Names | DICOM, Slides, Scans | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()) ) | ||||
112. DiagnosticReport.image.id | |||||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Short | xml:id (or equivalent in JSON) | ||||
Control | 0..1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
114. DiagnosticReport.image.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Short | Additional Content defined by implementations | ||||
Comments | 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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensions, user content | ||||
116. DiagnosticReport.image.modifierExtension | |||||
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 that contains it. Usually modifier elements provide negation or qualification. In order 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 is allowed to 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. | ||||
Short | Extensions that cannot be ignored | ||||
Comments | 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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
Summary | true | ||||
Alternate Names | extensions, user content, modifiers | ||||
118. DiagnosticReport.image.comment | |||||
Definition | A comment about the image. Typically, this is used to provide an explanation for why the image is included, or to draw the viewer's attention to important features. | ||||
Short | Comment about the image (e.g. explanation) | ||||
Comments | The comment should be displayed with the image. It would be common for the report to include additional discussion of the image contents in other sections such as the conclusion. | ||||
Control | 0..1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Requirements | The provider of the report should make a comment about each image included in the report. | ||||
120. DiagnosticReport.image.link | |||||
Definition | Reference to the image source. | ||||
Short | Reference to the image source | ||||
Control | 1..1 | ||||
Type | Reference(Media) | ||||
Summary | true | ||||
122. DiagnosticReport.conclusion | |||||
Definition | Concise and clinically contextualized impression / summary of the diagnostic report. Comments, such as a textual interpretation or advice accompanying the result, for example. | ||||
Short | ResultInterpretation and/or Comment | ||||
Control | 0..1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Requirements | Need to be able to provide a conclusion that is not lost among the basic result data. | ||||
Alternate Names | Report, UitslagInterpretatie en/of Toelichting | ||||
124. DiagnosticReport.codedDiagnosis | |||||
Definition | Codes for the conclusion. | ||||
Short | Codes for the conclusion | ||||
Control | 0..* | ||||
Binding | For example codes, see SNOMED CT Clinical Findings (example to http://hl7.org/fhir/ValueSet/clinical-findings )Diagnosis codes provided as adjuncts to the report. | ||||
Type | CodeableConcept | ||||
126. DiagnosticReport.presentedForm | |||||
Definition | Rich text representation of the entire result as issued by the diagnostic service. Multiple formats are allowed but they SHALL be semantically equivalent. | ||||
Short | Entire report as issued | ||||
Comments | "application/pdf" is recommended as the most reliable and interoperable in this context. | ||||
Control | 0..* | ||||
Type | Attachment | ||||
Requirements | Gives laboratory the ability to provide its own fully formatted report for clinical fidelity. |