Notice
- Important: This guidance is under active development by NHS England and content may be added or updated on a regular basis.
- This Implementation Guide is currently in Draft and SHOULD NOT be used for development or active implementation without express direction from the NHS England Genomics Unit.
StructureDefinition NHSEngland-DiagnosticReport-GenomicReport
The requirements of a specific Genomics DiagnosticReport is currently under review.
The draft profile is provided below for completeness.
Currently, only requirements for initial Pathology reports, provided with a test order, have been reviewed. DiagnosticReports containing the results of genomic testing are expected to be attached/provided as PDF documents during the alpha phase of the GMS development programme.
It is expected structured DiagnosticReports will mimic the structure proposed within the HL7 International Genomic Reporting IG, though customizations for use within the UK still need to be investigated.
Additionally, to support sharing across borders, lab reports MAY additionally be aligned to the HL7 EU Lab Implementation guide, though requirement on suppliers to conform to this structure are still under review. details of elements of interest for alignment with the EU DiagnosticReport profile are provided below.
Genomic DiagnosticReports which have been updated post submission SHALL be accompanied by Provenance resources, referencing the DiagnosticReport which detail when the resource was changed, who made the change and why.
Whilst unstructured Diagnostic Reports can also be represented by DocumentReference resources, the DiagnosticReport resource is preferred for any documents constituting actual reports, as the resource allows capture of metadata not present in DocumentReference, such as the resultsInterpreter, specimen or conclusion, which would help in searching or for analytics. The DiagnosticReport SHOULD then reference a DocumentReference e.g. registered on NRL following guidance on coding provided by the National Record Locator Service. Use of DocumentReference within the Order Management Service resources is limited to other data files or documents.
Where binary data is uploaded to the central server, or made available via a national service such as NRL, as in the case of unstructured reports, information cannot be redacted by the central service if a patient is marked as sensitive. It is the responsibility of source systems to redact the necessary information from binary files for sensitive patients before sending this data to the central broker, this includes information such as address and GP details in line with PDS.
| Profile url | FHIR Module | Normative Status |
|---|---|---|
| https://fhir.nhs.uk/StructureDefinition/NHSEngland-DiagnosticReport-GenomicReport | NHS England Genomics | trial-use |
| Canonical_URL | Status | Current_Version | Last_Updated | Description |
|---|---|---|---|---|
| https://fhir.nhs.uk/StructureDefinition/NHSEngland-DiagnosticReport-GenomicReport | active | 0.3.0 | 2026-04-16 | This profile defines the Genomics constraints and extensions on the Genomics Reporting FHIR resource Genomic Report DiagnosticReport. |
Tree View
| NHSEngland_DiagnosticReport_GenomicReport (DiagnosticReport) | C | GenomicReport | |
| id | Σ | 0..1 | id |
| meta | Σ | 0..1 | Meta |
| implicitRules | Σ ?! | 0..1 | uri |
| language | 0..1 | codeBinding | |
| text | 0..1 | Narrative | |
| contained | 0..* | Resource | |
| extension | C | 0..* | Extension |
| recommended-action | C | 0..* | Extension(Reference(FollowupRecommendation | MedicationRecommendation)) |
| genomic-risk-assessment | C | 0..* | Extension(Reference(RiskAssessment)) |
| coded-note | C | 0..* | Extension(CodedAnnotation) |
| supporting-info | C | 0..* | Extension(Reference(Resource)) |
| genomic-study | C | 0..* | Extension(Reference(GenomicStudy)) |
| hla-genotyping-results-allele-database | C | 0..1 | Extension(CodeableConcept) |
| hla-genotyping-results-glstring | C | 0..1 | Extension(Complex) |
| workflow-relatedArtifact | C | 0..* | Extension(RelatedArtifact) |
| id | 0..1 | string | |
| extension | C | 0..0 | Extension |
| url | 1..1 | uriFixed Value | |
| value[x] | 1..1 | RelatedArtifact | |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| type | Σ | 1..1 | codeBindingFixed Value |
| label | Σ | 0..1 | string |
| display | Σ | 0..1 | string |
| citation | Σ | 0..1 | markdown |
| url | Σ | 0..1 | url |
| document | Σ C | 0..1 | Attachment |
| resource | Σ | 0..1 | canonical(Resource) |
| diagnosticReportCompositionR5 | C | 0..* | Extension(Reference(Composition)) |
| modifierExtension | ?! C | 0..* | Extension |
| identifier | Σ | 1..* | Identifier |
| identifierGMSReport | Σ | 0..1 | Identifier |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| use | Σ ?! | 0..0 | codeBinding |
| type | Σ | 0..0 | CodeableConceptBinding |
| system | Σ | 1..1 | uriFixed Value |
| value | Σ | 1..1 | string |
| period | Σ C | 0..0 | Period |
| assigner | Σ C | 0..0 | Reference(Organization) |
| localIdentifier | Σ | 0..* | Identifier |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| use | Σ ?! | 0..1 | codeBinding |
| type | Σ | 0..1 | CodeableConceptBinding |
| system | Σ | 1..1 | uriFixed Value |
| value | Σ | 1..1 | string |
| period | Σ C | 0..1 | Period |
| assigner | Σ C | 1..1 | Reference(Organization) |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| reference | Σ C | 0..0 | string |
| type | Σ | 0..1 | uriBinding |
| identifier | Σ | 1..1 | IdentifierFixed Value |
| display | Σ | 0..1 | string |
| basedOn | C | 0..1 | Reference(CarePlan | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest | NHSEngland_ServiceRequest_Genomics) |
| status | Σ ?! | 1..1 | codeBinding |
| category | Σ | 1..* | CodeableConcept |
| Genetics | Σ | 1..1 | CodeableConcept |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| coding | Σ | 1..1 | CodingPattern |
| text | Σ | 0..1 | string |
| GeneticsSnomedCT | Σ | 0..* | CodeableConcept |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| coding | Σ | 0..* | CodingPattern |
| text | Σ | 0..1 | string |
| code | Σ | 1..1 | CodeableConceptBindingPattern |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| coding | Σ | 0..* | CodingPattern |
| codingSnomedCT | Σ | 0..* | CodingBinding |
| text | Σ | 0..1 | string |
| subject | Σ C | 1..1 | Reference(Device | Group | Location | Patient | NHSEngland_Patient_Genomics) |
| encounter | Σ C | 0..1 | Reference(Encounter) |
| effective[x] | Σ | 0..1 | |
| effectiveDateTime | dateTime | ||
| issued | Σ | 1..1 | instant |
| performer | Σ C | 0..* | Reference(CareTeam | Organization | Practitioner | PractitionerRole | UKCoreOrganization) |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| reference | Σ C | 0..0 | string |
| type | Σ | 0..1 | uriBinding |
| identifier | Σ | 1..1 | Identifier |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| use | Σ ?! | 0..1 | codeBinding |
| type | Σ | 0..1 | CodeableConceptBinding |
| system | Σ | 0..1 | uriFixed Value |
| value | Σ | 0..1 | string |
| period | Σ C | 0..1 | Period |
| assigner | Σ C | 0..1 | Reference(Organization) |
| display | Σ | 0..1 | string |
| resultsInterpreter | Σ C | 0..* | Reference(CareTeam | Organization | Practitioner | PractitionerRole | NHSEngland_PractitionerRole_Genomics) |
| specimen | C | 1..* | Reference(Specimen | NHSEngland_Specimen_Genomics) |
| result | C | 0..* | Reference(Observation) |
| diagnostic-implication | C | 0..* | Reference(DiagnosticImplication) |
| therapeutic-implication | C | 0..* | Reference(TherapeuticImplication) |
| molecular-consequence | C | 0..* | Reference(MolecularConsequence) |
| variant | C | 0..* | Reference(Variant) |
| sequence-phase-relation | C | 0..* | Reference(SequencePhaseRelationship) |
| genotype | C | 0..* | Reference(Genotype) |
| haplotype | C | 0..* | Reference(Haplotype) |
| biomarker | C | 0..* | Reference(MolecularBiomarker) |
| imagingStudy | C | 0..0 | Reference(ImagingStudy) |
| media | Σ | 0..* | BackboneElement |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| comment | 0..1 | string | |
| link | Σ C | 1..1 | Reference(Media) |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| alternateReference | C | 0..1 | Extension(Reference(Resource)) |
| id | 0..1 | string | |
| extension | C | 0..0 | Extension |
| url | 1..1 | uriFixed Value | |
| value[x] | 1..1 | ||
| valueReference | Reference(Resource | https://fhir.nhs.uk/StructureDefinition/NHSEngland-DocumentReference-Genomics) | ||
| reference | Σ C | 0..1 | string |
| type | Σ | 0..1 | uriBinding |
| identifier | Σ | 0..1 | Identifier |
| display | Σ | 0..1 | string |
| conclusion | 0..1 | string | |
| conclusionCode | 0..* | CodeableConcept | |
| presentedForm | C | 1..* | Attachment |
Detailed Descriptions
| DiagnosticReport | |||
| Short | A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports | ||
| 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. | ||
| Cardinality | 0..* | ||
| Alias | Report, Test, Result, Results, Labs, Laboratory | ||
| 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. | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.id | |||
| Short | Logical id of this artifact | ||
| Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||
| Cardinality | 0..1 | ||
| Type | id | ||
| Summary | True | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.meta | |||
| Short | Metadata about the resource | ||
| Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. | ||
| Cardinality | 0..1 | ||
| Type | Meta | ||
| Summary | True | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.implicitRules | |||
| Short | A set of rules under which this content was created | ||
| 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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | ||
| Cardinality | 0..1 | ||
| Type | uri | ||
| Modifier | True | ||
| Summary | True | ||
| 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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.language | |||
| Short | Language of the resource content | ||
| Definition | The base language in which the resource is written. | ||
| Cardinality | 0..1 | ||
| Type | code | ||
| Binding | A human language.
| ||
| 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). | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.text | |||
| Short | Text summary of the resource, for human interpretation | ||
| Definition | A human-readable narrative that contains a summary of the resource and can 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. | ||
| Cardinality | 0..1 | ||
| Type | Narrative | ||
| Alias | narrative, html, xhtml, display | ||
| 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 information is added later. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.contained | |||
| Short | Contained, inline Resources | ||
| 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. | ||
| Cardinality | 0..* | ||
| Type | Resource | ||
| Alias | inline resources, anonymous resources, contained 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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. | ||
| Mappings |
| ||
| DiagnosticReport.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| 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. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.extension:recommended-action | |||
| Short | Recommended Action | ||
| Definition | TBC. Only relevant for structured genomic reports (included in the Genomic Report Profile in the Genomics Report IG). Reference to Task resource indicating recommended action to take in response to the report's result/conclusion. | ||
| Cardinality | 0..* | ||
| Type | Extension(Reference(FollowupRecommendation | MedicationRecommendation)) | ||
| Alias | extensions, user content | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.extension:genomic-risk-assessment | |||
| Short | Genomic Risk Assessment | ||
| Definition | RiskAssessment delivered as part of a genomics report or observation | ||
| Cardinality | 0..* | ||
| Type | Extension(Reference(RiskAssessment)) | ||
| Alias | extensions, user content | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.extension:coded-note | |||
| Short | Comments about the report that also contain a coded type | ||
| Definition | Adds codified notes to a report to capture additional content | ||
| Cardinality | 0..* | ||
| Type | Extension(CodedAnnotation) | ||
| Alias | extensions, user content | ||
| Requirements | Need to be able to provide free text additional information. Notes SHALL NOT contain information which can be captured in a structured way. | ||
| Comments | May include general statements about the report, or statements about significant, unexpected or unreliable results values, or information about its source when relevant to its interpretation. The CodedAnnotation data type, while not allowing for or intending to make the content computable, does allow the author to indicate the type of note. This does not replace the use of results or conclusion or conclusionCode. One important note is that Annotation is a FHIR data type, this is NOT about annotations in the genomic context. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.extension:supporting-info | |||
| Short | Other information that may be relevant to this event. | ||
| Definition | TBC. Only relevant for structured genomic reports (included in the Genomic Report Profile in the Genomics Report IG). Reference to the genomic data files analysed as part of the test order, forming the report. Reference to DocumentReference resource which links to the binary data file. | ||
| Cardinality | 0..* | ||
| Type | Extension(Reference(Resource)) | ||
| Alias | extensions, user content | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.extension:genomic-study | |||
| Short | Reference to full details of an genomic study associated with the diagnostic report | ||
| Definition | TBC. Only relevant for structured genomic reports (included in the Genomic Report Profile in the Genomics Report IG). Reference to Procedure resources indicating the analyses performed as part the genomic test order. | ||
| Cardinality | 0..* | ||
| Type | Extension(Reference(GenomicStudy)) | ||
| Alias | extensions, user content | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.extension:hla-genotyping-results-allele-database | |||
| Short | Allele Database | ||
| Definition | Allele Database. | ||
| Cardinality | 0..1 | ||
| Type | Extension(CodeableConcept) | ||
| Alias | extensions, user content | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.extension:hla-genotyping-results-glstring | |||
| Short | glstring | ||
| Definition | glstring. | ||
| Cardinality | 0..1 | ||
| Type | Extension(Complex) | ||
| Alias | extensions, user content | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.extension:workflow-relatedArtifact | |||
| Short | Documentation relevant to the 'parent' resource | ||
| Definition | TBC. Only relevant for structured genomic reports (included in Genomic Report Profile in the Genomics Report IG). A reference to the guidelines or other knowledge artifacts which were used to guide interpretation or recommended actions included within this DiagnosticReport. If entries constitute published papers, they SHOULD be referenced using a known citation style, e.g. Vancouver/Harvard. Alternatively for online texts, these MAY be referenced via URL only. A fixed value of 'citation' is expected for the type element, though this recommendation is pending further use cases. | ||
| Cardinality | 0..* | ||
| Type | Extension(RelatedArtifact) | ||
| Alias | extensions, user content | ||
| Comments | Note that in contrast this extension, the supportingInfo extension references other resources from the patient record that were used in creating the resource. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.extension:workflow-relatedArtifact.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| DiagnosticReport.extension:workflow-relatedArtifact.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..0 | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| 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. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.extension:workflow-relatedArtifact.url | |||
| Short | identifies the meaning of the extension | ||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||
| Cardinality | 1..1 | ||
| Type | uri | ||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||
| Fixed Value | http://hl7.org/fhir/StructureDefinition/workflow-relatedArtifact | ||
| Mappings |
| ||
| DiagnosticReport.extension:workflow-relatedArtifact.value[x] | |||
| Short | Value of extension | ||
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||
| Cardinality | 1..1 | ||
| Type | RelatedArtifact | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.extension:workflow-relatedArtifact.value[x].id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| DiagnosticReport.extension:workflow-relatedArtifact.value[x].extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| 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. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.extension:workflow-relatedArtifact.value[x].type | |||
| Short | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | ||
| Definition | The type of relationship to the related artifact. | ||
| Cardinality | 1..1 | ||
| Type | code | ||
| Binding | The type of relationship to the related artifact. | ||
| Summary | True | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Fixed Value | citation | ||
| Mappings |
| ||
| DiagnosticReport.extension:workflow-relatedArtifact.value[x].label | |||
| Short | Short label | ||
| Definition | A short label that can be used to reference the citation from elsewhere in the containing artifact, such as a footnote index. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Summary | True | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.extension:workflow-relatedArtifact.value[x].display | |||
| Short | Brief description of the related artifact | ||
| Definition | A brief description of the document or knowledge resource being referenced, suitable for display to a consumer. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Summary | True | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.extension:workflow-relatedArtifact.value[x].citation | |||
| Short | Bibliographic citation for the artifact | ||
| Definition | A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format. | ||
| Cardinality | 0..1 | ||
| Type | markdown | ||
| Summary | True | ||
| Comments | Additional structured information about citations should be captured as extensions. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.extension:workflow-relatedArtifact.value[x].url | |||
| Short | Where the artifact can be accessed | ||
| Definition | A url for the artifact that can be followed to access the actual content. | ||
| Cardinality | 0..1 | ||
| Type | url | ||
| Summary | True | ||
| Comments | If a document or resource element is present, this element SHALL NOT be provided (use the url or reference in the Attachment or resource reference). | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.extension:workflow-relatedArtifact.value[x].document | |||
| Short | What document is being referenced | ||
| Definition | The document being referenced, represented as an attachment. This is exclusive with the resource element. | ||
| Cardinality | 0..1 | ||
| Type | Attachment | ||
| Summary | True | ||
| Comments | When providing a summary view (for example with Observation.value[x]) Attachment should be represented with a brief display text such as "Signed Procedure Consent". | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.extension:workflow-relatedArtifact.value[x].resource | |||
| Short | What resource is being referenced | ||
| Definition | The related resource, such as a library, value set, profile, or other knowledge resource. | ||
| Cardinality | 0..1 | ||
| Type | canonical(Resource) | ||
| Summary | True | ||
| Comments | If the type is predecessor, this is a reference to the succeeding knowledge resource. If the type is successor, this is a reference to the prior knowledge resource. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.extension:diagnosticReportCompositionR5 | |||
| Short | A Composition reference for a DiagnosticReport. | ||
| Definition | TBC. Only relevant for EU Lab aligned reports (included in HL7 EU Laboratory Report: DiagnosticReport Profile). A reference to the Composition which wraps this report for data sharing. | ||
| Cardinality | 0..* | ||
| Type | Extension(Reference(Composition)) | ||
| Alias | extensions, user content | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.modifierExtension | |||
| Short | Extensions that cannot be ignored | ||
| 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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Modifier | True | ||
| Alias | extensions, user content | ||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||
| 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. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.identifier | |||
| Short | Business identifier for report | ||
| Definition | Identifiers assigned to this report by the performer or other systems. | ||
| Cardinality | 1..* | ||
| Type | Identifier | ||
| Summary | True | ||
| Alias | ReportID, Filler ID, Placer ID | ||
| 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. | ||
| Comments | Usually assigned by the Information System of the diagnostic service provider (filler id). | ||
| Slicing | Unordered, Open, by system(Pattern) | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.identifier:identifierGMSReport | |||
| Short | Business identifier for report | ||
| Definition | Identifiers assigned to this report by the performer or other systems. | ||
| Cardinality | 0..1 | ||
| Type | Identifier | ||
| Summary | True | ||
| Alias | ReportID, Filler ID, Placer ID | ||
| 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. | ||
| Comments | Usually assigned by the Information System of the diagnostic service provider (filler id). | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.identifier:identifierGMSReport.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| DiagnosticReport.identifier:identifierGMSReport.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| 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. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.identifier:identifierGMSReport.use | |||
| Short | usual | official | temp | secondary | old (If known) | ||
| Definition | The purpose of this identifier. | ||
| Cardinality | 0..0 | ||
| Type | code | ||
| Binding | Identifies the purpose for this identifier, if known . | ||
| Modifier | True | ||
| Summary | True | ||
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | ||
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.identifier:identifierGMSReport.type | |||
| Short | Description of identifier | ||
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. | ||
| Cardinality | 0..0 | ||
| Type | CodeableConcept | ||
| Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||
| Summary | True | ||
| Requirements | Allows users to make use of identifiers when the identifier system is not known. | ||
| Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.identifier:identifierGMSReport.system | |||
| Short | The namespace for the identifier value | ||
| Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | ||
| Cardinality | 1..1 | ||
| Type | uri | ||
| Summary | True | ||
| Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. | ||
| Comments | Identifier.system is always case sensitive. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Fixed Value | https://fhir.nhs.uk/Id/GMSReport | ||
| Examples | Generalhttp://www.acme.com/identifiers/patient | ||
| Mappings |
| ||
| DiagnosticReport.identifier:identifierGMSReport.value | |||
| Short | The value that is unique | ||
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | ||
| Cardinality | 1..1 | ||
| Type | string | ||
| Summary | True | ||
| Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Examples | General123456 | ||
| Mappings |
| ||
| DiagnosticReport.identifier:identifierGMSReport.period | |||
| Short | Time period when id is/was valid for use | ||
| Definition | Time period during which identifier is/was valid for use. | ||
| Cardinality | 0..0 | ||
| Type | Period | ||
| Summary | True | ||
| Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.identifier:identifierGMSReport.assigner | |||
| Short | Organization that issued id (may be just text) | ||
| Definition | Organization that issued/manages the identifier. | ||
| Cardinality | 0..0 | ||
| Type | Reference(Organization) | ||
| Summary | True | ||
| Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.identifier:localIdentifier | |||
| Short | Business identifier for report | ||
| Definition | Identifiers assigned to this report by the performer or other systems. | ||
| Cardinality | 0..* | ||
| Type | Identifier | ||
| Summary | True | ||
| Alias | ReportID, Filler ID, Placer ID | ||
| 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. | ||
| Comments | Usually assigned by the Information System of the diagnostic service provider (filler id). | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.identifier:localIdentifier.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| DiagnosticReport.identifier:localIdentifier.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| 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. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.identifier:localIdentifier.use | |||
| Short | usual | official | temp | secondary | old (If known) | ||
| Definition | The purpose of this identifier. | ||
| Cardinality | 0..1 | ||
| Type | code | ||
| Binding | Identifies the purpose for this identifier, if known . | ||
| Modifier | True | ||
| Summary | True | ||
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | ||
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.identifier:localIdentifier.type | |||
| Short | Description of identifier | ||
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. | ||
| Cardinality | 0..1 | ||
| Type | CodeableConcept | ||
| Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||
| Summary | True | ||
| Requirements | Allows users to make use of identifiers when the identifier system is not known. | ||
| Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.identifier:localIdentifier.system | |||
| Short | The namespace for the identifier value | ||
| Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | ||
| Cardinality | 1..1 | ||
| Type | uri | ||
| Summary | True | ||
| Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. | ||
| Comments | Identifier.system is always case sensitive. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Fixed Value | https://fhir.nhs.uk/local-identifier/diagnosticreport | ||
| Examples | Generalhttp://www.acme.com/identifiers/patient | ||
| Mappings |
| ||
| DiagnosticReport.identifier:localIdentifier.value | |||
| Short | The value that is unique | ||
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | ||
| Cardinality | 1..1 | ||
| Type | string | ||
| Summary | True | ||
| Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Examples | General123456 | ||
| Mappings |
| ||
| DiagnosticReport.identifier:localIdentifier.period | |||
| Short | Time period when id is/was valid for use | ||
| Definition | Time period during which identifier is/was valid for use. | ||
| Cardinality | 0..1 | ||
| Type | Period | ||
| Summary | True | ||
| Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.identifier:localIdentifier.assigner | |||
| Short | Organization that issued id (may be just text) | ||
| Definition | Organization that issued/manages the identifier. | ||
| Cardinality | 1..1 | ||
| Type | Reference(Organization) | ||
| Summary | True | ||
| Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.identifier:localIdentifier.assigner.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| DiagnosticReport.identifier:localIdentifier.assigner.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| 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. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.identifier:localIdentifier.assigner.reference | |||
| Short | Literal reference, Relative, internal or absolute URL | ||
| 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. | ||
| Cardinality | 0..0 | ||
| Type | string | ||
| Summary | True | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, ref-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.identifier:localIdentifier.assigner.type | |||
| Short | Type the reference refers to (e.g. "Patient") | ||
| Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). | ||
| Cardinality | 0..1 | ||
| Type | uri | ||
| Binding | Aa resource (or, for logical models, the URI of the logical model). | ||
| Summary | True | ||
| Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.identifier:localIdentifier.assigner.identifier | |||
| Short | Logical reference, when literal reference is not known | ||
| Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents 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. | ||
| Cardinality | 1..1 | ||
| Type | Identifier | ||
| Summary | True | ||
| 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. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Fixed Value | {
"system": "https://fhir.nhs.uk/Id/ods-organization-code"
} | ||
| Mappings |
| ||
| DiagnosticReport.identifier:localIdentifier.assigner.display | |||
| Short | Text alternative for the resource | ||
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Summary | True | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.basedOn | |||
| Short | What was requested | ||
| Definition | SHOULD reference the originating ServiceRequest if this is an instance of a genomic diagnostic report resulting from a GMS test order. | ||
| Cardinality | 0..1 | ||
| Type | Reference(CarePlan | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest | NHSEngland_ServiceRequest_Genomics) | ||
| Alias | Request | ||
| Requirements | This allows tracing of authorization for the report and tracking whether proposals/recommendations were acted upon. | ||
| Comments | 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.status | |||
| Short | registered | partial | preliminary | final + | ||
| Definition | SHALL use base HL7 codes for DiagnosticReport.status. A DiagnosticReport SHOULD only be marked as final if the report is complete and verified by an authorised person. | ||
| Cardinality | 1..1 | ||
| Type | code | ||
| Binding | The status of the diagnostic report. | ||
| Modifier | True | ||
| Summary | True | ||
| Requirements | Diagnostic services routinely issue provisional/incomplete reports, and sometimes withdraw previously released reports. | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.category | |||
| Short | Service category | ||
| Definition | Potentially multiple categories to specify the specialty the report is relevant for. Different codings are expected by the Genomic Report and EU Lab profiles. | ||
| Cardinality | 1..* | ||
| Type | CodeableConcept | ||
| Binding | Codes for diagnostic service sections. | ||
| Summary | True | ||
| Alias | Department, Sub-department, Service, Discipline | ||
| Comments | Multiple categories are allowed using various categorization schemes. 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. | ||
| Slicing | Unordered, Open, by coding(Value) Slice based on the category code pattern | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.category:Genetics | |||
| Short | Service 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. | ||
| Cardinality | 1..1 | ||
| Type | CodeableConcept | ||
| Binding | Codes for diagnostic service sections. | ||
| Summary | True | ||
| Alias | Department, Sub-department, Service, Discipline | ||
| Comments | Multiple categories are allowed using various categorization schemes. 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.category:Genetics.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| DiagnosticReport.category:Genetics.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| 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. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.category:Genetics.coding | |||
| Short | Code defined by a terminology system | ||
| Definition | A reference to a code defined by a terminology system. | ||
| Cardinality | 1..1 | ||
| Type | Coding | ||
| Summary | True | ||
| Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Pattern | {
"system": "http://terminology.hl7.org/CodeSystem/v2-0074",
"code": "GE"
} | ||
| Mappings |
| ||
| DiagnosticReport.category:Genetics.text | |||
| Short | Plain text representation of the concept | ||
| 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. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| 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. | ||
| Comments | Very often the text is the same as a displayName of one of the codings. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.category:GeneticsSnomedCT | |||
| Short | Service 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. | ||
| Cardinality | 0..* | ||
| Type | CodeableConcept | ||
| Binding | Codes for diagnostic service sections. | ||
| Summary | True | ||
| Alias | Department, Sub-department, Service, Discipline | ||
| Comments | Multiple categories are allowed using various categorization schemes. 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.category:GeneticsSnomedCT.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| DiagnosticReport.category:GeneticsSnomedCT.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| 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. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.category:GeneticsSnomedCT.coding | |||
| Short | Code defined by a terminology system | ||
| Definition | A reference to a code defined by a terminology system. | ||
| Cardinality | 0..* | ||
| Type | Coding | ||
| Summary | True | ||
| Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Pattern | {
"system": "http://snomed.info/sct",
"code": "1236877003",
"display": "Genetic pathology"
} | ||
| Mappings |
| ||
| DiagnosticReport.category:GeneticsSnomedCT.text | |||
| Short | Plain text representation of the concept | ||
| 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. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| 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. | ||
| Comments | Very often the text is the same as a displayName of one of the codings. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.code | |||
| Short | Name/Code for this diagnostic report | ||
| Definition | SHOULD use a record artifact concept from SNOMED CT where an appropriate code exists, else text is preferred to indicate the document type. | ||
| Cardinality | 1..1 | ||
| Type | CodeableConcept | ||
| Binding | Codes that describe Diagnostic Reports. | ||
| Summary | True | ||
| Alias | Type | ||
| Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Pattern | {
"coding": [
{
"system": "http://loinc.org",
"code": "51969-4"
}
]
} | ||
| Mappings |
| ||
| DiagnosticReport.code.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| DiagnosticReport.code.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| 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. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.code.coding | |||
| Short | Code defined by a terminology system | ||
| Definition | A reference to a code defined by a terminology system. | ||
| Cardinality | 0..* | ||
| Type | Coding | ||
| Summary | True | ||
| Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||
| 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. | ||
| Slicing | Unordered, Open, by $this(Pattern) | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Pattern | {
"system": "http://loinc.org",
"code": "51969-4"
} | ||
| Mappings |
| ||
| DiagnosticReport.code.coding:codingSnomedCT | |||
| Short | Code defined by a terminology system | ||
| Definition | A reference to a code defined by a terminology system. | ||
| Cardinality | 0..* | ||
| Type | Coding | ||
| Binding | |||
| Summary | True | ||
| Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.code.text | |||
| Short | Plain text representation of the concept | ||
| 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. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| 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. | ||
| Comments | Very often the text is the same as a displayName of one of the codings. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.subject | |||
| Short | The subject of the report - usually, but not always, the patient | ||
| Definition | SHALL be present. Reference to the associated Patient. This MAY be through a resource reference if the ID on the central service is known (or provided within the transaction bundle) or through NHS number where this is known and has been traced through PDS | ||
| Cardinality | 1..1 | ||
| Type | Reference(Device | Group | Location | Patient | NHSEngland_Patient_Genomics) | ||
| Summary | True | ||
| Alias | Patient | ||
| Requirements | SHALL know the subject context. | ||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.encounter | |||
| Short | Health care event when test ordered | ||
| Definition | The healthcare event (e.g. a patient and healthcare provider interaction) which this DiagnosticReport is about. | ||
| Cardinality | 0..1 | ||
| Type | Reference(Encounter) | ||
| Summary | True | ||
| Alias | Context | ||
| Requirements | Links the request to the Encounter context. | ||
| 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 but still be tied to the context of the encounter (e.g. pre-admission laboratory tests). | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.effective[x] | |||
| Short | Clinically relevant time/time-period for report | ||
| 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. | ||
| Cardinality | 0..1 | ||
| Type | dateTime | ||
| Summary | True | ||
| Alias | Observation time, Effective Time, Occurrence | ||
| Requirements | Need to know where in the patient history to file/present this 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.issued | |||
| Short | DateTime this version was made | ||
| Definition | The date and time that this version of the report was made available to providers, typically after the report was reviewed and verified. | ||
| Cardinality | 1..1 | ||
| Type | instant | ||
| Summary | True | ||
| Alias | Date published, Date Issued, Date Verified | ||
| Requirements | Clinicians need to be able to check the date that the report 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.performer | |||
| Short | Responsible Diagnostic Service | ||
| Definition | SHOULD reference the organization responsible for the testing, preferably by ODS code. | ||
| Cardinality | 0..* | ||
| Type | Reference(CareTeam | Organization | Practitioner | PractitionerRole | UKCoreOrganization) | ||
| Summary | True | ||
| Alias | Laboratory, Service, Practitioner, Department, Company, Authorized by, Director | ||
| 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. | ||
| Comments | This is not necessarily the source of the atomic data items or the entity that interpreted the results. It is the entity that takes responsibility for the clinical report. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.performer.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| DiagnosticReport.performer.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| 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. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.performer.reference | |||
| Short | Literal reference, Relative, internal or absolute URL | ||
| 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. | ||
| Cardinality | 0..0 | ||
| Type | string | ||
| Summary | True | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, ref-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.performer.type | |||
| Short | Type the reference refers to (e.g. "Patient") | ||
| Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). | ||
| Cardinality | 0..1 | ||
| Type | uri | ||
| Binding | Aa resource (or, for logical models, the URI of the logical model). | ||
| Summary | True | ||
| Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.performer.identifier | |||
| Short | Logical reference, when literal reference is not known | ||
| Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents 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. | ||
| Cardinality | 1..1 | ||
| Type | Identifier | ||
| Summary | True | ||
| 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. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.performer.identifier.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| DiagnosticReport.performer.identifier.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| 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. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.performer.identifier.use | |||
| Short | usual | official | temp | secondary | old (If known) | ||
| Definition | The purpose of this identifier. | ||
| Cardinality | 0..1 | ||
| Type | code | ||
| Binding | Identifies the purpose for this identifier, if known . | ||
| Modifier | True | ||
| Summary | True | ||
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | ||
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.performer.identifier.type | |||
| Short | Description of identifier | ||
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. | ||
| Cardinality | 0..1 | ||
| Type | CodeableConcept | ||
| Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||
| Summary | True | ||
| Requirements | Allows users to make use of identifiers when the identifier system is not known. | ||
| Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.performer.identifier.system | |||
| Short | The namespace for the identifier value | ||
| Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | ||
| Cardinality | 0..1 | ||
| Type | uri | ||
| Summary | True | ||
| Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. | ||
| Comments | Identifier.system is always case sensitive. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Fixed Value | https://fhir.nhs.uk/Id/ods-organisation-code | ||
| Examples | Generalhttp://www.acme.com/identifiers/patient | ||
| Mappings |
| ||
| DiagnosticReport.performer.identifier.value | |||
| Short | The value that is unique | ||
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Summary | True | ||
| Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Examples | General123456 | ||
| Mappings |
| ||
| DiagnosticReport.performer.identifier.period | |||
| Short | Time period when id is/was valid for use | ||
| Definition | Time period during which identifier is/was valid for use. | ||
| Cardinality | 0..1 | ||
| Type | Period | ||
| Summary | True | ||
| Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.performer.identifier.assigner | |||
| Short | Organization that issued id (may be just text) | ||
| Definition | Organization that issued/manages the identifier. | ||
| Cardinality | 0..1 | ||
| Type | Reference(Organization) | ||
| Summary | True | ||
| Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.performer.display | |||
| Short | Text alternative for the resource | ||
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Summary | True | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.resultsInterpreter | |||
| Short | Primary result interpreter | ||
| Definition | SHOULD reference the person responsible for interpreting the raw results, preferably by a recognised NHS identifier, such as SDS code. | ||
| Cardinality | 0..* | ||
| Type | Reference(CareTeam | Organization | Practitioner | PractitionerRole | NHSEngland_PractitionerRole_Genomics) | ||
| Summary | True | ||
| Alias | Analyzed by, Reported by | ||
| 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. | ||
| Comments | Might not be the same entity that takes responsibility for the clinical report. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.specimen | |||
| Short | Specimens this report is based on | ||
| Definition | SHOULD reference the specimen used during testing to generate the report, if the document is a Genomic report. | ||
| Cardinality | 1..* | ||
| Type | Reference(Specimen | NHSEngland_Specimen_Genomics) | ||
| Requirements | Need to be able to report information about the collected specimens on which the report is based. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.result | |||
| Short | Observations | ||
| Definition | Raw results included within the report, to aid interpretation. These SHOULD take the form of Observation references, if providing a structured report. | ||
| Cardinality | 0..* | ||
| Type | Reference(Observation) | ||
| Alias | Data, Atomic Value, Result, Atomic result, Data, Test, Analyte, Battery, Organizer | ||
| Requirements | Need to support individual results, or groups of results, where the result grouping is arbitrary, but meaningful. | ||
| Comments | Observations can contain observations. | ||
| Slicing | Unordered, Open, by resolve()(Profile) Slice based on the reference profile and code pattern | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.result:diagnostic-implication | |||
| Short | Diagnostic Implication | ||
| Definition | Observations that are part of this diagnostic report. | ||
| Cardinality | 0..* | ||
| Type | Reference(DiagnosticImplication) | ||
| Alias | Data, Atomic Value, Result, Atomic result, Data, Test, Analyte, Battery, Organizer | ||
| Requirements | Need to support individual results, or groups of results, where the result grouping is arbitrary, but meaningful. | ||
| Comments | Observations can contain observations. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.result:therapeutic-implication | |||
| Short | Therapeutic Implication | ||
| Definition | Observations that are part of this diagnostic report. | ||
| Cardinality | 0..* | ||
| Type | Reference(TherapeuticImplication) | ||
| Alias | Data, Atomic Value, Result, Atomic result, Data, Test, Analyte, Battery, Organizer | ||
| Requirements | Need to support individual results, or groups of results, where the result grouping is arbitrary, but meaningful. | ||
| Comments | Observations can contain observations. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.result:molecular-consequence | |||
| Short | Molecular Consequence | ||
| Definition | Observations that are part of this diagnostic report. | ||
| Cardinality | 0..* | ||
| Type | Reference(MolecularConsequence) | ||
| Alias | Data, Atomic Value, Result, Atomic result, Data, Test, Analyte, Battery, Organizer | ||
| Requirements | Need to support individual results, or groups of results, where the result grouping is arbitrary, but meaningful. | ||
| Comments | Observations can contain observations. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.result:variant | |||
| Short | Variant | ||
| Definition | Observations that are part of this diagnostic report. | ||
| Cardinality | 0..* | ||
| Type | Reference(Variant) | ||
| Alias | Data, Atomic Value, Result, Atomic result, Data, Test, Analyte, Battery, Organizer | ||
| Requirements | Need to support individual results, or groups of results, where the result grouping is arbitrary, but meaningful. | ||
| Comments | Observations can contain observations. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.result:sequence-phase-relation | |||
| Short | Sequence Phase Relationship | ||
| Definition | Observations that are part of this diagnostic report. | ||
| Cardinality | 0..* | ||
| Type | Reference(SequencePhaseRelationship) | ||
| Alias | Data, Atomic Value, Result, Atomic result, Data, Test, Analyte, Battery, Organizer | ||
| Requirements | Need to support individual results, or groups of results, where the result grouping is arbitrary, but meaningful. | ||
| Comments | Observations can contain observations. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.result:genotype | |||
| Short | Genotype | ||
| Definition | Observations that are part of this diagnostic report. | ||
| Cardinality | 0..* | ||
| Type | Reference(Genotype) | ||
| Alias | Data, Atomic Value, Result, Atomic result, Data, Test, Analyte, Battery, Organizer | ||
| Requirements | Need to support individual results, or groups of results, where the result grouping is arbitrary, but meaningful. | ||
| Comments | Observations can contain observations. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.result:haplotype | |||
| Short | Haplotype | ||
| Definition | Observations that are part of this diagnostic report. | ||
| Cardinality | 0..* | ||
| Type | Reference(Haplotype) | ||
| Alias | Data, Atomic Value, Result, Atomic result, Data, Test, Analyte, Battery, Organizer | ||
| Requirements | Need to support individual results, or groups of results, where the result grouping is arbitrary, but meaningful. | ||
| Comments | Observations can contain observations. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.result:biomarker | |||
| Short | MolecularBiomarker | ||
| Definition | Observations that are part of this diagnostic report. | ||
| Cardinality | 0..* | ||
| Type | Reference(MolecularBiomarker) | ||
| Alias | Data, Atomic Value, Result, Atomic result, Data, Test, Analyte, Battery, Organizer | ||
| Requirements | Need to support individual results, or groups of results, where the result grouping is arbitrary, but meaningful. | ||
| Comments | Observations can contain observations. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.imagingStudy | |||
| Short | Reference to full details of imaging associated with the diagnostic report | ||
| 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. | ||
| Cardinality | 0..0 | ||
| Type | Reference(ImagingStudy) | ||
| Comments | ImagingStudy 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.media | |||
| Short | Key images associated with this report | ||
| Definition | TBC. Only relevant for structured genomic reports. Uses the extension:alternate-reference extension to reference DocumentReference resources pointing to the Genomic Data Files used as the basis for the report. Usage of this field over extension:supporting-info is pending further investigation. | ||
| Cardinality | 0..* | ||
| Type | BackboneElement | ||
| Summary | True | ||
| Alias | DICOM, Slides, Scans | ||
| Requirements | Many diagnostic services include images in the report as part of their service. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.media.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| DiagnosticReport.media.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| 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. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.media.modifierExtension | |||
| Short | Extensions that cannot be ignored even if unrecognized | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Modifier | True | ||
| Summary | True | ||
| Alias | extensions, user content, modifiers | ||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.media.comment | |||
| Short | Comment about the image (e.g. explanation) | ||
| 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. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Requirements | The provider of the report should make a comment about each image included in the report. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.media.link | |||
| Short | Reference to the image source | ||
| Definition | Reference to the image source. | ||
| Cardinality | 1..1 | ||
| Type | Reference(Media) | ||
| Summary | True | ||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.media.link.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| DiagnosticReport.media.link.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| 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. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.media.link.extension:alternateReference | |||
| Short | Alternative reference (target type is wrong) | ||
| Definition | Used when the target of the reference has a type that is not allowed by the definition of the element. In general, this should only arise when wrangling between versions using cross-version extensions. | ||
| Cardinality | 0..1 | ||
| Type | Extension(Reference(Resource)) | ||
| Alias | extensions, user content | ||
| Comments | Given that a reference SHALL have a display or reference, using this extension implies that there's a display present. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.media.link.extension:alternateReference.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| DiagnosticReport.media.link.extension:alternateReference.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..0 | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| 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. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.media.link.extension:alternateReference.url | |||
| Short | identifies the meaning of the extension | ||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||
| Cardinality | 1..1 | ||
| Type | uri | ||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||
| Fixed Value | http://hl7.org/fhir/StructureDefinition/alternate-reference | ||
| Mappings |
| ||
| DiagnosticReport.media.link.extension:alternateReference.value[x] | |||
| Short | Value of extension | ||
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||
| Cardinality | 1..1 | ||
| Type | Reference(Resource | https://fhir.nhs.uk/StructureDefinition/NHSEngland-DocumentReference-Genomics) | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.media.link.reference | |||
| Short | Literal reference, Relative, internal or absolute URL | ||
| 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. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Summary | True | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, ref-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.media.link.type | |||
| Short | Type the reference refers to (e.g. "Patient") | ||
| Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). | ||
| Cardinality | 0..1 | ||
| Type | uri | ||
| Binding | Aa resource (or, for logical models, the URI of the logical model). | ||
| Summary | True | ||
| Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.media.link.identifier | |||
| Short | Logical reference, when literal reference is not known | ||
| Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents 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. | ||
| Cardinality | 0..1 | ||
| Type | Identifier | ||
| Summary | True | ||
| 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. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.media.link.display | |||
| Short | Text alternative for the resource | ||
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Summary | True | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.conclusion | |||
| Short | Assessment of overall results | ||
| Definition | Concise and clinically contextualized summary conclusion (interpretation/impression) of the diagnostic report. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Alias | Report | ||
| Requirements | Need to be able to provide a conclusion that is not lost among the basic result data. | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.conclusionCode | |||
| Short | Coarse overall interpretation of the genomic results | ||
| Definition | If possible, unstructured reports wrapped within DiagnosticReports, SHOULD contain a conclusionCode element indicating the coded finding from the report, to aid analytics. | ||
| Cardinality | 0..* | ||
| Type | CodeableConcept | ||
| Binding | Diagnosis codes provided as adjuncts to the report. | ||
| Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.presentedForm | |||
| Short | Entire report as issued | ||
| Definition | Genomic reports SHALL include a presentedForm element either referencing the location of the PDF report (located and accessible on either the source/client system or via NRL using appropriate authentication) or include the PDF report as a base64 encoded attachment within the message payload. Note: this guidance may change in the future as work on Structured Reporting matures | ||
| Cardinality | 1..* | ||
| Type | Attachment | ||
| Requirements | Gives laboratory the ability to provide its own fully formatted report for clinical fidelity. | ||
| Comments | "application/pdf" is recommended as the most reliable and interoperable in this context. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
Table View
| DiagnosticReport | 0..* | |
| DiagnosticReport.id | id | 0..1 |
| DiagnosticReport.meta | Meta | 0..1 |
| DiagnosticReport.implicitRules | uri | 0..1 |
| DiagnosticReport.language | code | 0..1 |
| DiagnosticReport.text | Narrative | 0..1 |
| DiagnosticReport.contained | Resource | 0..* |
| DiagnosticReport.extension | Extension | 0..* |
| DiagnosticReport.extension:recommended-action | Extension | 0..* |
| DiagnosticReport.extension:genomic-risk-assessment | Extension | 0..* |
| DiagnosticReport.extension:coded-note | Extension | 0..* |
| DiagnosticReport.extension:supporting-info | Extension | 0..* |
| DiagnosticReport.extension:genomic-study | Extension | 0..* |
| DiagnosticReport.extension:hla-genotyping-results-allele-database | Extension | 0..1 |
| DiagnosticReport.extension:hla-genotyping-results-glstring | Extension | 0..1 |
| DiagnosticReport.extension:workflow-relatedArtifact | Extension | 0..* |
| DiagnosticReport.extension:workflow-relatedArtifact.id | string | 0..1 |
| DiagnosticReport.extension:workflow-relatedArtifact.extension | Extension | 0..0 |
| DiagnosticReport.extension:workflow-relatedArtifact.url | uri | 1..1 |
| DiagnosticReport.extension:workflow-relatedArtifact.value[x] | RelatedArtifact | 1..1 |
| DiagnosticReport.extension:workflow-relatedArtifact.value[x].id | string | 0..1 |
| DiagnosticReport.extension:workflow-relatedArtifact.value[x].extension | Extension | 0..* |
| DiagnosticReport.extension:workflow-relatedArtifact.value[x].type | code | 1..1 |
| DiagnosticReport.extension:workflow-relatedArtifact.value[x].label | string | 0..1 |
| DiagnosticReport.extension:workflow-relatedArtifact.value[x].display | string | 0..1 |
| DiagnosticReport.extension:workflow-relatedArtifact.value[x].citation | markdown | 0..1 |
| DiagnosticReport.extension:workflow-relatedArtifact.value[x].url | url | 0..1 |
| DiagnosticReport.extension:workflow-relatedArtifact.value[x].document | Attachment | 0..1 |
| DiagnosticReport.extension:workflow-relatedArtifact.value[x].resource | canonical(Resource) | 0..1 |
| DiagnosticReport.extension:diagnosticReportCompositionR5 | Extension | 0..* |
| DiagnosticReport.modifierExtension | Extension | 0..* |
| DiagnosticReport.identifier | Identifier | 1..* |
| DiagnosticReport.identifier:identifierGMSReport | Identifier | 0..1 |
| DiagnosticReport.identifier:identifierGMSReport.id | string | 0..1 |
| DiagnosticReport.identifier:identifierGMSReport.extension | Extension | 0..* |
| DiagnosticReport.identifier:identifierGMSReport.use | code | 0..0 |
| DiagnosticReport.identifier:identifierGMSReport.type | CodeableConcept | 0..0 |
| DiagnosticReport.identifier:identifierGMSReport.system | uri | 1..1 |
| DiagnosticReport.identifier:identifierGMSReport.value | string | 1..1 |
| DiagnosticReport.identifier:identifierGMSReport.period | Period | 0..0 |
| DiagnosticReport.identifier:identifierGMSReport.assigner | Reference(Organization) | 0..0 |
| DiagnosticReport.identifier:localIdentifier | Identifier | 0..* |
| DiagnosticReport.identifier:localIdentifier.id | string | 0..1 |
| DiagnosticReport.identifier:localIdentifier.extension | Extension | 0..* |
| DiagnosticReport.identifier:localIdentifier.use | code | 0..1 |
| DiagnosticReport.identifier:localIdentifier.type | CodeableConcept | 0..1 |
| DiagnosticReport.identifier:localIdentifier.system | uri | 1..1 |
| DiagnosticReport.identifier:localIdentifier.value | string | 1..1 |
| DiagnosticReport.identifier:localIdentifier.period | Period | 0..1 |
| DiagnosticReport.identifier:localIdentifier.assigner | Reference(Organization) | 1..1 |
| DiagnosticReport.identifier:localIdentifier.assigner.id | string | 0..1 |
| DiagnosticReport.identifier:localIdentifier.assigner.extension | Extension | 0..* |
| DiagnosticReport.identifier:localIdentifier.assigner.reference | string | 0..0 |
| DiagnosticReport.identifier:localIdentifier.assigner.type | uri | 0..1 |
| DiagnosticReport.identifier:localIdentifier.assigner.identifier | Identifier | 1..1 |
| DiagnosticReport.identifier:localIdentifier.assigner.display | string | 0..1 |
| DiagnosticReport.basedOn | Reference(CarePlan | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest | NHSEngland_ServiceRequest_Genomics) | 0..1 |
| DiagnosticReport.status | code | 1..1 |
| DiagnosticReport.category | CodeableConcept | 1..* |
| DiagnosticReport.category:Genetics | CodeableConcept | 1..1 |
| DiagnosticReport.category:Genetics.id | string | 0..1 |
| DiagnosticReport.category:Genetics.extension | Extension | 0..* |
| DiagnosticReport.category:Genetics.coding | Coding | 1..1 |
| DiagnosticReport.category:Genetics.text | string | 0..1 |
| DiagnosticReport.category:GeneticsSnomedCT | CodeableConcept | 0..* |
| DiagnosticReport.category:GeneticsSnomedCT.id | string | 0..1 |
| DiagnosticReport.category:GeneticsSnomedCT.extension | Extension | 0..* |
| DiagnosticReport.category:GeneticsSnomedCT.coding | Coding | 0..* |
| DiagnosticReport.category:GeneticsSnomedCT.text | string | 0..1 |
| DiagnosticReport.code | CodeableConcept | 1..1 |
| DiagnosticReport.code.id | string | 0..1 |
| DiagnosticReport.code.extension | Extension | 0..* |
| DiagnosticReport.code.coding | Coding | 0..* |
| DiagnosticReport.code.coding:codingSnomedCT | Coding | 0..* |
| DiagnosticReport.code.text | string | 0..1 |
| DiagnosticReport.subject | Reference(Device | Group | Location | Patient | NHSEngland_Patient_Genomics) | 1..1 |
| DiagnosticReport.encounter | Reference(Encounter) | 0..1 |
| DiagnosticReport.effective[x] | dateTime | 0..1 |
| DiagnosticReport.issued | instant | 1..1 |
| DiagnosticReport.performer | Reference(CareTeam | Organization | Practitioner | PractitionerRole | UKCoreOrganization) | 0..* |
| DiagnosticReport.performer.id | string | 0..1 |
| DiagnosticReport.performer.extension | Extension | 0..* |
| DiagnosticReport.performer.reference | string | 0..0 |
| DiagnosticReport.performer.type | uri | 0..1 |
| DiagnosticReport.performer.identifier | Identifier | 1..1 |
| DiagnosticReport.performer.identifier.id | string | 0..1 |
| DiagnosticReport.performer.identifier.extension | Extension | 0..* |
| DiagnosticReport.performer.identifier.use | code | 0..1 |
| DiagnosticReport.performer.identifier.type | CodeableConcept | 0..1 |
| DiagnosticReport.performer.identifier.system | uri | 0..1 |
| DiagnosticReport.performer.identifier.value | string | 0..1 |
| DiagnosticReport.performer.identifier.period | Period | 0..1 |
| DiagnosticReport.performer.identifier.assigner | Reference(Organization) | 0..1 |
| DiagnosticReport.performer.display | string | 0..1 |
| DiagnosticReport.resultsInterpreter | Reference(CareTeam | Organization | Practitioner | PractitionerRole | NHSEngland_PractitionerRole_Genomics) | 0..* |
| DiagnosticReport.specimen | Reference(Specimen | NHSEngland_Specimen_Genomics) | 1..* |
| DiagnosticReport.result | Reference(Observation) | 0..* |
| DiagnosticReport.result:diagnostic-implication | Reference(DiagnosticImplication) | 0..* |
| DiagnosticReport.result:therapeutic-implication | Reference(TherapeuticImplication) | 0..* |
| DiagnosticReport.result:molecular-consequence | Reference(MolecularConsequence) | 0..* |
| DiagnosticReport.result:variant | Reference(Variant) | 0..* |
| DiagnosticReport.result:sequence-phase-relation | Reference(SequencePhaseRelationship) | 0..* |
| DiagnosticReport.result:genotype | Reference(Genotype) | 0..* |
| DiagnosticReport.result:haplotype | Reference(Haplotype) | 0..* |
| DiagnosticReport.result:biomarker | Reference(MolecularBiomarker) | 0..* |
| DiagnosticReport.imagingStudy | Reference(ImagingStudy) | 0..0 |
| DiagnosticReport.media | BackboneElement | 0..* |
| DiagnosticReport.media.id | string | 0..1 |
| DiagnosticReport.media.extension | Extension | 0..* |
| DiagnosticReport.media.modifierExtension | Extension | 0..* |
| DiagnosticReport.media.comment | string | 0..1 |
| DiagnosticReport.media.link | Reference(Media) | 1..1 |
| DiagnosticReport.media.link.id | string | 0..1 |
| DiagnosticReport.media.link.extension | Extension | 0..* |
| DiagnosticReport.media.link.extension:alternateReference | Extension | 0..1 |
| DiagnosticReport.media.link.extension:alternateReference.id | string | 0..1 |
| DiagnosticReport.media.link.extension:alternateReference.extension | Extension | 0..0 |
| DiagnosticReport.media.link.extension:alternateReference.url | uri | 1..1 |
| DiagnosticReport.media.link.extension:alternateReference.value[x] | Reference(Resource | https://fhir.nhs.uk/StructureDefinition/NHSEngland-DocumentReference-Genomics) | 1..1 |
| DiagnosticReport.media.link.reference | string | 0..1 |
| DiagnosticReport.media.link.type | uri | 0..1 |
| DiagnosticReport.media.link.identifier | Identifier | 0..1 |
| DiagnosticReport.media.link.display | string | 0..1 |
| DiagnosticReport.conclusion | string | 0..1 |
| DiagnosticReport.conclusionCode | CodeableConcept | 0..* |
| DiagnosticReport.presentedForm | Attachment | 1..* |
XML View
JSON View
- DiagnosticReport-AnitaLamberts-Example
- DiagnosticReport-FayMutlowGeneticReport-Example
- DiagnosticReport-JamesMetcalfeGeneticReport-Example
- DiagnosticReport-PhoebeSmithGeneticReport-Example
- DiagnosticReport-MichaelJonesReport
- DiagnosticReport-MichaelJonesReport-Minimal
- DiagnosticReport-GenomicVariantAssessment-Example
| FHIR | MDS | HL7v2 |
|---|---|---|
| DiagnosticReport | Previous Genomic Report, Previous Diagnostic Report | OBX |
| DiagnosticReport.effectiveDateTime | PLCM activity - Date and time dataset created, PLCM activity - Turnaround time (calendar days), Previous genomic report - Test performed date, Previous non genomic report - Test performed date | Derived from OBR-7 in the ORU response message for the activity based on the OML request, OBX-19 |
| DiagnosticReport.identifier | PLCM activity - Local report identifier, Previous genomic report - Report identifier, Previous non genomic report - Report identifier | OBR-3 for report |
| DiagnosticReport.result | PLCM activity - Test outcome code (Many), Previous non genomic report - Test result value comparator, Previous non genomic report - Test result value unit of measure, Previous non genomic report - Test result reference range low, Previous non genomic report - Test result reference range high, Previous non genomic report - Test result test method, Previous non genomic report - Test result reference range text, Previous non genomic report - Test result clinical summary | OBX-3 elements for resulting report, OBX-5, OBX-6, OBX-7 (before operator), OBX-7 (after operator), OBX-17, OBX-7, OBX-8 |
| DiagnosticReport.conclusion | Previous genomic report - Report referral summary, Previous non genomic report - Report referral summary | OBX-5 |
| DiagnosticReport.presentedForm | Previous genomic report - Report file/link, Previous non genomic report - Report file/link | OBX-5 where OBX-2=ED or RP |
| DiagnosticReport.subject | Previous genomic report - Patient's first name, Previous genomic report - Patient's surname, Previous genomic report - Patient's address, Previous genomic report - Patient's post code, Previous genomic report - Patient's country, Previous genomic report - Patient's date of birth, Previous genomic report - Patient's NHS number, Previous genomic report - Patient's alternative identifier, Previous genomic report - Patient's relationship to requesting patient, Previous genomic report - Patient's clinical genetics number, Previous genomic report - Patient's pedigree number | PID attached to Patient Prior |
| DiagnosticReport.basedOn | Previous genomic report - Report lab test number, Previous genomic report - Original requester full name, Previous genomic report - Original requester organisation ODS code, Previous genomic report - Original requester reason for request, Previous non genomic report - Original requester full name, Previous non genomic report - Original requester organisation ODS code, Previous non genomic report - Original requester reason for request | ORC-2, ORC-12, ORC-21.10, ORC-16 |
| DiagnosticReport.conclusionCode | Previous genomic report - Report of genetic analysis, Previous non genomic report - Report result | OBR-5 |
| DiagnosticReport.performer | Previous genomic report - Report performer full name, Previous genomic report - Report performer organisation ODS code, Previous non genomic report - Report performer full name, Previous non genomic report - Report performer organisation ODS code | OBX-16, OBX-23.10 |
| DiagnosticReport.code | Previous non genomic report - Test type | OBR-4 |
Additional Guidance
- extension:recommended-action
- extension:genomic-study
- extension:supporting-info
- extension:workflow-relatedArtifact
- extension:DiagnosticReportCompositionR5
- basedOn
- status
- category
- code
- subject
- performer
- resultsInterpreter
- specimen
- media
- result
- conclusionCode
- presentedForm
extension:recommended-action
TBC. Only relevant for structured genomic reports (included in the Genomic Report Profile in the Genomics Report IG). Reference to Task resource indicating recommended action to take in response to the report's result/conclusion."extension" : [ { "url" : "http://hl7.org/fhir/uv/genomics-reporting/StructureDefinition/recommended-action", "valueReference" : { "reference" : "Task/MedicationRecommendationExample1" } } ],
extension:genomic-study
TBC. Only relevant for structured genomic reports (included in the Genomic Report Profile in the Genomics Report IG). Reference to Procedure resources indicating the analyses performed as part the genomic test order."extension" : [ { "url" : "http://hl7.org/fhir/uv/genomics-reporting/StructureDefinition/genomic-study-reference", "valueReference" : { 🔗 "reference" : "Procedure/PGXGenomicStudy" } } ]
extension:supporting-info
TBC. Only relevant for structured genomic reports (included in the Genomic Report Profile in the Genomics Report IG). Reference to the genomic data files analysed as part of the test order, forming the report. Reference to DocumentReference resource which links to the binary data file."extension" : [ { "url" : "http://hl7.org/fhir/StructureDefinition/workflow-supportingInfo", "valueReference" : { "reference" : "DocumentReference/DocumentReference-PharmCAT-Example" } } ],
extension:workflow-relatedArtifact
TBC. Only relevant for structured genomic reports (included in Genomic Report Profile in the Genomics Report IG). A reference to the guidelines or other knowledge artifacts which were used to guide interpretation or recommended actions included within this DiagnosticReport.If entries constitute published papers, they SHOULD be referenced using a known citation style, e.g. Vancouver/Harvard. Alternatively for online texts, these MAY be referenced via URL only.
A fixed value of 'citation' is expected for the type element, though this recommendation is pending further use cases.
"extension" : [ { "url" : "http://hl7.org/fhir/StructureDefinition/workflow-relatedArtifact", "valueRelatedArtifact" : { "type" : "citation", "url" : "https://cpicpgx.org/guidelines/guideline-for-clopidogrel-and-cyp2c19)" } } ],
extension:DiagnosticReportCompositionR5
TBC. Only relevant for EU Lab aligned reports (included in HL7 EU Laboratory Report: DiagnosticReport Profile). A reference to the Composition which wraps this report for data sharing."extension": [ { "url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.composition", "valueReference": { "reference": "Composition/Composition-EULabGenomicReport-Example" } } ],
basedOn
SHOULD reference the originating ServiceRequest if this is an instance of a genomic diagnostic report resulting from a GMS test order."basedOn": [ { "reference": "ServiceRequest-SavedTestOrder-Example" } ],
status
SHALL use base HL7 codes for DiagnosticReport.status. A DiagnosticReport SHOULD only be marked as final if the report is complete and verified by an authorised person.Codes for DiagnosticReport status and usage within Genomics are provided below:
| Lvl | Code | Definition | Usage within Genomics |
|---|---|---|---|
| 1 | registered | The existence of the report is registered, but there is nothing yet available. | Not expected to be used within Genomics |
| 1 | partial | This is a partial (e.g. initial, interim or preliminary) report: data in the report may be incomplete or unverified. | MAY be used for interim reports, SHALL NOT be used for reports intended to be acted upon by clinicians |
| 2 | preliminary | Verified early results are available, but not all results are final. | MAY be used within Genomics |
| 1 | final | The report is complete and verified by an authorized person. | SHALL be used for final reports |
| 1 | amended | Subsequent to being final, the report has been modified. This includes any change in the results, diagnosis, narrative text, or other content of a report that has been issued. | SHOULD be used for resports ammended after submission of a final report |
| 2 | corrected | Subsequent to being final, the report has been modified to correct an error in the report or referenced results. | MAY be used in place of ammended for a correction to a finalised report |
| 2 | appended | Subsequent to being final, the report has been modified by adding new content. The existing content is unchanged. | Not expected to be used within Genomics but MAY be used where applicable, pending use case identification |
| 1 | cancelled | The report is unavailable because the measurement was not started or not completed (also sometimes called "aborted"). | MAY be used where a lab submits a cancellation/failure report, pending use case identification and testing |
| 1 | entered-in-error | The report has been withdrawn following a previous final release. This electronic record should never have existed, though it is possible that real-world decisions were based on it. (If real-world activity has occurred, the status should be "cancelled" rather than "entered-in-error".). | Not expected to be used within Genomics |
| 1 | unknown | The authoring/source system does not know which of the status values currently applies for this observation. Note: This concept is not to be used for "other" - one of the listed statuses is presumed to apply, but the authoring/source system does not know which. | SHALL NOT be used within Genomics |
"status": "final",
category
Potentially multiple categories to specify the specialty the report is relevant for. Different codings are expected by the Genomic Report and EU Lab profiles."category": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v2-0074", "code": "GE" } ] }, { "coding": [ { "system": "http://snomed.info/sct", "code": "1236877003", "display": "Genetic pathology" } ] } ],
code
SHOULD use a record artifact concept from SNOMED CT where an appropriate code exists, else text is preferred to indicate the document type."code": { "coding": [ { "system": "http://snomed.info/sct", "code": "4321000179101", "display": "Hematology report (record artifact)" } ] },
subject
SHALL be present. Reference to the associated Patient. This MAY be through a resource reference if the ID on the central service is known (or provided within the transaction bundle) or through NHS number where this is known and has been traced through PDS"subject": { "reference": "Patient/Patient-MeirLieberman-Example", "identifier": { "system": "https://fhir.nhs.uk/Id/nhs-number", "value": "9449307873" } },
performer
SHOULD reference the organization responsible for the testing, preferably by ODS code."performer": [ { "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "REP" } } ],
resultInterpreter
SHOULD reference the person responsible for interpreting the raw results, preferably by a recognised NHS identifier, such as SDS code."resultsInterpreter": [ { "identifier": { "system": "https://fhir.nhs.uk/Id/sds-user-id", "value": "999999999999" } } ],
specimen
SHOULD reference the specimen used during testing to generate the report, if the document is a Genomic report."specimen": [ { "reference": "Specimen/Specimen-BloodEDTA-Example" } ],
result
Raw results included within the report, to aid interpretation. These SHOULD take the form of Observation references, if providing a structured report."result" : [ { "reference" : "Observation/TherapeuticImplicationExample1", "display" : "impact for high risk allele" }, { "reference" : "Observation/GenotypeExample1" }, { "reference" : "Observation/OverallInterpExample1" } ]
media
TBC. Only relevant for structured genomic reports. Uses the extension:alternate-reference extension to reference DocumentReference resources pointing to the Genomic Data Files used as the basis for the report. Usage of this field over extension:supporting-info is pending further investigation."media": [ { "link": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/alternate-reference", "valueReference": { "reference": "DocumentReference/UKCore-DocumentReference-ECG-Example" } } ], "display": "ECG PDF (DocumentReference via backported extension)" } } ],
conclusionCode
If possible, unstructured reports wrapped within DiagnosticReports, SHOULD contain a conclusionCode element indicating the coded finding from the report, to aid analytics."conclusionCode": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "738542003", "display": "Dihydropyrimidine dehydrogenase poor metabolizer (finding)" } ] } ],
presentedForm
Genomic reports SHALL include a presentedForm element, preferrably pointing to a DocumentReference that contains metadata and the location of the unstructured report. The DocumentReference SHOULD ideally be registered on [NRL](https://digital.nhs.uk/developer/api-catalogue/national-record-locator-fhir/v3/producer#overview--overview), either pointing to a local repository which contains the document, or stored on the National Document Repository, if a local service that can expose documents, is not available.Alternative options for sharing unstructured documents include referencing the location of the PDF report directly (using appropriate authentication) or including the PDF report as a base64 encoded attachment within the message payload.
Note: this guidance may change in the future as work on Structured Reporting matures
"presentedForm": [ { "url": "https://sandbox.api.service.nhs.uk/record-locator/producer/FHIR/R4/DocumentReference/Y05868-1234567892" } ]