Implementation Guide
23.1.0 - R4 APIs
Publish Box goes here
Official URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-diagnosticreport-profile | Version: 23.1.0 | |||
Active as of 2022-03-01 | Computable Name: AthenaDiagnosticReport |
athena diagnosticreport profile
This DiagnosticReport profile is part of the set of resource profiles supported by the API Server used with the athenaPractice and athenaFlow products. It further describes read, search capabilities of these products.
This resource captures findings and interpretation of diagnostic tests performed on patients, groups of patients, devices, and locations, and/or specimens derived from these.
This profile is used to define the content that will be returned by the API Server in response to requests to access DiagnosticReport resources. All elements listed in the differential profile view are Supported, which means that the API Server is capable of supplying these fields from the product database when they have been populated via the product or its APIs.
The profile also defines the content that must be supplied to the API Server in response to requests to populate DiagnosticReport resources. Fields which are marked as Mandatory in this profile are those that must be supplied to the API Server in content used to populate a resource.
The DiagnosticReport resource is derived from the DOCUMENT and other related tables in athenaPractice and athenaFlow. Specific detail can be found in the Mappings tab in the profile detail page.
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 | S | 0..1 | id | Logical id of this artifact |
meta | 0..1 | Meta | Metadata about the resource | |
lastUpdated | 0..1 | instant | When the resource version last changed | |
Slices for profile | 2..* | canonical() | Profiles this resource claims to conform to Slice: Unordered, Open by value:uri | |
profile:us-core-diagnosticreport | 0..1 | canonical() | Profiles this resource claims to conform to | |
profile:us-core-diagnosticreport | 0..1 | canonical() | Profiles this resource claims to conform to | |
profile:athena-diagnosticreport-profile | 1..1 | canonical() | Profiles this resource claims to conform to Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-diagnosticreport-profile | |
Slices for security | 0..* | Coding | Security Labels applied to this resource Slice: Unordered, Open by value:coding | |
security:SENSITIVECHART | 0..1 | Coding | Security Labels applied to this resource | |
security:CONFABBR | 0..1 | Coding | Security Labels applied to this resource | |
system | 1..1 | uri | Identity of the terminology system | |
code | 1..1 | code | Symbol in syntax defined by the system | |
tag | 0..* | Coding | Tags applied to this resource | |
basedOn | 0..* | Reference(ServiceRequest) | What was requested | |
status | S | 1..1 | code | registered | partial | preliminary | final + |
category | S | 1..* | CodeableConcept | Service category |
code | S | 1..1 | CodeableConcept | Name/Code for this diagnostic report |
Slices for coding | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:codingType | |
coding:other | 0..* | Coding | Code defined by a terminology system | |
coding:lab | 0..* | Coding | Code defined by a terminology system | |
text | 0..1 | string | Plain text representation of the concept | |
subject | S | 1..1 | Reference(Patient) | The subject of the report - usually, but not always, the patient |
encounter | S | 0..1 | Reference(Encounter) | Health care event when test ordered |
effective[x] | S | 1..1 | Period | Clinically relevant time/time-period for report |
issued | S | 1..1 | instant | DateTime this version was made |
performer | S | 0..* | Reference(Practitioner) | Responsible Diagnostic Service |
result | S | 0..* | Reference(Observation) | Observations |
Slices for presentedForm | S | 0..2 | Attachment | Entire report as issued Slice: Unordered, Open by value:contentType |
presentedForm:InternalAttachment | 0..1 | Attachment | Entire report as issued | |
presentedForm:InternalAttachment2 | 0..1 | Attachment | Entire report as issued | |
Documentation for this format |
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 | SΣ | 0..1 | id | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
lastUpdated | Σ | 0..1 | instant | When the resource version last changed |
Slices for profile | Σ | 2..* | canonical() | Profiles this resource claims to conform to Slice: Unordered, Open by value:uri |
profile:us-core-diagnosticreport | Σ | 0..1 | canonical() | Profiles this resource claims to conform to |
profile:us-core-diagnosticreport | Σ | 0..1 | canonical() | Profiles this resource claims to conform to |
profile:athena-diagnosticreport-profile | Σ | 1..1 | canonical() | Profiles this resource claims to conform to Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-diagnosticreport-profile |
Slices for security | Σ | 0..* | Coding | Security Labels applied to this resource Slice: Unordered, Open by value:coding Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
security:SENSITIVECHART | Σ | 0..1 | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
security:CONFABBR | Σ | 0..1 | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
system | Σ | 1..1 | uri | Identity of the terminology system |
code | Σ | 1..1 | code | Symbol in syntax defined by the system |
tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
basedOn | 0..* | Reference(ServiceRequest) | What was requested | |
status | ?!SΣ | 1..1 | code | registered | partial | preliminary | final + Binding: DiagnosticReportStatus (required): The status of the diagnostic report. |
category | SΣ | 1..* | CodeableConcept | Service category Binding: DiagnosticServiceSectionCodes (example): Codes for diagnostic service sections. |
code | SΣ | 1..1 | CodeableConcept | Name/Code for this diagnostic report Binding: LOINCDiagnosticReportCodes (preferred): Codes that describe Diagnostic Reports. |
Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:codingType |
coding:other | Σ | 0..* | Coding | Code defined by a terminology system |
coding:lab | Σ | 0..* | Coding | Code defined by a terminology system |
text | Σ | 0..1 | string | Plain text representation of the concept |
subject | SΣ | 1..1 | Reference(Patient) | The subject of the report - usually, but not always, the patient |
encounter | SΣ | 0..1 | Reference(Encounter) | Health care event when test ordered |
effective[x] | SΣ | 1..1 | Period | Clinically relevant time/time-period for report |
issued | SΣ | 1..1 | instant | DateTime this version was made |
performer | SΣ | 0..* | Reference(Practitioner) | Responsible Diagnostic Service |
result | S | 0..* | Reference(Observation) | Observations |
Slices for presentedForm | S | 0..2 | Attachment | Entire report as issued Slice: Unordered, Open by value:contentType |
presentedForm:InternalAttachment | 0..1 | Attachment | Entire report as issued | |
presentedForm:InternalAttachment2 | 0..1 | Attachment | Entire report as issued | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
DiagnosticReport.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | |
DiagnosticReport.meta.security:SENSITIVECHART | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | |
DiagnosticReport.meta.security:CONFABBR | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | |
DiagnosticReport.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | |
DiagnosticReport.status | required | DiagnosticReportStatushttp://hl7.org/fhir/ValueSet/diagnostic-report-status|4.0.1 from the FHIR Standard | |
DiagnosticReport.category | example | DiagnosticServiceSectionCodeshttp://hl7.org/fhir/ValueSet/diagnostic-service-sections from the FHIR Standard | |
DiagnosticReport.code | preferred | LOINCDiagnosticReportCodes (a valid code from LOINC)http://hl7.org/fhir/ValueSet/report-codes from the FHIR Standard |
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 | SΣ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
versionId | Σ | 0..1 | id | Version specific identifier | ||||
lastUpdated | Σ | 0..1 | instant | When the resource version last changed | ||||
source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
Slices for profile | Σ | 2..* | canonical() | Profiles this resource claims to conform to Slice: Unordered, Open by value:uri | ||||
profile:us-core-diagnosticreport | Σ | 0..1 | canonical() | Profiles this resource claims to conform to | ||||
profile:us-core-diagnosticreport | Σ | 0..1 | canonical() | Profiles this resource claims to conform to | ||||
profile:athena-diagnosticreport-profile | Σ | 1..1 | canonical() | Profiles this resource claims to conform to Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-diagnosticreport-profile | ||||
Slices for security | Σ | 0..* | Coding | Security Labels applied to this resource Slice: Unordered, Open by value:coding Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
security:SENSITIVECHART | Σ | 0..1 | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
security:CONFABBR | Σ | 0..1 | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
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 | ||||
identifier | Σ | 0..* | Identifier | Business identifier for report | ||||
basedOn | 0..* | Reference(ServiceRequest) | What was requested | |||||
status | ?!SΣ | 1..1 | code | registered | partial | preliminary | final + Binding: DiagnosticReportStatus (required): The status of the diagnostic report. | ||||
category | SΣ | 1..* | CodeableConcept | Service category Binding: DiagnosticServiceSectionCodes (example): Codes for diagnostic service sections. | ||||
code | SΣ | 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 | |||||
Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:codingType | ||||
coding:other | Σ | 0..* | Coding | Code defined by a terminology system | ||||
coding:lab | Σ | 0..* | Coding | Code defined by a terminology system | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
subject | SΣ | 1..1 | Reference(Patient) | The subject of the report - usually, but not always, the patient | ||||
encounter | SΣ | 0..1 | Reference(Encounter) | Health care event when test ordered | ||||
effective[x] | SΣ | 1..1 | Period | Clinically relevant time/time-period for report | ||||
issued | SΣ | 1..1 | instant | DateTime this version was made | ||||
performer | SΣ | 0..* | Reference(Practitioner) | Responsible Diagnostic Service | ||||
resultsInterpreter | Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam) | Primary result interpreter | ||||
specimen | 0..* | Reference(Specimen) | Specimens this report is based on | |||||
result | S | 0..* | Reference(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. | |||||
Slices for presentedForm | S | 0..2 | Attachment | Entire report as issued Slice: Unordered, Open by value:contentType | ||||
presentedForm:InternalAttachment | 0..1 | Attachment | Entire report as issued | |||||
presentedForm:InternalAttachment2 | 0..1 | Attachment | Entire report as issued | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
DiagnosticReport.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
DiagnosticReport.meta.security:SENSITIVECHART | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
DiagnosticReport.meta.security:CONFABBR | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
DiagnosticReport.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
DiagnosticReport.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
DiagnosticReport.status | required | DiagnosticReportStatushttp://hl7.org/fhir/ValueSet/diagnostic-report-status|4.0.1 from the FHIR Standard | ||||
DiagnosticReport.category | example | DiagnosticServiceSectionCodeshttp://hl7.org/fhir/ValueSet/diagnostic-service-sections from the FHIR Standard | ||||
DiagnosticReport.code | preferred | LOINCDiagnosticReportCodes (a valid code from LOINC)http://hl7.org/fhir/ValueSet/report-codes from the FHIR Standard | ||||
DiagnosticReport.conclusionCode | example | SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findings from the FHIR Standard |
This structure is derived from DiagnosticReport
Summary
Mandatory: 6 elements(3 nested mandatory elements)
Must-Support: 11 elements
Fixed: 1 element
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 | S | 0..1 | id | Logical id of this artifact |
meta | 0..1 | Meta | Metadata about the resource | |
lastUpdated | 0..1 | instant | When the resource version last changed | |
Slices for profile | 2..* | canonical() | Profiles this resource claims to conform to Slice: Unordered, Open by value:uri | |
profile:us-core-diagnosticreport | 0..1 | canonical() | Profiles this resource claims to conform to | |
profile:us-core-diagnosticreport | 0..1 | canonical() | Profiles this resource claims to conform to | |
profile:athena-diagnosticreport-profile | 1..1 | canonical() | Profiles this resource claims to conform to Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-diagnosticreport-profile | |
Slices for security | 0..* | Coding | Security Labels applied to this resource Slice: Unordered, Open by value:coding | |
security:SENSITIVECHART | 0..1 | Coding | Security Labels applied to this resource | |
security:CONFABBR | 0..1 | Coding | Security Labels applied to this resource | |
system | 1..1 | uri | Identity of the terminology system | |
code | 1..1 | code | Symbol in syntax defined by the system | |
tag | 0..* | Coding | Tags applied to this resource | |
basedOn | 0..* | Reference(ServiceRequest) | What was requested | |
status | S | 1..1 | code | registered | partial | preliminary | final + |
category | S | 1..* | CodeableConcept | Service category |
code | S | 1..1 | CodeableConcept | Name/Code for this diagnostic report |
Slices for coding | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:codingType | |
coding:other | 0..* | Coding | Code defined by a terminology system | |
coding:lab | 0..* | Coding | Code defined by a terminology system | |
text | 0..1 | string | Plain text representation of the concept | |
subject | S | 1..1 | Reference(Patient) | The subject of the report - usually, but not always, the patient |
encounter | S | 0..1 | Reference(Encounter) | Health care event when test ordered |
effective[x] | S | 1..1 | Period | Clinically relevant time/time-period for report |
issued | S | 1..1 | instant | DateTime this version was made |
performer | S | 0..* | Reference(Practitioner) | Responsible Diagnostic Service |
result | S | 0..* | Reference(Observation) | Observations |
Slices for presentedForm | S | 0..2 | Attachment | Entire report as issued Slice: Unordered, Open by value:contentType |
presentedForm:InternalAttachment | 0..1 | Attachment | Entire report as issued | |
presentedForm:InternalAttachment2 | 0..1 | Attachment | Entire report as issued | |
Documentation for this format |
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 | SΣ | 0..1 | id | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
lastUpdated | Σ | 0..1 | instant | When the resource version last changed |
Slices for profile | Σ | 2..* | canonical() | Profiles this resource claims to conform to Slice: Unordered, Open by value:uri |
profile:us-core-diagnosticreport | Σ | 0..1 | canonical() | Profiles this resource claims to conform to |
profile:us-core-diagnosticreport | Σ | 0..1 | canonical() | Profiles this resource claims to conform to |
profile:athena-diagnosticreport-profile | Σ | 1..1 | canonical() | Profiles this resource claims to conform to Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-diagnosticreport-profile |
Slices for security | Σ | 0..* | Coding | Security Labels applied to this resource Slice: Unordered, Open by value:coding Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
security:SENSITIVECHART | Σ | 0..1 | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
security:CONFABBR | Σ | 0..1 | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
system | Σ | 1..1 | uri | Identity of the terminology system |
code | Σ | 1..1 | code | Symbol in syntax defined by the system |
tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
basedOn | 0..* | Reference(ServiceRequest) | What was requested | |
status | ?!SΣ | 1..1 | code | registered | partial | preliminary | final + Binding: DiagnosticReportStatus (required): The status of the diagnostic report. |
category | SΣ | 1..* | CodeableConcept | Service category Binding: DiagnosticServiceSectionCodes (example): Codes for diagnostic service sections. |
code | SΣ | 1..1 | CodeableConcept | Name/Code for this diagnostic report Binding: LOINCDiagnosticReportCodes (preferred): Codes that describe Diagnostic Reports. |
Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:codingType |
coding:other | Σ | 0..* | Coding | Code defined by a terminology system |
coding:lab | Σ | 0..* | Coding | Code defined by a terminology system |
text | Σ | 0..1 | string | Plain text representation of the concept |
subject | SΣ | 1..1 | Reference(Patient) | The subject of the report - usually, but not always, the patient |
encounter | SΣ | 0..1 | Reference(Encounter) | Health care event when test ordered |
effective[x] | SΣ | 1..1 | Period | Clinically relevant time/time-period for report |
issued | SΣ | 1..1 | instant | DateTime this version was made |
performer | SΣ | 0..* | Reference(Practitioner) | Responsible Diagnostic Service |
result | S | 0..* | Reference(Observation) | Observations |
Slices for presentedForm | S | 0..2 | Attachment | Entire report as issued Slice: Unordered, Open by value:contentType |
presentedForm:InternalAttachment | 0..1 | Attachment | Entire report as issued | |
presentedForm:InternalAttachment2 | 0..1 | Attachment | Entire report as issued | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
DiagnosticReport.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | |
DiagnosticReport.meta.security:SENSITIVECHART | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | |
DiagnosticReport.meta.security:CONFABBR | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | |
DiagnosticReport.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | |
DiagnosticReport.status | required | DiagnosticReportStatushttp://hl7.org/fhir/ValueSet/diagnostic-report-status|4.0.1 from the FHIR Standard | |
DiagnosticReport.category | example | DiagnosticServiceSectionCodeshttp://hl7.org/fhir/ValueSet/diagnostic-service-sections from the FHIR Standard | |
DiagnosticReport.code | preferred | LOINCDiagnosticReportCodes (a valid code from LOINC)http://hl7.org/fhir/ValueSet/report-codes from the FHIR Standard |
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 | SΣ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
versionId | Σ | 0..1 | id | Version specific identifier | ||||
lastUpdated | Σ | 0..1 | instant | When the resource version last changed | ||||
source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
Slices for profile | Σ | 2..* | canonical() | Profiles this resource claims to conform to Slice: Unordered, Open by value:uri | ||||
profile:us-core-diagnosticreport | Σ | 0..1 | canonical() | Profiles this resource claims to conform to | ||||
profile:us-core-diagnosticreport | Σ | 0..1 | canonical() | Profiles this resource claims to conform to | ||||
profile:athena-diagnosticreport-profile | Σ | 1..1 | canonical() | Profiles this resource claims to conform to Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-diagnosticreport-profile | ||||
Slices for security | Σ | 0..* | Coding | Security Labels applied to this resource Slice: Unordered, Open by value:coding Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
security:SENSITIVECHART | Σ | 0..1 | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
security:CONFABBR | Σ | 0..1 | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
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 | ||||
identifier | Σ | 0..* | Identifier | Business identifier for report | ||||
basedOn | 0..* | Reference(ServiceRequest) | What was requested | |||||
status | ?!SΣ | 1..1 | code | registered | partial | preliminary | final + Binding: DiagnosticReportStatus (required): The status of the diagnostic report. | ||||
category | SΣ | 1..* | CodeableConcept | Service category Binding: DiagnosticServiceSectionCodes (example): Codes for diagnostic service sections. | ||||
code | SΣ | 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 | |||||
Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:codingType | ||||
coding:other | Σ | 0..* | Coding | Code defined by a terminology system | ||||
coding:lab | Σ | 0..* | Coding | Code defined by a terminology system | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
subject | SΣ | 1..1 | Reference(Patient) | The subject of the report - usually, but not always, the patient | ||||
encounter | SΣ | 0..1 | Reference(Encounter) | Health care event when test ordered | ||||
effective[x] | SΣ | 1..1 | Period | Clinically relevant time/time-period for report | ||||
issued | SΣ | 1..1 | instant | DateTime this version was made | ||||
performer | SΣ | 0..* | Reference(Practitioner) | Responsible Diagnostic Service | ||||
resultsInterpreter | Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam) | Primary result interpreter | ||||
specimen | 0..* | Reference(Specimen) | Specimens this report is based on | |||||
result | S | 0..* | Reference(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. | |||||
Slices for presentedForm | S | 0..2 | Attachment | Entire report as issued Slice: Unordered, Open by value:contentType | ||||
presentedForm:InternalAttachment | 0..1 | Attachment | Entire report as issued | |||||
presentedForm:InternalAttachment2 | 0..1 | Attachment | Entire report as issued | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
DiagnosticReport.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
DiagnosticReport.meta.security:SENSITIVECHART | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
DiagnosticReport.meta.security:CONFABBR | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
DiagnosticReport.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
DiagnosticReport.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
DiagnosticReport.status | required | DiagnosticReportStatushttp://hl7.org/fhir/ValueSet/diagnostic-report-status|4.0.1 from the FHIR Standard | ||||
DiagnosticReport.category | example | DiagnosticServiceSectionCodeshttp://hl7.org/fhir/ValueSet/diagnostic-service-sections from the FHIR Standard | ||||
DiagnosticReport.code | preferred | LOINCDiagnosticReportCodes (a valid code from LOINC)http://hl7.org/fhir/ValueSet/report-codes from the FHIR Standard | ||||
DiagnosticReport.conclusionCode | example | SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findings from the FHIR Standard |
This structure is derived from DiagnosticReport
Summary
Mandatory: 6 elements(3 nested mandatory elements)
Must-Support: 11 elements
Fixed: 1 element
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron
Interactions supported by this resource are listed below.
Search parameters are executed as specified in the HL7 FHIR RESTful API implementation definition. To search for DiagnosticReport resources, an application shall perform an HTTP GET, specifying the query parameters associated with the resource.
GET [base]/fhir/r4/DiagnosticReport?{search-parameters}{&_count=[max-results]&_format=[json|xml]&_summary=[true|text|data]}
Where:
Name | Description |
---|---|
[base] | Specifies the base URL of the FHIR Server, e.g., https://apsandbox.fhirapi.athenahealth.com/demoAPIServer |
[_count] | Specifies the maximum number of search results to return in a single query. Note: The count of results does not limit the number of additional resources returned via the _include parameter. No more than max-results DiagnosticReport resources which match the search criteria will be returned. The API Server has default and maximum limits for the value that can be specified for this parameter. These limits may vary depending upon the client application vendors participation level in the Athenahealth Partner program. Note: The API Server support the HL7 FHIR Paging capability. |
[_format] | Specifies the format of the output and may be xml or json. When present, the _format value overrides the value of the Accept header in the request. |
[_summary] | Filters the output to include only narrative elements (_summary=text), summary elements (_summary=true) or to omit the generated narrative (_summary=data). Note: If the generated html narrative for the resource is not going to be used by the call, using _summary=data provides improved API response times, especially when returning larger result sets. |
_id (token) | The ID of the resource |
_security (token) | Search by a security label |
_tag (token) | Search by a resource tag |
_lastUpdated (date) | |
_lastUpdated-fromnow (quantity) | Like _lastUpdated except expressed as a positive or negative offset from the current time in units of time, e.g. _lastUpdated-fromnow=ge7||d for more than seven days in the future or =le-2||mo for less than two months in the past. The unit must be specified. |
based-on (reference) | Reference to the service request. |
category (token) | Which diagnostic discipline/department created the report |
code (token) | The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result |
date (date) | The clinically relevant time of the report |
date-fromnow (quantity) | Like date except expressed as a positive or negative offset from the current time in units of time, e.g. occurrence-fromnow=ge7||d for more than seven days in the future or =le-2||mo for less than two months in the past. The unit must be specified. |
encounter (reference) | The Encounter when the order was made |
issued (date) | When the report was issued |
patient (reference) | The subject of the report if a patient |
performer (reference) | Who is responsible for the report |
result (reference) | Link to an atomic result (observation resource) |
status (token) | The status of the report |
subject (reference) | The subject of the report |
The following HTTP response codes are returned by this API call:
200 OK | The query was performed and any results found are contained within the body of the HTTP response. Note: The search API will return 200 OK when the query itself is successful, regardless of whether or not any matching results were found. |
401 Unauthorized | Authorization is required for this request, and either the Authorization header is missing or the supplied user credentials in the Authorization header are not valid or have expired. The body of the HTTP response will contain an OperationOutcome resource that indicates that Authorization is required. |
500 Server Error | The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error. |