OpenELIS GLOBAL2 Implementation Guide
0.1.0 - ci-build
OpenELIS GLOBAL2 Implementation Guide
0.1.0 - ci-build
OpenELIS GLOBAL2 Implementation Guide - Local Development build (v0.1.0). See the Directory of published versions
| Official URL: http://i-tech-uw.github.io/openelis-global-ig/StructureDefinition/openelis-diagnostic-report | Version: 0.1.0 | |||
| Active as of 2023-03-05 | Computable Name: OpenELISDiagnosticReport | |||
DiagnosticReport resource created by a LIS
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from DiagnosticReport
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  DiagnosticReport | 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 | |
  Slices for identifier | 1..* | Identifier | Business identifier for report Slice: Unordered, Open by value:system | |
   identifier:uuid | 1..1 | Identifier | Business identifier for report | |
  system | 1..1 | uri | The namespace for the identifier value Required Pattern: http://openelis-global.org/analysisResult_uuid | |
 basedOn | 1..1 | Reference(OpenELIS Service Request) | What was requested | |
| status | 1..1 | code | registered | partial | preliminary | final + Binding: Diagnostic Report Status Valueset (required) | |
| code | ||||
 coding | 1..* | Coding | Code defined by a terminology system | |
| subject | 1..1 | Reference(OpenELIS Patient) | The subject of the report - usually, but not always, the patient | |
| specimen | 1..1 | Reference(OpenElis Specimen) | Specimens this report is based on | |
| result | 1..1 | Reference(OpenELIS Observation) | Observations | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| DiagnosticReport.status | required | OpenElisDiagnosticReportStatusVs |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| DiagnosticReport | 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 |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| Slices for identifier | Σ | 1..* | Identifier | Business identifier for report Slice: Unordered, Open by value:system |
| identifier:uuid | Σ | 1..1 | Identifier | Business identifier for report |
 use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system | Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://openelis-global.org/analysisResult_uuid |
| basedOn | 1..1 | Reference(OpenELIS Service Request) | What was requested | |
| status | ?!Σ | 1..1 | code | registered | partial | preliminary | final + Binding: Diagnostic Report Status Valueset (required) |
 code | Σ | 1..1 | CodeableConcept | Name/Code for this diagnostic report Binding: LOINCDiagnosticReportCodes (preferred): Codes that describe Diagnostic Reports. |
| coding | Σ | 1..* | Coding | Code defined by a terminology system |
| subject | Σ | 1..1 | Reference(OpenELIS Patient) | The subject of the report - usually, but not always, the patient |
| specimen | 1..1 | Reference(OpenElis Specimen) | Specimens this report is based on | |
| result | 1..1 | Reference(OpenELIS Observation) | Observations | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| DiagnosticReport.identifier:uuid.use | required | IdentifierUse |
| DiagnosticReport.status | required | OpenElisDiagnosticReportStatusVs |
| DiagnosticReport.code | preferred | LOINCDiagnosticReportCodes (a valid code from LOINC) |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | DiagnosticReport | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | DiagnosticReport | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | DiagnosticReport | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | DiagnosticReport | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | DiagnosticReport | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| DiagnosticReport | 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: CommonLanguages (preferred): A human language.
| |||||
| text | 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 | ||||
| Slices for identifier | Σ | 1..* | Identifier | Business identifier for report Slice: Unordered, Open by value:system | ||||
| identifier:uuid | Σ | 1..1 | Identifier | Business identifier for report | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system | Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://openelis-global.org/analysisResult_uuid | ||||
| value | Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| basedOn | 1..1 | Reference(OpenELIS Service Request) | What was requested | |||||
| status | ?!Σ | 1..1 | code | registered | partial | preliminary | final + Binding: Diagnostic Report Status Valueset (required) | ||||
| category | Σ | 0..* | CodeableConcept | Service category Binding: DiagnosticServiceSectionCodes (example): Codes for diagnostic service sections. | ||||
| code | Σ | 1..1 | CodeableConcept | Name/Code for this diagnostic report Binding: LOINCDiagnosticReportCodes (preferred): Codes that describe Diagnostic Reports. | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding | Σ | 1..* | Coding | Code defined by a terminology system | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept | ||||
| subject | Σ | 1..1 | Reference(OpenELIS Patient) | The subject of the report - usually, but not always, the patient | ||||
| encounter | Σ | 0..1 | Reference(Encounter) | 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 made | ||||
| performer | Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam) | Responsible Diagnostic Service | ||||
| resultsInterpreter | Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam) | Primary result interpreter | ||||
| specimen | 1..1 | Reference(OpenElis Specimen) | Specimens this report is based on | |||||
| result | 1..1 | Reference(OpenELIS Observation) | Observations | |||||
| imagingStudy | 0..* | Reference(ImagingStudy) | Reference to full details of imaging associated with the diagnostic report | |||||
| media | Σ | 0..* | BackboneElement | Key images associated with this report | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| comment | 0..1 | string | Comment about the image (e.g. explanation) | |||||
| link | Σ | 1..1 | Reference(Media) | Reference to the image source | ||||
| conclusion | 0..1 | string | Clinical conclusion (interpretation) of test results | |||||
| conclusionCode | 0..* | CodeableConcept | Codes for the clinical conclusion of test results Binding: SNOMEDCTClinicalFindings (example): Diagnosis codes provided as adjuncts to the report. | |||||
| presentedForm | 0..* | Attachment | Entire report as issued | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| DiagnosticReport.language | preferred | CommonLanguages
| ||||
| DiagnosticReport.identifier:uuid.use | required | IdentifierUse | ||||
| DiagnosticReport.identifier:uuid.type | extensible | Identifier Type Codes | ||||
| DiagnosticReport.status | required | OpenElisDiagnosticReportStatusVs | ||||
| DiagnosticReport.category | example | DiagnosticServiceSectionCodes | ||||
| DiagnosticReport.code | preferred | LOINCDiagnosticReportCodes (a valid code from LOINC) | ||||
| DiagnosticReport.conclusionCode | example | SNOMEDCTClinicalFindings |
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from DiagnosticReport
Summary
Mandatory: 8 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from DiagnosticReport
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| DiagnosticReport | 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 | |
| Slices for identifier | 1..* | Identifier | Business identifier for report Slice: Unordered, Open by value:system | |
| identifier:uuid | 1..1 | Identifier | Business identifier for report | |
| system | 1..1 | uri | The namespace for the identifier value Required Pattern: http://openelis-global.org/analysisResult_uuid | |
| basedOn | 1..1 | Reference(OpenELIS Service Request) | What was requested | |
| status | 1..1 | code | registered | partial | preliminary | final + Binding: Diagnostic Report Status Valueset (required) | |
| code | ||||
| coding | 1..* | Coding | Code defined by a terminology system | |
| subject | 1..1 | Reference(OpenELIS Patient) | The subject of the report - usually, but not always, the patient | |
| specimen | 1..1 | Reference(OpenElis Specimen) | Specimens this report is based on | |
| result | 1..1 | Reference(OpenELIS Observation) | Observations | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| DiagnosticReport.status | required | OpenElisDiagnosticReportStatusVs |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| DiagnosticReport | 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 |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| Slices for identifier | Σ | 1..* | Identifier | Business identifier for report Slice: Unordered, Open by value:system |
| identifier:uuid | Σ | 1..1 | Identifier | Business identifier for report |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system | Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://openelis-global.org/analysisResult_uuid |
| basedOn | 1..1 | Reference(OpenELIS Service Request) | What was requested | |
| status | ?!Σ | 1..1 | code | registered | partial | preliminary | final + Binding: Diagnostic Report Status Valueset (required) |
| code | Σ | 1..1 | CodeableConcept | Name/Code for this diagnostic report Binding: LOINCDiagnosticReportCodes (preferred): Codes that describe Diagnostic Reports. |
| coding | Σ | 1..* | Coding | Code defined by a terminology system |
| subject | Σ | 1..1 | Reference(OpenELIS Patient) | The subject of the report - usually, but not always, the patient |
| specimen | 1..1 | Reference(OpenElis Specimen) | Specimens this report is based on | |
| result | 1..1 | Reference(OpenELIS Observation) | Observations | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| DiagnosticReport.identifier:uuid.use | required | IdentifierUse |
| DiagnosticReport.status | required | OpenElisDiagnosticReportStatusVs |
| DiagnosticReport.code | preferred | LOINCDiagnosticReportCodes (a valid code from LOINC) |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | DiagnosticReport | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | DiagnosticReport | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | DiagnosticReport | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | DiagnosticReport | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | DiagnosticReport | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| DiagnosticReport | 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: CommonLanguages (preferred): A human language.
| |||||
| text | 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 | ||||
| Slices for identifier | Σ | 1..* | Identifier | Business identifier for report Slice: Unordered, Open by value:system | ||||
| identifier:uuid | Σ | 1..1 | Identifier | Business identifier for report | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system | Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://openelis-global.org/analysisResult_uuid | ||||
| value | Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| basedOn | 1..1 | Reference(OpenELIS Service Request) | What was requested | |||||
| status | ?!Σ | 1..1 | code | registered | partial | preliminary | final + Binding: Diagnostic Report Status Valueset (required) | ||||
| category | Σ | 0..* | CodeableConcept | Service category Binding: DiagnosticServiceSectionCodes (example): Codes for diagnostic service sections. | ||||
| code | Σ | 1..1 | CodeableConcept | Name/Code for this diagnostic report Binding: LOINCDiagnosticReportCodes (preferred): Codes that describe Diagnostic Reports. | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding | Σ | 1..* | Coding | Code defined by a terminology system | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept | ||||
| subject | Σ | 1..1 | Reference(OpenELIS Patient) | The subject of the report - usually, but not always, the patient | ||||
| encounter | Σ | 0..1 | Reference(Encounter) | 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 made | ||||
| performer | Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam) | Responsible Diagnostic Service | ||||
| resultsInterpreter | Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam) | Primary result interpreter | ||||
| specimen | 1..1 | Reference(OpenElis Specimen) | Specimens this report is based on | |||||
| result | 1..1 | Reference(OpenELIS Observation) | Observations | |||||
| imagingStudy | 0..* | Reference(ImagingStudy) | Reference to full details of imaging associated with the diagnostic report | |||||
| media | Σ | 0..* | BackboneElement | Key images associated with this report | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| comment | 0..1 | string | Comment about the image (e.g. explanation) | |||||
| link | Σ | 1..1 | Reference(Media) | Reference to the image source | ||||
| conclusion | 0..1 | string | Clinical conclusion (interpretation) of test results | |||||
| conclusionCode | 0..* | CodeableConcept | Codes for the clinical conclusion of test results Binding: SNOMEDCTClinicalFindings (example): Diagnosis codes provided as adjuncts to the report. | |||||
| presentedForm | 0..* | Attachment | Entire report as issued | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| DiagnosticReport.language | preferred | CommonLanguages
| ||||
| DiagnosticReport.identifier:uuid.use | required | IdentifierUse | ||||
| DiagnosticReport.identifier:uuid.type | extensible | Identifier Type Codes | ||||
| DiagnosticReport.status | required | OpenElisDiagnosticReportStatusVs | ||||
| DiagnosticReport.category | example | DiagnosticServiceSectionCodes | ||||
| DiagnosticReport.code | preferred | LOINCDiagnosticReportCodes (a valid code from LOINC) | ||||
| DiagnosticReport.conclusionCode | example | SNOMEDCTClinicalFindings |
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from DiagnosticReport
Summary
Mandatory: 8 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron
IG © 2021+ . Package openelis#0.1.0 based on FHIR 4.0.1. Generated 2023-03-05
Links: Table of Contents |
QA Report |
Version History |
|