Jump to

• Request
• Response

Get a list of diagnostic reports

get

/DiagnosticReport

Note: The FHIR API endpoints described below are available for customers to deploy and use. Developers are welcome and encouraged to develop against the specifications in anticipation of customer deployment.

Retrieves a list of diagnostic reports that meet the supplied query parameters.

• Provide _id or patient.
• Use _id only by itself or with _revinclude.

Request

Query Parameters

• _count: integer
  Minimum Value: 1

  Maximum Value: 128

  The maximum number of results per page.

  Default Value: 50
• _id: string
  The logical resource ID.
• _lastUpdated: array[string]
  Maximum Number of Items: 2

  The last updated date or range.
• _revinclude: string
  The inclusion of related Provenance resources.

  Allowed Values: [ "Provenance:target" ]
• category: array[string]
  The diagnostic report category token.
• code: array[string]
  The diagnostic report code token.
• date: array[string]
  Maximum Number of Items: 2

  The report date or range.
• encounter: string
  The encounter reference or ID.
• patient: string
  The patient reference or ID.

Header Parameters

• accept(required): string

  The media type to be requested.

  Example: application/fhir+json

• authorization(required): string
  The OAuth 2.0 Bearer token used to authenticate the request.

There's no request body for this operation.

Back to Top

Response

200 Response

The successful search response.

Body ()

Root Schema : schema

Type: object

Show Source

• entry: array entry
• id(required): string
• link: array link
• resourceType(required): string
  Allowed Values: [ "Bundle" ]
• type(required): string

{
    "type":"object",
    "required":[
        "resourceType",
        "id",
        "type"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "Bundle"
            ]
        },
        "id":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "link":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/BundleLink"
            }
        },
        "entry":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/BundleEntryForDiagnosticReport"
            }
        }
    }
}

Nested Schema : entry

Type: array

Show Source

• Array of: object BundleEntryForDiagnosticReport

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/BundleEntryForDiagnosticReport"
    }
}

Nested Schema : link

Type: array

Show Source

• Array of: object BundleLink

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/BundleLink"
    }
}

Nested Schema : BundleEntryForDiagnosticReport

Type: object

Show Source

• fullUrl: string
• resource: resource
• search: object BundleEntrySearch

{
    "type":"object",
    "properties":{
        "fullUrl":{
            "type":"string"
        },
        "resource":{
            "oneOf":[
                {
                    "$ref":"#/components/schemas/DiagnosticReport"
                },
                {
                    "$ref":"#/components/schemas/ProvenanceForDiagnosticReport"
                },
                {
                    "$ref":"#/components/schemas/OperationOutcome"
                }
            ]
        },
        "search":{
            "$ref":"#/components/schemas/BundleEntrySearch"
        }
    }
}

Nested Schema : resource

Match One Schema

Show Source

• object DiagnosticReport
  The FHIR R4 DiagnosticReport resource.
• object ProvenanceForDiagnosticReport
  Additional Properties Allowed: true
• object OperationOutcome
  The FHIR OperationOutcome.

{
    "oneOf":[
        {
            "$ref":"#/components/schemas/DiagnosticReport"
        },
        {
            "$ref":"#/components/schemas/ProvenanceForDiagnosticReport"
        },
        {
            "$ref":"#/components/schemas/OperationOutcome"
        }
    ]
}

Nested Schema : BundleEntrySearch

Type: object

Show Source

• mode: string

{
    "type":"object",
    "properties":{
        "mode":{
            "type":"string"
        }
    }
}

Nested Schema : DiagnosticReport

Type: object

The FHIR R4 DiagnosticReport resource.

Show Source

• _effectiveDateTime: object PrimitiveElementForDiagnosticReport
• _issued: object PrimitiveElementForDiagnosticReport
• basedOn: array basedOn
• category(required): array category
• code(required): object CodeableConceptForDiagnosticReport
• conclusionCode: array conclusionCode
• effectiveDateTime: string (date-time)
• effectivePeriod: object Period
• encounter: object ReferenceForDiagnosticReport
• id(required): string
• identifier: array identifier
• issued: string (date-time)
• media: array media
• meta: object meta
• performer: array performer
• presentedForm: array presentedForm
• resourceType(required): string
  Allowed Values: [ "DiagnosticReport" ]
• result: array result
• resultsInterpreter: array resultsInterpreter
• specimen: array specimen
• status(required): string
• subject(required): object ReferenceForDiagnosticReport
• text: object Narrative

{
    "type":"object",
    "description":"The FHIR R4 DiagnosticReport resource.",
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "DiagnosticReport"
            ]
        },
        "id":{
            "type":"string"
        },
        "meta":{
            "type":"object",
            "properties":{
                "versionId":{
                    "type":"string"
                },
                "lastUpdated":{
                    "type":"string",
                    "format":"date-time"
                },
                "security":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/Coding"
                    }
                }
            }
        },
        "text":{
            "$ref":"#/components/schemas/Narrative"
        },
        "identifier":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/IdentifierForDiagnosticReport"
            }
        },
        "basedOn":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ReferenceForDiagnosticReport"
            }
        },
        "status":{
            "type":"string"
        },
        "category":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CodeableConceptForDiagnosticReport"
            }
        },
        "code":{
            "$ref":"#/components/schemas/CodeableConceptForDiagnosticReport"
        },
        "subject":{
            "$ref":"#/components/schemas/ReferenceForDiagnosticReport"
        },
        "encounter":{
            "$ref":"#/components/schemas/ReferenceForDiagnosticReport"
        },
        "issued":{
            "type":"string",
            "format":"date-time"
        },
        "_issued":{
            "$ref":"#/components/schemas/PrimitiveElementForDiagnosticReport"
        },
        "effectiveDateTime":{
            "type":"string",
            "format":"date-time"
        },
        "_effectiveDateTime":{
            "$ref":"#/components/schemas/PrimitiveElementForDiagnosticReport"
        },
        "effectivePeriod":{
            "$ref":"#/components/schemas/Period"
        },
        "performer":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ReferenceForDiagnosticReport"
            }
        },
        "resultsInterpreter":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ReferenceForDiagnosticReport"
            }
        },
        "specimen":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ReferenceForDiagnosticReport"
            }
        },
        "result":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ReferenceForDiagnosticReport"
            }
        },
        "media":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/MediaForDiagnosticReport"
            }
        },
        "conclusionCode":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CodeableConceptForDiagnosticReport"
            }
        },
        "presentedForm":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AttachmentForDiagnosticReport"
            }
        }
    },
    "required":[
        "resourceType",
        "id",
        "status",
        "category",
        "code",
        "subject"
    ]
}

Nested Schema : ProvenanceForDiagnosticReport

Type: object

Additional Properties Allowed: true

Show Source

• resourceType: string
  Allowed Values: [ "Provenance" ]

{
    "type":"object",
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "Provenance"
            ]
        }
    },
    "additionalProperties":true
}

Nested Schema : OperationOutcome

Type: object

The FHIR OperationOutcome.

Show Source

• issue: array issue
  The OperationOutcome issues.
• resourceType: string
  Allowed Values: [ "OperationOutcome" ]

  The FHIR resource type.

{
    "type":"object",
    "description":"The FHIR OperationOutcome.",
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "OperationOutcome"
            ],
            "description":"The FHIR resource type."
        },
        "issue":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/OperationOutcomeIssue"
            },
            "description":"The OperationOutcome issues."
        }
    }
}

Nested Schema : PrimitiveElementForDiagnosticReport

Type: object

Show Source

• extension: array extension

{
    "type":"object",
    "properties":{
        "extension":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ExtensionForDiagnosticReport"
            }
        }
    }
}

Nested Schema : basedOn

Type: array

Show Source

• Array of: object ReferenceForDiagnosticReport

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ReferenceForDiagnosticReport"
    }
}

Nested Schema : category

Type: array

Show Source

• Array of: object CodeableConceptForDiagnosticReport

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/CodeableConceptForDiagnosticReport"
    }
}

Nested Schema : CodeableConceptForDiagnosticReport

Type: object

Show Source

• coding: array coding
• extension: array extension
• text: string

{
    "type":"object",
    "properties":{
        "coding":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Coding"
            }
        },
        "text":{
            "type":"string"
        },
        "extension":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ExtensionForDiagnosticReport"
            }
        }
    }
}

Nested Schema : conclusionCode

Type: array

Show Source

• Array of: object CodeableConceptForDiagnosticReport

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/CodeableConceptForDiagnosticReport"
    }
}

Nested Schema : Period

Type: object

Show Source

• end: string
• start: string

{
    "type":"object",
    "properties":{
        "start":{
            "type":"string"
        },
        "end":{
            "type":"string"
        }
    }
}

Nested Schema : ReferenceForDiagnosticReport

Type: object

Show Source

• display: string
• extension: array extension
• reference: string
• type: string

{
    "type":"object",
    "properties":{
        "reference":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "display":{
            "type":"string"
        },
        "extension":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ExtensionForDiagnosticReport"
            }
        }
    }
}

Nested Schema : identifier

Type: array

Show Source

• Array of: object IdentifierForDiagnosticReport

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/IdentifierForDiagnosticReport"
    }
}

Nested Schema : media

Type: array

Show Source

• Array of: object MediaForDiagnosticReport

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/MediaForDiagnosticReport"
    }
}

Nested Schema : meta

Type: object

Show Source

• lastUpdated: string (date-time)
• security: array security
• versionId: string

{
    "type":"object",
    "properties":{
        "versionId":{
            "type":"string"
        },
        "lastUpdated":{
            "type":"string",
            "format":"date-time"
        },
        "security":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Coding"
            }
        }
    }
}

Nested Schema : performer

Type: array

Show Source

• Array of: object ReferenceForDiagnosticReport

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ReferenceForDiagnosticReport"
    }
}

Nested Schema : presentedForm

Type: array

Show Source

• Array of: object AttachmentForDiagnosticReport

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/AttachmentForDiagnosticReport"
    }
}

Nested Schema : result

Type: array

Show Source

• Array of: object ReferenceForDiagnosticReport

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ReferenceForDiagnosticReport"
    }
}

Nested Schema : resultsInterpreter

Type: array

Show Source

• Array of: object ReferenceForDiagnosticReport

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ReferenceForDiagnosticReport"
    }
}

Nested Schema : specimen

Type: array

Show Source

• Array of: object ReferenceForDiagnosticReport

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ReferenceForDiagnosticReport"
    }
}

Nested Schema : Narrative

Type: object

Show Source

• div: string
  The XHTML narrative content.
• status: string
  The narrative generation status.

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"The narrative generation status."
        },
        "div":{
            "type":"string",
            "description":"The XHTML narrative content."
        }
    }
}

Nested Schema : extension

Type: array

Show Source

• Array of: object ExtensionForDiagnosticReport

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ExtensionForDiagnosticReport"
    }
}

Nested Schema : ExtensionForDiagnosticReport

Type: object

Show Source

• url: string (uri)
• valueCode: string
• valueCodeableConcept: object CodeableConceptForDiagnosticReport

{
    "type":"object",
    "properties":{
        "url":{
            "type":"string",
            "format":"uri"
        },
        "valueCode":{
            "type":"string"
        },
        "valueCodeableConcept":{
            "$ref":"#/components/schemas/CodeableConceptForDiagnosticReport"
        }
    }
}

Nested Schema : coding

Type: array

Show Source

• Array of: object Coding

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Coding"
    }
}

Nested Schema : extension

Type: array

Show Source

• Array of: object ExtensionForDiagnosticReport

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ExtensionForDiagnosticReport"
    }
}

Nested Schema : Coding

Type: object

Show Source

• code: string
• display: string
• system: string
• userSelected: boolean

{
    "type":"object",
    "properties":{
        "system":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "display":{
            "type":"string"
        },
        "userSelected":{
            "type":"boolean"
        }
    }
}

Nested Schema : extension

Type: array

Show Source

• Array of: object ExtensionForDiagnosticReport

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ExtensionForDiagnosticReport"
    }
}

Nested Schema : IdentifierForDiagnosticReport

Type: object

Show Source

• system: string (uri)
• type: object CodeableConceptForDiagnosticReport
• value: string

{
    "type":"object",
    "properties":{
        "system":{
            "type":"string",
            "format":"uri"
        },
        "value":{
            "type":"string"
        },
        "type":{
            "$ref":"#/components/schemas/CodeableConceptForDiagnosticReport"
        }
    }
}

Nested Schema : MediaForDiagnosticReport

Type: object

Show Source

• link: object ReferenceForDiagnosticReport

{
    "type":"object",
    "properties":{
        "link":{
            "$ref":"#/components/schemas/ReferenceForDiagnosticReport"
        }
    }
}

Nested Schema : security

Type: array

Show Source

• Array of: object Coding

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Coding"
    }
}

Nested Schema : AttachmentForDiagnosticReport

Type: object

Show Source

• contentType: string
• creation: string (date-time)
• extension: array extension
• title: string
• url: string (uri)

{
    "type":"object",
    "properties":{
        "contentType":{
            "type":"string"
        },
        "url":{
            "type":"string",
            "format":"uri"
        },
        "title":{
            "type":"string"
        },
        "creation":{
            "type":"string",
            "format":"date-time"
        },
        "extension":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ExtensionForDiagnosticReport"
            }
        }
    }
}

Nested Schema : extension

Type: array

Show Source

• Array of: object ExtensionForDiagnosticReport

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ExtensionForDiagnosticReport"
    }
}

Nested Schema : issue

Type: array

The OperationOutcome issues.

Show Source

• Array of: object OperationOutcomeIssue

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/OperationOutcomeIssue"
    },
    "description":"The OperationOutcome issues."
}

Nested Schema : OperationOutcomeIssue

Type: object

Show Source

• code: string
• details: object CodeableConcept
• diagnostics: string
• expression: array expression
• severity: string

{
    "type":"object",
    "properties":{
        "severity":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "details":{
            "$ref":"#/components/schemas/CodeableConcept"
        },
        "diagnostics":{
            "type":"string"
        },
        "expression":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : CodeableConcept

Type: object

Show Source

• coding: array coding
  The terminology codings or data-absent-reason coding.
• id: string
• text: string
  The human-readable medication name.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "coding":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Coding"
            },
            "description":"The terminology codings or data-absent-reason coding."
        },
        "text":{
            "type":"string",
            "description":"The human-readable medication name."
        }
    }
}

Nested Schema : expression

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : coding

Type: array

The terminology codings or data-absent-reason coding.

Show Source

• Array of: object Coding

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Coding"
    },
    "description":"The terminology codings or data-absent-reason coding."
}

Nested Schema : BundleLink

Type: object

Show Source

• relation: string
  Allowed Values: [ "self", "next", "previous" ]

  The link relation.
• url: string
  The link URL.

{
    "type":"object",
    "properties":{
        "relation":{
            "type":"string",
            "enum":[
                "self",
                "next",
                "previous"
            ],
            "description":"The link relation."
        },
        "url":{
            "type":"string",
            "description":"The link URL."
        }
    }
}

Default Response

An OperationOutcome describing any error that occurred.

Body ()

Root Schema : OperationOutcome

Type: object

The FHIR OperationOutcome.

Show Source

• issue: array issue
  The OperationOutcome issues.
• resourceType: string
  Allowed Values: [ "OperationOutcome" ]

  The FHIR resource type.

{
    "type":"object",
    "description":"The FHIR OperationOutcome.",
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "OperationOutcome"
            ],
            "description":"The FHIR resource type."
        },
        "issue":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/OperationOutcomeIssue"
            },
            "description":"The OperationOutcome issues."
        }
    }
}

Nested Schema : issue

Type: array

The OperationOutcome issues.

Show Source

• Array of: object OperationOutcomeIssue

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/OperationOutcomeIssue"
    },
    "description":"The OperationOutcome issues."
}

Nested Schema : OperationOutcomeIssue

Type: object

Show Source

• code: string
• details: object CodeableConcept
• diagnostics: string
• expression: array expression
• severity: string

{
    "type":"object",
    "properties":{
        "severity":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "details":{
            "$ref":"#/components/schemas/CodeableConcept"
        },
        "diagnostics":{
            "type":"string"
        },
        "expression":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : CodeableConcept

Type: object

Show Source

• coding: array coding
  The terminology codings or data-absent-reason coding.
• id: string
• text: string
  The human-readable medication name.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "coding":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Coding"
            },
            "description":"The terminology codings or data-absent-reason coding."
        },
        "text":{
            "type":"string",
            "description":"The human-readable medication name."
        }
    }
}

Nested Schema : expression

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : coding

Type: array

The terminology codings or data-absent-reason coding.

Show Source

• Array of: object Coding

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Coding"
    },
    "description":"The terminology codings or data-absent-reason coding."
}

Nested Schema : Coding

Type: object

Show Source

• code: string
• display: string
• system: string
• userSelected: boolean

{
    "type":"object",
    "properties":{
        "system":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "display":{
            "type":"string"
        },
        "userSelected":{
            "type":"boolean"
        }
    }
}

Back to Top