INTEROPen CareConnect Base STU3 Implementation Guide - Local Development build (v3.0.0). See the Directory of published versions
StructureDefinition: CareConnect-DiagnosticReport-1
A test report for National Pathology that contains data on the pathology tests performed on patients specimens populated by the performing organisation.
The official URL for this profile is:
https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-DiagnosticReport-1
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from DiagnosticReport
Summary
Mandatory: 1 element (11 nested mandatory elements)
Fixed Value: 3 elements
Structures
This structure refers to these other structures:
- https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Organization-1
- https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-CarePlan-1
- https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Encounter-1
- https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Specimen-1
- https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Observation-1
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
- The element DiagnosticReport.category.coding is sliced based on the value of value:system
- The element DiagnosticReport.code.coding is sliced based on the value of value:system
- The element DiagnosticReport.codedDiagnosis.coding is sliced based on the value of value:system
This structure is derived from DiagnosticReport
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  DiagnosticReport | I | 0..* | DiagnosticReport | A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports |
  id | Σ | 0..1 | id | Logical id of this artifact |
 meta | Σ | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) Max Binding: All Languages | |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
 extension | 0..* | Extension | Additional Content defined by implementations | |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
 identifier | Σ | 0..* | Identifier | Business identifier for report |
 id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
| system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | Σ | 1..1 | string | The value that is unique Example General: 123456 |
| period | Σ | 0..1 | Period | Time period when id is/was valid for use |
  assigner | Σ | 0..1 | Reference(CareConnect-Organization-1) | Organization that issued id (may be just text) |
| basedOn | 0..* | Reference(CareConnect-CarePlan-1 | CareConnect-MedicationRequest-1 | CareConnect-ReferralRequest-1 | CareConnect-ProcedureRequest-1) | What was requested | |
| status | ?!Σ | 1..1 | code | registered | partial | preliminary | final + Binding: DiagnosticReportStatus (required) |
| category | Σ | 0..1 | CodeableConcept | Service category Binding: Diagnostic Service Section Codes (preferred) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
 coding | Σ | 0..* | (Slice Definition) | Code defined by a terminology system Slice: Unordered, Open by value:system |
  coding:snomedCT | Σ | 0..* | Coding | Code defined by a terminology system |
  id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| Extension-coding-sctdescid | 0..* | (Complex) | The SNOMED CT Description ID for the display URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid | |
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | Σ | 1..1 | code | Symbol in syntax defined by the system |
| display | Σ | 1..1 | string | Representation defined by the system |
 userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| text | Σ | 0..1 | string | Plain text representation of the concept |
| code | Σ | 1..1 | CodeableConcept | Name/Code for this diagnostic report Binding: LOINC Diagnostic Report Codes (preferred) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | 0..* | (Slice Definition) | Code defined by a terminology system Slice: Unordered, Open by value:system |
| coding:snomedCT | Σ | 0..* | Coding | Code defined by a terminology system Binding: Care Connect Report Code SnCT (extensible) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| Extension-coding-sctdescid | 0..* | (Complex) | The SNOMED CT Description ID for the display URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid | |
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | Σ | 1..1 | code | Symbol in syntax defined by the system |
| display | Σ | 1..1 | string | Representation defined by the system |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| text | Σ | 0..1 | string | Plain text representation of the concept |
| subject | Σ | 1..1 | Reference(Group | Device | CareConnect-Patient-1 | CareConnect-Location-1) | The subject of the report - usually, but not always, the patient |
| context | Σ | 0..1 | Reference(CareConnect-Encounter-1) | Health care event when test ordered |
 effective[x] | Σ | 0..1 | Clinically relevant time/time-period for report | |
| effectiveDateTime | dateTime | |||
| effectivePeriod | Period | |||
| issued | Σ | 0..1 | instant | DateTime this version was released |
| performer | ΣI | 0..* | BackboneElement | Participants in producing the report |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| role | Σ | 0..1 | CodeableConcept | Type of performer Binding: Procedure Performer Role Codes (example) |
| actor | Σ | 1..1 | Reference(CareConnect-Organization-1 | CareConnect-Practitioner-1) | Practitioner or Organization participant |
| specimen | 0..* | Reference(CareConnect-Specimen-1) | Specimens this report is based on | |
| result | 0..* | Reference(CareConnect-Observation-1) | Observations - simple, or complex nested groups | |
| imagingStudy | 0..* | Reference(ImagingStudy | ImagingManifest) | Reference to full details of imaging associated with the diagnostic report | |
| image | ΣI | 0..* | BackboneElement | Key images associated with this report |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| comment | 0..1 | string | Comment about the image (e.g. explanation) | |
| link | Σ | 1..1 | Reference(Media) | Reference to the image source |
| conclusion | 0..1 | string | Clinical Interpretation of test results | |
| codedDiagnosis | 0..* | CodeableConcept | Codes for the conclusion Binding: Care Connect Finding Code (preferred) | |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | 0..* | (Slice Definition) | Code defined by a terminology system Slice: Unordered, Open by value:system |
| coding:snomedCT | Σ | 0..* | Coding | Code defined by a terminology system Binding: Care Connect Finding Code (extensible) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| Extension-coding-sctdescid | 0..* | (Complex) | The SNOMED CT Description ID for the display URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid | |
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | Σ | 1..1 | code | Symbol in syntax defined by the system |
| display | Σ | 1..1 | string | Representation defined by the system |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| text | Σ | 0..1 | string | Plain text representation of the concept |
| presentedForm | 0..* | Attachment | Entire report as issued | |
| Documentation for this format | ||||
This structure is derived from DiagnosticReport
Summary
Mandatory: 1 element (11 nested mandatory elements)
Fixed Value: 3 elements
Structures
This structure refers to these other structures:
- https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Organization-1
- https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-CarePlan-1
- https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Encounter-1
- https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Specimen-1
- https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Observation-1
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
- The element DiagnosticReport.category.coding is sliced based on the value of value:system
- The element DiagnosticReport.code.coding is sliced based on the value of value:system
- The element DiagnosticReport.codedDiagnosis.coding is sliced based on the value of value:system
Differential View
This structure is derived from DiagnosticReport
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| DiagnosticReport | I | 0..* | DiagnosticReport | A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports |
| id | Σ | 0..1 | id | Logical id of this artifact |
| meta | Σ | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) Max Binding: All Languages | |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | 0..* | Identifier | Business identifier for report |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
| system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | Σ | 1..1 | string | The value that is unique Example General: 123456 |
| period | Σ | 0..1 | Period | Time period when id is/was valid for use |
| assigner | Σ | 0..1 | Reference(CareConnect-Organization-1) | Organization that issued id (may be just text) |
| basedOn | 0..* | Reference(CareConnect-CarePlan-1 | CareConnect-MedicationRequest-1 | CareConnect-ReferralRequest-1 | CareConnect-ProcedureRequest-1) | What was requested | |
| status | ?!Σ | 1..1 | code | registered | partial | preliminary | final + Binding: DiagnosticReportStatus (required) |
| category | Σ | 0..1 | CodeableConcept | Service category Binding: Diagnostic Service Section Codes (preferred) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | 0..* | (Slice Definition) | Code defined by a terminology system Slice: Unordered, Open by value:system |
| coding:snomedCT | Σ | 0..* | Coding | Code defined by a terminology system |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| Extension-coding-sctdescid | 0..* | (Complex) | The SNOMED CT Description ID for the display URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid | |
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | Σ | 1..1 | code | Symbol in syntax defined by the system |
| display | Σ | 1..1 | string | Representation defined by the system |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| text | Σ | 0..1 | string | Plain text representation of the concept |
| code | Σ | 1..1 | CodeableConcept | Name/Code for this diagnostic report Binding: LOINC Diagnostic Report Codes (preferred) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | 0..* | (Slice Definition) | Code defined by a terminology system Slice: Unordered, Open by value:system |
| coding:snomedCT | Σ | 0..* | Coding | Code defined by a terminology system Binding: Care Connect Report Code SnCT (extensible) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| Extension-coding-sctdescid | 0..* | (Complex) | The SNOMED CT Description ID for the display URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid | |
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | Σ | 1..1 | code | Symbol in syntax defined by the system |
| display | Σ | 1..1 | string | Representation defined by the system |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| text | Σ | 0..1 | string | Plain text representation of the concept |
| subject | Σ | 1..1 | Reference(Group | Device | CareConnect-Patient-1 | CareConnect-Location-1) | The subject of the report - usually, but not always, the patient |
| context | Σ | 0..1 | Reference(CareConnect-Encounter-1) | Health care event when test ordered |
| effective[x] | Σ | 0..1 | Clinically relevant time/time-period for report | |
| effectiveDateTime | dateTime | |||
| effectivePeriod | Period | |||
| issued | Σ | 0..1 | instant | DateTime this version was released |
| performer | ΣI | 0..* | BackboneElement | Participants in producing the report |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| role | Σ | 0..1 | CodeableConcept | Type of performer Binding: Procedure Performer Role Codes (example) |
| actor | Σ | 1..1 | Reference(CareConnect-Organization-1 | CareConnect-Practitioner-1) | Practitioner or Organization participant |
| specimen | 0..* | Reference(CareConnect-Specimen-1) | Specimens this report is based on | |
| result | 0..* | Reference(CareConnect-Observation-1) | Observations - simple, or complex nested groups | |
| imagingStudy | 0..* | Reference(ImagingStudy | ImagingManifest) | Reference to full details of imaging associated with the diagnostic report | |
| image | ΣI | 0..* | BackboneElement | Key images associated with this report |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| comment | 0..1 | string | Comment about the image (e.g. explanation) | |
| link | Σ | 1..1 | Reference(Media) | Reference to the image source |
| conclusion | 0..1 | string | Clinical Interpretation of test results | |
| codedDiagnosis | 0..* | CodeableConcept | Codes for the conclusion Binding: Care Connect Finding Code (preferred) | |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | 0..* | (Slice Definition) | Code defined by a terminology system Slice: Unordered, Open by value:system |
| coding:snomedCT | Σ | 0..* | Coding | Code defined by a terminology system Binding: Care Connect Finding Code (extensible) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| Extension-coding-sctdescid | 0..* | (Complex) | The SNOMED CT Description ID for the display URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid | |
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | Σ | 1..1 | code | Symbol in syntax defined by the system |
| display | Σ | 1..1 | string | Representation defined by the system |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| text | Σ | 0..1 | string | Plain text representation of the concept |
| presentedForm | 0..* | Attachment | Entire report as issued | |
| Documentation for this format | ||||
Other representations of profile: Schematron
Terminology Bindings
Terminology Bindings
| Path | Conformance | ValueSet |
| DiagnosticReport.language | extensible | Common Languages Max Binding: All Languages |
| DiagnosticReport.identifier.use | required | IdentifierUse |
| DiagnosticReport.identifier.type | extensible | Identifier Type Codes |
| DiagnosticReport.status | required | DiagnosticReportStatus |
| DiagnosticReport.category | preferred | Diagnostic Service Section Codes |
| DiagnosticReport.code | preferred | LOINC Diagnostic Report Codes |
| DiagnosticReport.code.coding:snomedCT | extensible | Care Connect Report Code SnCT |
| DiagnosticReport.performer.role | example | Procedure Performer Role Codes |
| DiagnosticReport.codedDiagnosis | preferred | Care Connect Finding Code |
| DiagnosticReport.codedDiagnosis.coding:snomedCT | extensible | Care Connect Finding Code |
Constraints
Constraints
| Id | Path | Details | Requirements |
| dom-2 | DiagnosticReport | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-1 | DiagnosticReport | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty() | |
| dom-4 | DiagnosticReport | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-3 | DiagnosticReport | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource : contained.where(('#'+id in %resource.descendants().reference).not()).empty() | |
| ele-1 | DiagnosticReport.performer | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
| ele-1 | DiagnosticReport.image | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) |