# Get FHIR r4 diagnostic reports
Endpoint: GET /site/{siteId}/fhir/diagnostic-report
Version: 1.0
Security: bearer, bearer
## Path parameters:
- `siteId` (string, required)
Site identifier
## Query parameters:
- `_count` (number)
Number of items to return (default=20).
Example: 10
- `_page_token` (string)
Token for fetching the next page of results.
Example: "CgYK..."
- `_sort` (string)
Sort the results by a given field, e.g. _sort=family or _sort=-date.
Example: "family"
- `_elements` (string)
Restrict returned fields, e.g. _elements=identifier,name.
Example: "identifier,name"
- `telecom` (string)
Filter by resource telecom, e.g. date=[SYSTEM]|[VALUE].
Example: "telecom=phone|555-555-5555"
- `_id` (string)
Search for a specific resource by ID, e.g. _id=abc123.
Example: "abc123"
- `identifier` (string)
Search for resources by identifier token, e.g. identifier=http://hospital.org|12345.
Example: "http://hospital.org|12345"
- `_include` (string)
Include related resources, e.g. _include=Appointment:patient.
Example: "Appointment:patient"
- `patient` (string)
Include related patient resources, e.g. patient=Patient/[id]&.
Example: "patient=Patient/[id]&"
- `_revinclude` (string)
Reverse include related resources, e.g. _revinclude=Observation:subject.
Example: "Observation:subject"
- `_has` (string)
Reverse chaining, e.g. _has:Observation:subject:code=http://loinc.org|1234-5.
Example: "Observation:subject:code=http://loinc.org|1234-5"
- `_tag` (string)
Search by tag on the resource meta, e.g. _tag=http://example.org/tags|sample-tag.
Example: "http://example.org/tags|sample-tag"
- `_security` (string)
Search by security label on resource meta, e.g. _security=RBAC|CONFIDENTIAL.
Example: "RBAC|CONFIDENTIAL"
- `_profile` (string)
Search by profile in resource meta, e.g. _profile=http://example.org/fhir/StructureDefinition/custom-profile.
Example: "http://example.org/fhir/StructureDefinition/custom-profile"
## Response 200 fields (application/json):
- `resourceType` (any, required)
This is a Bundle resource
Enum: "Bundle"
- `id` (string)
Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.
Example: "example-id"
- `meta` (object)
The metadata about a resource. This is content in the resource that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
- `meta.id` (string)
An extension object type #string.
Example: "example-string"
- `meta.extension` (array)
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- `meta.versionId` (object)
An extension object type #id.
- `meta._versionId` (object)
An extension object type #Element.
- `meta.lastUpdated` (object)
An extension object type #instant.
- `meta._lastUpdated` (object)
An extension object type #Element.
- `meta.source` (string)
An extension object type #uri.
Example: "https://example.org/resource"
- `meta._source` (object)
An extension object type #Element.
- `meta.profile` (array)
A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].
Example: ["http://example.org/Profile"]
- `meta.security` (array)
Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.
- `meta.tag` (array)
Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.
- `implicitRules` (string)
String of characters used to identify a name or a resource
Example: "https://example.org/resource"
- `_implicitRules` (object)
Base definition for all elements in a resource.
- `language` (string)
A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents
Example: "sample-code"
- `_language` (object)
Base definition for all elements in a resource.
- `identifier` (object)
An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.
- `identifier.use` (any)
The purpose of this identifier.
Enum: "usual", "official", "temp", "secondary", "old"
- `identifier._use` (object)
An extension object type #Element.
- `identifier.type` (object)
An extension object type #CodeableConcept.
- `identifier.system` (string)
An extension object type #uri.
Example: "https://example.org/resource"
- `identifier._system` (object)
An extension object type #Element.
- `identifier.value` (string)
An extension object type #string.
Example: "example-string"
- `identifier._value` (object)
An extension object type #Element.
- `identifier.period` (object)
An extension object type #Period.
- `identifier.assigner` (object)
An extension object type #Reference.
- `type` (any)
Indicates the purpose of this bundle - how it is intended to be used.
Enum: "document", "message", "transaction", "transaction-response", "batch", "batch-response", "history", "searchset", "collection"
- `_type` (object)
Base definition for all elements in a resource.
- `timestamp` (string)
An instant in time - known at least to the second
Example: "2024-01-01T00:00:00Z"
- `_timestamp` (object)
Base definition for all elements in a resource.
- `total` (number)
An integer with a value that is not negative (e.g. >= 0)
- `_total` (object)
Base definition for all elements in a resource.
- `link` (array)
A series of links that provide context to this bundle.
Example: [{"relation":"search","url":"https://api.heydonto.com/fhir/diagnostic-report/?_count=20"},{"relation":"next","url":"https://api.heydonto.com/fhir/diagnostic-report/?_count=20&_page_token=TOKEN"},{"relation":"first","url":"https://api.heydonto.com/fhir/diagnostic-report/?_count=20"},{"relation":"self","url":"https://api.heydonto.com/fhir/diagnostic-report/?_count=20"}]
- `link.modifierExtension` (array)
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- `link.relation` (string)
An extension object type #string.
Example: "example-string"
- `link._relation` (object)
An extension object type #Element.
- `link.url` (string)
An extension object type #uri.
Example: "https://example.org/resource"
- `link._url` (object)
An extension object type #Element.
- `entry` (array)
An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).
Example: [{"resourceType":"Bundle","id":"101","type":"collection","entry":[{"fullUrl":"https://example.com/base/DiagnosticReport/101","resource":{"resourceType":"DiagnosticReport","id":"101","meta":{"tag":[{"system":"http://example.org/fhir/CodeSystem/workflow-codes","code":"01","display":"Needs Review"}]},"text":{"status":"generated","div":"\n\t\t\t\t\t\t
CBC Report for Wile. E. COYOTE (MRN: 23453) issued 3-Mar 2011 11:45
\n\t\t\t\t\t\t
\nTest Units Value Reference Range\nHaemoglobin g/L 176 135 - 180\nRed Cell Count x10*12/L 5.9 4.2 - 6.0\nHaematocrit 0.55+ 0.38 - 0.52\nMean Cell Volume fL 99+ 80 - 98\nMean Cell Haemoglobin pg 36+ 27 - 35\nPlatelet Count x10*9/L 444 150 - 450\nWhite Cell Count x10*9/L 4.6 4.0 - 11.0\nNeutrophils % 20\nNeutrophils x10*9/L 0.9--- 2.0 - 7.5\nLymphocytes % 20\nLymphocytes x10*9/L 0.9- 1.1 - 4.0\nMonocytes % 20\nMonocytes x10*9/L 0.9 0.2 - 1.0\nEosinophils % 20\nEosinophils x10*9/L 0.92++ 0.04 - 0.40\nBasophils % 20\nBasophils x10*9/L 0.92+++ <0.21\n
\n\t\t\t\t\t\t
Acme Laboratory, Inc signed: Dr Pete Pathologist
\n\t\t\t\t\t
Generated Narrative with Details
id: r1
status: final
code: Haemoglobin (Details : {LOINC code '718-7' = 'Hemoglobin [Mass/volume] in Blood', given as 'Hemoglobin [Mass/volume] in Blood'})
subject: Patient/pat2
performer: Acme Laboratory, Inc
value: 176 g/L (Details: UCUM code g/L = 'g/L')
ReferenceRanges
| - | Low | High |
| * | 135 g/L (Details: UCUM code g/L = 'g/L') | 180 g/L (Details: UCUM code g/L = 'g/L') |
Generated Narrative with Details
id: r2
status: final
code: Red Cell Count (Details : {LOINC code '789-8' = 'Erythrocytes [#/volume] in Blood by Automated count', given as 'Erythrocytes [#/volume] in Blood by Automated count'})
subject: Patient/pat2
performer: Acme Laboratory, Inc
value: 5.9 x10*12/L (Details: UCUM code 10*12/L = '10*12/L')
ReferenceRanges
| - | Low | High |
| * | 4.2 x10*12/L (Details: UCUM code 10*12/L = '10*12/L') | 6.0 x10*12/L (Details: UCUM code 10*12/L = '10*12/L') |
Generated Narrative with Details
id: r3
status: final
code: Haematocrit (Details : {LOINC code '4544-3' = 'Hematocrit [Volume Fraction] of Blood by Automated count', given as 'Hematocrit [Volume Fraction] of Blood by Automated count'})
subject: Patient/pat2
performer: Acme Laboratory, Inc
value: 55 %
interpretation: High (Details : {http://terminology.hl7.org/CodeSystem/v3-ObservationInterpretation code 'H' = 'High)
ReferenceRanges
Generated Narrative with Details
id: r4
status: final
code: Mean Cell Volume (Details : {LOINC code '787-2' = 'Erythrocyte mean corpuscular volume [Entitic volume] by Automated count', given as 'Erythrocyte mean corpuscular volume [Entitic volume] by Automated count'})
subject: Patient/pat2
performer: Acme Laboratory, Inc
value: 99 fL (Details: UCUM code fL = 'fL')
interpretation: High (Details : {http://terminology.hl7.org/CodeSystem/v3-ObservationInterpretation code 'H' = 'High)
ReferenceRanges
| - | Low | High |
| * | 80 fL (Details: UCUM code fL = 'fL') | 98 fL (Details: UCUM code fL = 'fL') |
Generated Narrative with Details
id: r5
status: final
code: Mean Cell Haemoglobin (Details : {LOINC code '785-6' = 'Erythrocyte mean corpuscular hemoglobin [Entitic mass] by Automated count', given as 'Erythrocyte mean corpuscular hemoglobin [Entitic mass] by Automated count'})
subject: Patient/pat2
performer: Acme Laboratory, Inc
value: 36 pg (Details: UCUM code pg = 'pg')
interpretation: High (Details : {http://terminology.hl7.org/CodeSystem/v3-ObservationInterpretation code 'H' = 'High)
ReferenceRanges
| - | Low | High |
| * | 27 pg (Details: UCUM code pg = 'pg') | 35 pg (Details: UCUM code pg = 'pg') |
Generated Narrative with Details
id: r6
status: final
code: Platelet Count (Details : {LOINC code '777-3' = 'Platelets [#/volume] in Blood by Automated count', given as 'Platelets [#/volume] in Blood by Automated count'})
subject: Patient/pat2
performer: Acme Laboratory, Inc
value: 444 x10*9/L (Details: UCUM code 10*9/L = '10*9/L')
ReferenceRanges
| - | Low | High |
| * | 150 x10*9/L (Details: UCUM code 10*9/L = '10*9/L') | 450 x10*9/L (Details: UCUM code 10*9/L = '10*9/L') |
Generated Narrative with Details
id: r7
status: final
code: White Cell Count (Details : {LOINC code '6690-2' = 'Leukocytes [#/volume] in Blood by Automated count', given as 'Leukocytes [#/volume] in Blood by Automated count'})
subject: Patient/pat2
performer: Acme Laboratory, Inc
value: 4.6 x10*9/L (Details: UCUM code 10*9/L = '10*9/L')
ReferenceRanges
| - | Low | High |
| * | 4.0 x10*9/L (Details: UCUM code 10*9/L = '10*9/L') | 11.0 x10*9/L (Details: UCUM code 10*9/L = '10*9/L') |
Generated Narrative with Details
id: r8
status: final
code: Neutrophils (Details : {LOINC code '770-8' = 'Neutrophils/100 leukocytes in Blood by Automated count', given as 'Neutrophils/100 leukocytes in Blood by Automated count'})
subject: Patient/pat2
performer: Acme Laboratory, Inc
value: 20 % (Details: UCUM code % = '%')
Generated Narrative with Details
id: r9
status: final
code: Neutrophils (Details : {LOINC code '751-8' = 'Neutrophils [#/volume] in Blood by Automated count', given as 'Neutrophils [#/volume] in Blood by Automated count'})
subject: Patient/pat2
performer: Acme Laboratory, Inc
value: 0.9 x10*9/L (Details: UCUM code 10*9/L = '10*9/L')
interpretation: Critical low (Details : {http://terminology.hl7.org/CodeSystem/v3-ObservationInterpretation code 'LL' = 'Critical low)
ReferenceRanges
| - | Low | High |
| * | 2.0 x10*9/L (Details: UCUM code 10*9/L = '10*9/L') | 7.5 x10*9/L (Details: UCUM code 10*9/L = '10*9/L') |
Generated Narrative with Details
id: r10
status: final
code: Lymphocytes (Details : {LOINC code '736-9' = 'Lymphocytes/100 leukocytes in Blood by Automated count', given as 'Lymphocytes/100 leukocytes in Blood by Automated count'})
subject: Patient/pat2
performer: Acme Laboratory, Inc
value: 20 % (Details: UCUM code % = '%')
Generated Narrative with Details
id: r11
status: final
code: Lymphocytes (Details : {LOINC code '731-0' = 'Lymphocytes [#/volume] in Blood by Automated count', given as 'Lymphocytes [#/volume] in Blood by Automated count'})
subject: Patient/pat2
performer: Acme Laboratory, Inc
value: 0.9 x10*9/L (Details: UCUM code 10*9/L = '10*9/L')
interpretation: Low (Details : {http://terminology.hl7.org/CodeSystem/v3-ObservationInterpretation code 'L' = 'Low)
ReferenceRanges
| - | Low | High |
| * | 1.1 x10*9/L (Details: UCUM code 10*9/L = '10*9/L') | 4.0 x10*9/L (Details: UCUM code 10*9/L = '10*9/L') |
Generated Narrative with Details
id: r12
status: final
code: Monocytes (Details : {LOINC code '5905-5' = 'Monocytes/100 leukocytes in Blood by Automated count', given as 'Monocytes/100 leukocytes in Blood by Automated count'})
subject: Patient/pat2
performer: Acme Laboratory, Inc
value: 20 % (Details: UCUM code % = '%')
Generated Narrative with Details
id: r13
status: final
code: Monocytes (Details : {LOINC code '742-7' = 'Monocytes [#/volume] in Blood by Automated count', given as 'Monocytes [#/volume] in Blood by Automated count'})
subject: Patient/pat2
performer: Acme Laboratory, Inc
value: 0.9 x10*9/L (Details: UCUM code 10*9/L = '10*9/L')
ReferenceRanges
| - | Low | High |
| * | 0.2 x10*9/L (Details: UCUM code 10*9/L = '10*9/L') | 1.0 x10*9/L (Details: UCUM code 10*9/L = '10*9/L') |
Generated Narrative with Details
id: r14
status: final
code: Eosinophils (Details : {LOINC code '713-8' = 'Eosinophils/100 leukocytes in Blood by Automated count', given as 'Eosinophils/100 leukocytes in Blood by Automated count'})
subject: Patient/pat2
performer: Acme Laboratory, Inc
value: 20 % (Details: UCUM code % = '%')
Generated Narrative with Details
id: r15
status: final
code: Eosinophils (Details : {LOINC code '711-2' = 'Eosinophils [#/volume] in Blood by Automated count', given as 'Eosinophils [#/volume] in Blood by Automated count'})
subject: Patient/pat2
performer: Acme Laboratory, Inc
value: 0.92 x10*9/L (Details: UCUM code 10*9/L = '10*9/L')
interpretation: Critical high (Details : {http://terminology.hl7.org/CodeSystem/v3-ObservationInterpretation code 'HH' = 'Critical high)
ReferenceRanges
| - | Low | High |
| * | 0.04 x10*9/L (Details: UCUM code 10*9/L = '10*9/L') | 0.40 x10*9/L (Details: UCUM code 10*9/L = '10*9/L') |
Generated Narrative with Details
id: r16
status: final
code: Basophils (Details : {LOINC code '706-2' = 'Basophils/100 leukocytes in Blood by Automated count', given as 'Basophils/100 leukocytes in Blood by Automated count'})
subject: Patient/pat2
performer: Acme Laboratory, Inc
value: 20 % (Details: UCUM code % = '%')
Generated Narrative with Details
id: r17
status: final
code: Basophils (Details : {LOINC code '704-7' = 'Basophils [#/volume] in Blood by Automated count', given as 'Basophils [#/volume] in Blood by Automated count'})
subject: Patient/pat2
performer: Acme Laboratory, Inc
value: 0.92 x10*9/L (Details: UCUM code 10*9/L = '10*9/L')
ReferenceRanges
| - | High |
| * | 0.21 x10*9/L (Details: UCUM code 10*9/L = '10*9/L') |
Example
"
- `entry.contained` (array)
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
- `entry.extension` (array)
May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- `entry.extension.valueBase64Binary` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "U2FtcGxl"
- `entry.extension._valueBase64Binary` (object)
An extension object type #Element.
- `entry.extension.valueBoolean` (boolean)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: true
- `entry.extension._valueBoolean` (object)
An extension object type #Element.
- `entry.extension.valueCanonical` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "http://example.org/Profile"
- `entry.extension._valueCanonical` (object)
An extension object type #Element.
- `entry.extension.valueCode` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "sample-code"
- `entry.extension._valueCode` (object)
An extension object type #Element.
- `entry.extension.valueDate` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "2024-01-01"
- `entry.extension._valueDate` (object)
An extension object type #Element.
- `entry.extension.valueDateTime` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "2024-01-01T00:00:00Z"
- `entry.extension._valueDateTime` (object)
An extension object type #Element.
- `entry.extension.valueDecimal` (number)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: 1.23
- `entry.extension._valueDecimal` (object)
An extension object type #Element.
- `entry.extension.valueId` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "example-id"
- `entry.extension._valueId` (object)
An extension object type #Element.
- `entry.extension.valueInstant` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "2024-01-01T00:00:00Z"
- `entry.extension._valueInstant` (object)
An extension object type #Element.
- `entry.extension.valueInteger` (number)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: 1
- `entry.extension._valueInteger` (object)
An extension object type #Element.
- `entry.extension.valueMarkdown` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "Sample markdown text"
- `entry.extension._valueMarkdown` (object)
An extension object type #Element.
- `entry.extension.valueOid` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "urn:oid:1.2.3.4.5"
- `entry.extension._valueOid` (object)
An extension object type #Element.
- `entry.extension.valuePositiveInt` (number)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: 1
- `entry.extension._valuePositiveInt` (object)
An extension object type #Element.
- `entry.extension.valueString` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "example-string"
- `entry.extension._valueString` (object)
An extension object type #Element.
- `entry.extension.valueTime` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "12:00:00"
- `entry.extension._valueTime` (object)
An extension object type #Element.
- `entry.extension.valueUnsignedInt` (number)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
- `entry.extension._valueUnsignedInt` (object)
An extension object type #Element.
- `entry.extension.valueUri` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "https://example.org/resource"
- `entry.extension._valueUri` (object)
An extension object type #Element.
- `entry.extension.valueUrl` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "https://example.org"
- `entry.extension._valueUrl` (object)
An extension object type #Element.
- `entry.extension.valueUuid` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "urn:uuid:123e4567-e89b-12d3-a456-426614174000"
- `entry.extension._valueUuid` (object)
An extension object type #Element.
- `entry.extension.valueAddress` (object)
An extension object type #Address.
- `entry.extension.valueAge` (object)
An extension object type #Age.
- `entry.extension.valueAnnotation` (object)
An extension object type #Annotation.
- `entry.extension.valueAttachment` (object)
An extension object type #Attachment.
- `entry.extension.valueCodeableConcept` (object)
An extension object type #CodeableConcept.
- `entry.extension.valueCoding` (object)
An extension object type #Coding.
- `entry.extension.valueContactPoint` (object)
An extension object type #ContactPoint.
- `entry.extension.valueCount` (object)
An extension object type #Count.
- `entry.extension.valueDistance` (object)
An extension object type #Distance.
- `entry.extension.valueDuration` (object)
An extension object type #Duration.
- `entry.extension.valueHumanName` (object)
An extension object type #HumanName.
- `entry.extension.valueIdentifier` (object)
An extension object type #Identifier.
- `entry.extension.valueMoney` (object)
An extension object type #Money.
- `entry.extension.valuePeriod` (object)
An extension object type #Period.
- `entry.extension.valueQuantity` (object)
An extension object type #Quantity.
- `entry.extension.valueRange` (object)
An extension object type #Range.
- `entry.extension.valueRatio` (object)
An extension object type #Ratio.
- `entry.extension.valueReference` (object)
An extension object type #Reference.
- `entry.extension.valueSampledData` (object)
An extension object type #SampledData.
- `entry.extension.valueSignature` (object)
An extension object type #Signature.
- `entry.extension.valueTiming` (object)
An extension object type #Timing.
- `entry.extension.valueContactDetail` (object)
An extension object type #ContactDetail.
- `entry.extension.valueContributor` (object)
An extension object type #Contributor.
- `entry.extension.valueDataRequirement` (object)
An extension object type #DataRequirement.
- `entry.extension.valueExpression` (object)
An extension object type #Expression.
- `entry.extension.valueParameterDefinition` (object)
An extension object type #ParameterDefinition.
- `entry.extension.valueRelatedArtifact` (object)
An extension object type #RelatedArtifact.
- `entry.extension.valueTriggerDefinition` (object)
An extension object type #TriggerDefinition.
- `entry.extension.valueUsageContext` (object)
An extension object type #UsageContext.
- `entry.extension.valueDosage` (object)
An extension object type #Dosage.
- `entry.extension.valueMeta` (object)
An extension object type #Meta.
- `entry.modifierExtension` (array)
May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- `entry.identifier` (array)
Identifiers assigned to this report by the performer or other systems.
- `entry.basedOn` (array)
Details concerning a service requested.
- `entry.basedOn.reference` (string)
An extension object type #string.
Example: "example-string"
- `entry.basedOn._reference` (object)
An extension object type #Element.
- `entry.basedOn.type` (string)
An extension object type #uri.
Example: "https://example.org/resource"
- `entry.basedOn._type` (object)
An extension object type #Element.
- `entry.basedOn.identifier` (object)
An extension object type #Identifier.
- `entry.basedOn.display` (string)
An extension object type #string.
Example: "example-string"
- `entry.basedOn._display` (object)
An extension object type #Element.
- `entry.status` (any)
The status of the diagnostic report.
Enum: "registered", "partial", "preliminary", "final", "amended", "corrected", "appended", "cancelled", "entered-in-error", "unknown"
- `entry._status` (object)
Base definition for all elements in a resource.
- `entry.category` (array)
A 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.
- `entry.category.coding` (array)
A reference to a code defined by a terminology system.
- `entry.category.text` (string)
An extension object type #string.
Example: "example-string"
- `entry.category._text` (object)
An extension object type #Element.
- `entry.code` (object, required)
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
- `entry.subject` (object)
A reference from one resource to another.
- `entry.encounter` (object)
A reference from one resource to another.
- `entry.effectiveDateTime` (string)
The 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.
Example: "example-string"
- `entry._effectiveDateTime` (object)
Base definition for all elements in a resource.
- `entry.effectivePeriod` (object)
A time period defined by a start and end date and optionally time.
- `entry.effectivePeriod.start` (string)
An extension object type #dateTime.
Example: "2024-01-01T00:00:00Z"
- `entry.effectivePeriod._start` (object)
An extension object type #Element.
- `entry.effectivePeriod.end` (string)
An extension object type #dateTime.
Example: "2024-01-01T00:00:00Z"
- `entry.effectivePeriod._end` (object)
An extension object type #Element.
- `entry.issued` (string)
An instant in time - known at least to the second
Example: "2024-01-01T00:00:00Z"
- `entry._issued` (object)
Base definition for all elements in a resource.
- `entry.performer` (array)
The diagnostic service that is responsible for issuing the report.
- `entry.resultsInterpreter` (array)
The practitioner or organization that is responsible for the report's conclusions and interpretations.
- `entry.specimen` (array)
Details about the specimens on which this diagnostic report is based.
- `entry.result` (array)
[Observations](https://hl7.org/fhir/observation.html) that are part of this diagnostic report.
- `entry.imagingStudy` (array)
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.
- `entry.media` (array)
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).
- `entry.media.comment` (string)
An extension object type #string.
Example: "example-string"
- `entry.media._comment` (object)
An extension object type #Element.
- `entry.media.link` (object, required)
An extension object type #Reference.
- `entry.conclusion` (string)
A sequence of Unicode characters
Example: "example-string"
- `entry._conclusion` (object)
Base definition for all elements in a resource.
- `entry.conclusionCode` (array)
One or more codes that represent the summary conclusion (interpretation/impression) of the diagnostic report.
- `entry.presentedForm` (array)
Rich text representation of the entire result as issued by the diagnostic service. Multiple formats are allowed but they SHALL be semantically equivalent.
- `entry.presentedForm.contentType` (string)
An extension object type #code.
Example: "sample-code"
- `entry.presentedForm._contentType` (object)
An extension object type #Element.
- `entry.presentedForm.language` (string)
An extension object type #code.
Example: "sample-code"
- `entry.presentedForm._language` (object)
An extension object type #Element.
- `entry.presentedForm.data` (string)
An extension object type #base64Binary.
Example: "U2FtcGxl"
- `entry.presentedForm._data` (object)
An extension object type #Element.
- `entry.presentedForm.url` (string)
An extension object type #url.
Example: "https://example.org"
- `entry.presentedForm.size` (integer)
An extension object type #unsignedInt.
- `entry.presentedForm._size` (object)
An extension object type #Element.
- `entry.presentedForm.hash` (string)
An extension object type #base64Binary.
Example: "U2FtcGxl"
- `entry.presentedForm._hash` (object)
An extension object type #Element.
- `entry.presentedForm.title` (string)
An extension object type #string.
Example: "example-string"
- `entry.presentedForm._title` (object)
An extension object type #Element.
- `entry.presentedForm.creation` (string)
An extension object type #dateTime.
Example: "2024-01-01T00:00:00Z"
- `entry.presentedForm._creation` (object)
An extension object type #Element.
- `signature` (object)
A signature along with supporting context. The signature may be a digital signature that is cryptographic in nature, or some other signature acceptable to the domain. This other signature may be as simple as a graphical image representing a hand-written signature, or a signature ceremony Different signature approaches have different utilities.
- `signature.type` (array, required)
An indication of the reason that the entity signed this document. This may be explicitly included as part of the signature information and can be used when determining accountability for various actions concerning the document.
- `signature.when` (object)
An extension object type #instant.
- `signature._when` (object)
An extension object type #Element.
- `signature.who` (object, required)
An extension object type #Reference.
- `signature.onBehalfOf` (object)
An extension object type #Reference.
- `signature.targetFormat` (string)
An extension object type #code.
Example: "sample-code"
- `signature._targetFormat` (object)
An extension object type #Element.
- `signature.sigFormat` (string)
An extension object type #code.
Example: "sample-code"
- `signature._sigFormat` (object)
An extension object type #Element.
## Response 401 fields (application/json):
- `message` (string, required)
Error message indicating unauthorized access.
Example: "Unauthorized"
- `statusCode` (number, required)
HTTP status code for unauthorized access.
Example: 401