API documentation for HeyDonto API users
Sort the results by a given field, e.g. _sort=family or _sort=-date.
Restrict returned fields, e.g. _elements=identifier,name.
Filter by last update time, e.g. _lastUpdated=ge2024-01-01.
Search for resources by identifier token, e.g. identifier=http://hospital.org|12345.
Include related resources, e.g. _include=Appointment:patient.
Reverse include related resources, e.g. _revinclude=Observation:subject.
Reverse chaining, e.g. _has:Observation:subject:code=http://loinc.org|1234-5.
Search by tag on the resource meta, e.g. _tag=http://example.org/tags|sample-tag.
Search by security label on resource meta, e.g. _security=RBAC|CONFIDENTIAL.
Search by profile in resource meta, e.g. _profile=http://example.org/fhir/StructureDefinition/custom-profile.
Search Patients by birthdate, e.g. birthdate=ge2000-01-01 or birthdate=lt2010-01-01.
Partial match on Patient name, e.g. name:contains=lic.
curl -i -X GET \
'https://docs.heydonto.com/_mock/apis/fhir/openapi/site/{siteId}/fhir/imaging-study?_count=10&_elements=identifier%2Cname&_has=Observation%3Asubject%3Acode%3Dhttp%3A%2F%2Floinc.org%2C1234-5&_id=abc123&_include=Appointment%3Apatient&_lastUpdated=string&_page_token=CgYK...&_profile=http%3A%2F%2Fexample.org%2Ffhir%2FStructureDefinition%2Fcustom-profile&_revinclude=Observation%3Asubject&_security=RBAC%2CCONFIDENTIAL&_sort=family&_tag=http%3A%2F%2Fexample.org%2Ftags%2Csample-tag&birthdate=ge2000-01-01&identifier=http%3A%2F%2Fhospital.org%2C12345&name%3Acontains=lic&name%3Aexact=Alice&patient.name=Alice' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'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.
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.
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
An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.
Indicates the purpose of this bundle - how it is intended to be used.
An instant in time - known at least to the second
A series of links that provide context to this bundle.
An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).
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.
{ "resourceType": "Bundle", "type": "searchset", "total": 100, "link": [ { … }, { … }, { … }, { … } ], "entry": [ { … } ] }
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.
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.
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
A human-readable summary of the resource conveying the essential clinical and business information for the resource.
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.
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.
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).
Identifiers for the ImagingStudy such as DICOM Study Instance UID, and Accession Number.
The current state of the ImagingStudy.
A list of all the series.modality values that are actual acquisition modalities, i.e. those in the DICOM Context Group 29 (value set OID 1.2.840.10008.6.1.19).
A reference from one resource to another.
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.
A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.
A list of the diagnostic requests that resulted in this imaging study being performed.
Who read the study and interpreted the images or other content.
The network service providing access (e.g., query, view, or retrieval) for the study. See implementation notes for information about using DICOM endpoints. A study-level endpoint applies to each series in the study, unless overridden by a series-level endpoint with the same Endpoint.connectionType.
An integer with a value that is not negative (e.g. >= 0)
An integer with a value that is not negative (e.g. >= 0)
Description of clinical condition indicating why the ImagingStudy was requested.
Indicates another resource whose existence justifies this Study.
Per the recommended DICOM mapping, this element is derived from the Study Description attribute (0008,1030). Observations or findings about the imaging study should be recorded in another resource, e.g. Observation, and not in this element.
Each study has one or more series of images or other content.
curl -i -X POST \
'https://docs.heydonto.com/_mock/apis/fhir/openapi/site/{siteId}/fhir/imaging-study' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"resourceType": "ImagingStudy",
"id": "example",
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">CT Chest. John Smith (MRN: 09236). Accession: W12342398. Performed: 2011-01-01. 3 series, 12 images.</div>"
},
"identifier": [
{
"system": "urn:dicom:uid",
"value": "urn:oid:2.16.124.113543.6003.1154777499.30246.19789.3503430045"
}
],
"status": "available",
"subject": {
"reference": "Patient/dicom"
},
"started": "2011-01-01T11:01:20+03:00",
"numberOfSeries": 1,
"numberOfInstances": 1,
"series": [
{
"uid": "2.16.124.113543.6003.2588828330.45298.17418.2723805630",
"number": 3,
"modality": {
"system": "http://dicom.nema.org/resources/ontology/DCM",
"code": "CT"
},
"description": "CT Surview 180",
"numberOfInstances": 1,
"bodySite": {
"system": "http://snomed.info/sct",
"code": "67734004",
"display": "Upper Trunk Structure"
},
"instance": [
{
"uid": "2.16.124.113543.6003.189642796.63084.16748.2599092903",
"sopClass": {
"system": "urn:ietf:rfc:3986",
"code": "urn:oid:1.2.840.10008.5.1.4.1.1.2"
},
"number": 1
}
]
}
]
}'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.
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.
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
A human-readable summary of the resource conveying the essential clinical and business information for the resource.
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.
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.
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).
Identifiers for the ImagingStudy such as DICOM Study Instance UID, and Accession Number.
The current state of the ImagingStudy.
A list of all the series.modality values that are actual acquisition modalities, i.e. those in the DICOM Context Group 29 (value set OID 1.2.840.10008.6.1.19).
A reference from one resource to another.
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.
A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.
A list of the diagnostic requests that resulted in this imaging study being performed.
Who read the study and interpreted the images or other content.
The network service providing access (e.g., query, view, or retrieval) for the study. See implementation notes for information about using DICOM endpoints. A study-level endpoint applies to each series in the study, unless overridden by a series-level endpoint with the same Endpoint.connectionType.
An integer with a value that is not negative (e.g. >= 0)
An integer with a value that is not negative (e.g. >= 0)
Description of clinical condition indicating why the ImagingStudy was requested.
Indicates another resource whose existence justifies this Study.
Per the recommended DICOM mapping, this element is derived from the Study Description attribute (0008,1030). Observations or findings about the imaging study should be recorded in another resource, e.g. Observation, and not in this element.
Each study has one or more series of images or other content.
{ "resourceType": "ImagingStudy", "id": "example", "text": { "status": "generated", "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">CT Chest. John Smith (MRN: 09236). Accession: W12342398. Performed: 2011-01-01. 3 series, 12 images.</div>" }, "identifier": [ { … } ], "status": "available", "subject": { "reference": "Patient/dicom" }, "started": "2011-01-01T11:01:20+03:00", "numberOfSeries": 1, "numberOfInstances": 1, "series": [ { … } ] }
curl -i -X GET \
'https://docs.heydonto.com/_mock/apis/fhir/openapi/site/{siteId}/fhir/imaging-study/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'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.
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.
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
A human-readable summary of the resource conveying the essential clinical and business information for the resource.
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.
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.
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).
Identifiers for the ImagingStudy such as DICOM Study Instance UID, and Accession Number.
The current state of the ImagingStudy.
A list of all the series.modality values that are actual acquisition modalities, i.e. those in the DICOM Context Group 29 (value set OID 1.2.840.10008.6.1.19).
A reference from one resource to another.
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.
A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.
A list of the diagnostic requests that resulted in this imaging study being performed.
Who read the study and interpreted the images or other content.
The network service providing access (e.g., query, view, or retrieval) for the study. See implementation notes for information about using DICOM endpoints. A study-level endpoint applies to each series in the study, unless overridden by a series-level endpoint with the same Endpoint.connectionType.
An integer with a value that is not negative (e.g. >= 0)
An integer with a value that is not negative (e.g. >= 0)
Description of clinical condition indicating why the ImagingStudy was requested.
Indicates another resource whose existence justifies this Study.
Per the recommended DICOM mapping, this element is derived from the Study Description attribute (0008,1030). Observations or findings about the imaging study should be recorded in another resource, e.g. Observation, and not in this element.
Each study has one or more series of images or other content.
{ "resourceType": "ImagingStudy", "id": "example", "text": { "status": "generated", "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">CT Chest. John Smith (MRN: 09236). Accession: W12342398. Performed: 2011-01-01. 3 series, 12 images.</div>" }, "identifier": [ { … } ], "status": "available", "subject": { "reference": "Patient/dicom" }, "started": "2011-01-01T11:01:20+03:00", "numberOfSeries": 1, "numberOfInstances": 1, "series": [ { … } ] }
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.
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.
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
A human-readable summary of the resource conveying the essential clinical and business information for the resource.
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.
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.
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).
Identifiers for the ImagingStudy such as DICOM Study Instance UID, and Accession Number.
The current state of the ImagingStudy.
A list of all the series.modality values that are actual acquisition modalities, i.e. those in the DICOM Context Group 29 (value set OID 1.2.840.10008.6.1.19).
A reference from one resource to another.
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.
A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.
A list of the diagnostic requests that resulted in this imaging study being performed.
Who read the study and interpreted the images or other content.
The network service providing access (e.g., query, view, or retrieval) for the study. See implementation notes for information about using DICOM endpoints. A study-level endpoint applies to each series in the study, unless overridden by a series-level endpoint with the same Endpoint.connectionType.
An integer with a value that is not negative (e.g. >= 0)
An integer with a value that is not negative (e.g. >= 0)
Description of clinical condition indicating why the ImagingStudy was requested.
Indicates another resource whose existence justifies this Study.
Per the recommended DICOM mapping, this element is derived from the Study Description attribute (0008,1030). Observations or findings about the imaging study should be recorded in another resource, e.g. Observation, and not in this element.
Each study has one or more series of images or other content.
curl -i -X PUT \
'https://docs.heydonto.com/_mock/apis/fhir/openapi/site/{siteId}/fhir/imaging-study/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"resourceType": "ImagingStudy",
"id": "example",
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">CT Chest. John Smith (MRN: 09236). Accession: W12342398. Performed: 2011-01-01. 3 series, 12 images.</div>"
},
"identifier": [
{
"system": "urn:dicom:uid",
"value": "urn:oid:2.16.124.113543.6003.1154777499.30246.19789.3503430045"
}
],
"status": "available",
"subject": {
"reference": "Patient/dicom"
},
"started": "2011-01-01T11:01:20+03:00",
"numberOfSeries": 1,
"numberOfInstances": 1,
"series": [
{
"uid": "2.16.124.113543.6003.2588828330.45298.17418.2723805630",
"number": 3,
"modality": {
"system": "http://dicom.nema.org/resources/ontology/DCM",
"code": "CT"
},
"description": "CT Surview 180",
"numberOfInstances": 1,
"bodySite": {
"system": "http://snomed.info/sct",
"code": "67734004",
"display": "Upper Trunk Structure"
},
"instance": [
{
"uid": "2.16.124.113543.6003.189642796.63084.16748.2599092903",
"sopClass": {
"system": "urn:ietf:rfc:3986",
"code": "urn:oid:1.2.840.10008.5.1.4.1.1.2"
},
"number": 1
}
]
}
]
}'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.
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.
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
A human-readable summary of the resource conveying the essential clinical and business information for the resource.
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.
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.
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).
Identifiers for the ImagingStudy such as DICOM Study Instance UID, and Accession Number.
The current state of the ImagingStudy.
A list of all the series.modality values that are actual acquisition modalities, i.e. those in the DICOM Context Group 29 (value set OID 1.2.840.10008.6.1.19).
A reference from one resource to another.
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.
A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.
A list of the diagnostic requests that resulted in this imaging study being performed.
Who read the study and interpreted the images or other content.
The network service providing access (e.g., query, view, or retrieval) for the study. See implementation notes for information about using DICOM endpoints. A study-level endpoint applies to each series in the study, unless overridden by a series-level endpoint with the same Endpoint.connectionType.
An integer with a value that is not negative (e.g. >= 0)
An integer with a value that is not negative (e.g. >= 0)
Description of clinical condition indicating why the ImagingStudy was requested.
Indicates another resource whose existence justifies this Study.
Per the recommended DICOM mapping, this element is derived from the Study Description attribute (0008,1030). Observations or findings about the imaging study should be recorded in another resource, e.g. Observation, and not in this element.
Each study has one or more series of images or other content.
{ "resourceType": "ImagingStudy", "id": "example", "text": { "status": "generated", "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">CT Chest. John Smith (MRN: 09236). Accession: W12342398. Performed: 2011-01-01. 3 series, 12 images.</div>" }, "identifier": [ { … } ], "status": "available", "subject": { "reference": "Patient/dicom" }, "started": "2011-01-01T11:01:20+03:00", "numberOfSeries": 1, "numberOfInstances": 1, "series": [ { … } ] }
curl -i -X DELETE \
'https://docs.heydonto.com/_mock/apis/fhir/openapi/site/{siteId}/fhir/imaging-study/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'{ "statusText": "OK", "status": 200 }
curl -i -X GET \
'https://docs.heydonto.com/_mock/apis/fhir/openapi/site/{siteId}/fhir/imaging-study/{id}/history' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'A list of entries representing historical versions of the resource.
{ "resourceType": "Bundle", "type": "history", "entry": [ { … } ], "total": 2 }