diagnostic reports

Create Diagnostic Report

post
/organizations/{organizationId}/fhir/3/DiagnosticReport

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.

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug

Body

resourceType*stringDiagnosticReportThis is a DiagnosticReport resource
identifierarray(Identifier)Identifiers assigned to this report by the performer or other systems.
basedOnarray(Reference)Details concerning a test or procedure requested.
statusstringregistered|partial|preliminary|final|amended|corrected|appended|cancelled|entered-in-error|unknownThe status of the diagnostic report as a whole.
categoryCodeableConceptA 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.
code*CodeableConceptA code or name that describes this diagnostic report.
subjectReferenceThe subject of the report. Usually, but not always, this is a patient. However diagnostic services also perform analyses on specimens collected from a variety of other sources.
contextReferenceThe healthcare event (e.g. a patient and healthcare provider interaction) which this DiagnosticReport per is about.
effectiveDateTimestringThe 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.
effectivePeriodPeriodThe 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.
issuedstringThe date and time that this version of the report was released from the source diagnostic service.
performerarray(DiagnosticReport_Performer)Indicates who or what participated in producing the report.
specimenarray(Reference)Details about the specimens on which this diagnostic report is based.
resultarray(Reference)Observations that are part of this diagnostic report. Observations can be simple name/value pairs (e.g. "atomic" results), or they can be grouping observations that include references to other members of the group (e.g. "panels").
imagingStudyarray(Reference)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.
imagearray(DiagnosticReport_Image)A list of key images associated with this report. The images are generally created during the diagnostic process, and may be directly of the patient, or of treated specimens (i.e. slides of interest).
conclusionstringConcise and clinically contextualized impression / summary of the diagnostic report.
codedDiagnosisarray(CodeableConcept)Codes for the conclusion.
presentedFormarray(Attachment)Rich text representation of the entire result as issued by the diagnostic service. Multiple formats are allowed but they SHALL be semantically equivalent.

Response

Patch Diagnostic Report

patch
/organizations/{organizationId}/fhir/3/DiagnosticReport/{resourceId}

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.

Request

Headers

content-type*stringapplication/json-patch+jsonapplication/json-patch+json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringDiagnosticReportThis is a DiagnosticReport resource
identifierarray(Identifier)Identifiers assigned to this report by the performer or other systems.
basedOnarray(Reference)Details concerning a test or procedure requested.
statusstringregistered|partial|preliminary|final|amended|corrected|appended|cancelled|entered-in-error|unknownThe status of the diagnostic report as a whole.
categoryCodeableConceptA 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.
code*CodeableConceptA code or name that describes this diagnostic report.
subjectReferenceThe subject of the report. Usually, but not always, this is a patient. However diagnostic services also perform analyses on specimens collected from a variety of other sources.
contextReferenceThe healthcare event (e.g. a patient and healthcare provider interaction) which this DiagnosticReport per is about.
effectiveDateTimestringThe 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.
effectivePeriodPeriodThe 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.
issuedstringThe date and time that this version of the report was released from the source diagnostic service.
performerarray(DiagnosticReport_Performer)Indicates who or what participated in producing the report.
specimenarray(Reference)Details about the specimens on which this diagnostic report is based.
resultarray(Reference)Observations that are part of this diagnostic report. Observations can be simple name/value pairs (e.g. "atomic" results), or they can be grouping observations that include references to other members of the group (e.g. "panels").
imagingStudyarray(Reference)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.
imagearray(DiagnosticReport_Image)A list of key images associated with this report. The images are generally created during the diagnostic process, and may be directly of the patient, or of treated specimens (i.e. slides of interest).
conclusionstringConcise and clinically contextualized impression / summary of the diagnostic report.
codedDiagnosisarray(CodeableConcept)Codes for the conclusion.
presentedFormarray(Attachment)Rich text representation of the entire result as issued by the diagnostic service. Multiple formats are allowed but they SHALL be semantically equivalent.

Response

Read Diagnostic Report

get
/organizations/{organizationId}/fhir/3/DiagnosticReport/{resourceId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Read History Diagnostic Report

get
/organizations/{organizationId}/fhir/3/DiagnosticReport/{resourceId}/_history

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug
resourceId*

Response

Read Version Diagnostic Report

get
/organizations/{organizationId}/fhir/3/DiagnosticReport/{resourceId}/_history/{versionId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

Remove Diagnostic Report

delete
/organizations/{organizationId}/fhir/3/DiagnosticReport/{resourceId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Search Get Diagnostic Report

get
/organizations/{organizationId}/fhir/3/DiagnosticReport

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
based-onstring
categorystring
codestring
contextstring
datestring
diagnosisstring
encounterstring
focalAccessstring
identifierstring
imagestring
issuedstring
patientstring
performerstring
resultstring
specimenstring
statusstring
subjectstring

Params

organizationId*string|stringid|slug

Response

Search History Diagnostic Report

get
/organizations/{organizationId}/fhir/3/DiagnosticReport/_history

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug

Response

Search Post Diagnostic Report

post
/organizations/{organizationId}/fhir/3/DiagnosticReport/_search

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.

Request

Headers

content-type*stringapplication/json|application/x-www-form-urlencodedapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
based-onstring
categorystring
codestring
contextstring
datestring
diagnosisstring
encounterstring
focalAccessstring
identifierstring
imagestring
issuedstring
patientstring
performerstring
resultstring
specimenstring
statusstring
subjectstring

Params

organizationId*string|stringid|slug

Body

resourceType*stringDiagnosticReportThis is a DiagnosticReport resource
identifierarray(Identifier)Identifiers assigned to this report by the performer or other systems.
basedOnarray(Reference)Details concerning a test or procedure requested.
statusstringregistered|partial|preliminary|final|amended|corrected|appended|cancelled|entered-in-error|unknownThe status of the diagnostic report as a whole.
categoryCodeableConceptA 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.
code*CodeableConceptA code or name that describes this diagnostic report.
subjectReferenceThe subject of the report. Usually, but not always, this is a patient. However diagnostic services also perform analyses on specimens collected from a variety of other sources.
contextReferenceThe healthcare event (e.g. a patient and healthcare provider interaction) which this DiagnosticReport per is about.
effectiveDateTimestringThe 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.
effectivePeriodPeriodThe 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.
issuedstringThe date and time that this version of the report was released from the source diagnostic service.
performerarray(DiagnosticReport_Performer)Indicates who or what participated in producing the report.
specimenarray(Reference)Details about the specimens on which this diagnostic report is based.
resultarray(Reference)Observations that are part of this diagnostic report. Observations can be simple name/value pairs (e.g. "atomic" results), or they can be grouping observations that include references to other members of the group (e.g. "panels").
imagingStudyarray(Reference)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.
imagearray(DiagnosticReport_Image)A list of key images associated with this report. The images are generally created during the diagnostic process, and may be directly of the patient, or of treated specimens (i.e. slides of interest).
conclusionstringConcise and clinically contextualized impression / summary of the diagnostic report.
codedDiagnosisarray(CodeableConcept)Codes for the conclusion.
presentedFormarray(Attachment)Rich text representation of the entire result as issued by the diagnostic service. Multiple formats are allowed but they SHALL be semantically equivalent.

Response

Update Diagnostic Report

put
/organizations/{organizationId}/fhir/3/DiagnosticReport/{resourceId}

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.

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringDiagnosticReportThis is a DiagnosticReport resource
identifierarray(Identifier)Identifiers assigned to this report by the performer or other systems.
basedOnarray(Reference)Details concerning a test or procedure requested.
statusstringregistered|partial|preliminary|final|amended|corrected|appended|cancelled|entered-in-error|unknownThe status of the diagnostic report as a whole.
categoryCodeableConceptA 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.
code*CodeableConceptA code or name that describes this diagnostic report.
subjectReferenceThe subject of the report. Usually, but not always, this is a patient. However diagnostic services also perform analyses on specimens collected from a variety of other sources.
contextReferenceThe healthcare event (e.g. a patient and healthcare provider interaction) which this DiagnosticReport per is about.
effectiveDateTimestringThe 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.
effectivePeriodPeriodThe 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.
issuedstringThe date and time that this version of the report was released from the source diagnostic service.
performerarray(DiagnosticReport_Performer)Indicates who or what participated in producing the report.
specimenarray(Reference)Details about the specimens on which this diagnostic report is based.
resultarray(Reference)Observations that are part of this diagnostic report. Observations can be simple name/value pairs (e.g. "atomic" results), or they can be grouping observations that include references to other members of the group (e.g. "panels").
imagingStudyarray(Reference)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.
imagearray(DiagnosticReport_Image)A list of key images associated with this report. The images are generally created during the diagnostic process, and may be directly of the patient, or of treated specimens (i.e. slides of interest).
conclusionstringConcise and clinically contextualized impression / summary of the diagnostic report.
codedDiagnosisarray(CodeableConcept)Codes for the conclusion.
presentedFormarray(Attachment)Rich text representation of the entire result as issued by the diagnostic service. Multiple formats are allowed but they SHALL be semantically equivalent.

Response