API documentation for HeyDonto API users
https://docs.heydonto.com/_mock/apis/fhir/openapi/
https://api-staging.heydonto.com/
https://api.heydonto.com/
Sort the results by a given field, e.g. _sort=family or _sort=-date.
Restrict returned fields, e.g. _elements=identifier,name.
Filter by resource telecom, e.g. date=[SYSTEM]|[VALUE].
Search for resources by identifier token, e.g. identifier=http://hospital.org|12345.
Include related resources, e.g. _include=Appointment:patient.
Include related patient resources, e.g. patient=Patient/[id]&.
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.
- Mock server
https://docs.heydonto.com/_mock/apis/fhir/openapi/site/{siteId}/fhir/bundle
- Sandbox
https://api-staging.heydonto.com/site/{siteId}/fhir/bundle
- Production
https://api.heydonto.com/site/{siteId}/fhir/bundle
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.heydonto.com/_mock/apis/fhir/openapi/site/{siteId}/fhir/bundle?_count=10&_page_token=CgYK...&_sort=family&_elements=identifier%2Cname&telecom=telecom%3Dphone%2C555-555-5555&_id=abc123&identifier=http%3A%2F%2Fhospital.org%2C12345&_include=Appointment%3Apatient&patient=patient%3DPatient%2F%5Bid%5D%26&_revinclude=Observation%3Asubject&_has=Observation%3Asubject%3Acode%3Dhttp%3A%2F%2Floinc.org%2C1234-5&_tag=http%3A%2F%2Fexample.org%2Ftags%2Csample-tag&_security=RBAC%2CCONFIDENTIAL&_profile=http%3A%2F%2Fexample.org%2Ffhir%2FStructureDefinition%2Fcustom-profile' \
-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.
String of characters used to identify a name or a 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
An integer with a value that is not negative (e.g. >= 0)
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.
String of characters used to identify a name or a 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
An integer with a value that is not negative (e.g. >= 0)
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.
- Mock server
https://docs.heydonto.com/_mock/apis/fhir/openapi/site/{siteId}/fhir/bundle
- Sandbox
https://api-staging.heydonto.com/site/{siteId}/fhir/bundle
- Production
https://api.heydonto.com/site/{siteId}/fhir/bundle
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://docs.heydonto.com/_mock/apis/fhir/openapi/site/{siteId}/fhir/bundle' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"resourceType": "Bundle",
"id": "bundle-example",
"meta": {
"lastUpdated": "2014-08-18T01:43:30Z"
},
"type": "searchset",
"total": 3,
"link": [
{
"relation": "self",
"url": "https://example.com/base/MedicationRequest?patient=347&_include=MedicationRequest.medication&_count=2"
},
{
"relation": "next",
"url": "https://example.com/base/MedicationRequest?patient=347&searchId=ff15fd40-ff71-4b48-b366-09c706bed9d0&page=2"
}
],
"entry": [
{
"fullUrl": "https://example.com/base/MedicationRequest/3123",
"resource": {
"resourceType": "MedicationRequest",
"id": "3123",
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative with Details</b></p><p><b>id</b>: 3123</p><p><b>status</b>: unknown</p><p><b>intent</b>: order</p><p><b>medication</b>: <a>Medication/example</a></p><p><b>subject</b>: <a>Patient/347</a></p></div>"
},
"status": "unknown",
"intent": "order",
"medicationReference": {
"reference": "Medication/example"
},
"subject": {
"reference": "Patient/347"
}
},
"search": {
"mode": "match",
"score": 1
}
},
{
"fullUrl": "https://example.com/base/Medication/example",
"resource": {
"resourceType": "Medication",
"id": "example",
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative with Details</b></p><p><b>id</b>: example</p></div>"
}
},
"search": {
"mode": "include"
}
}
]
}'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.
String of characters used to identify a name or a 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
An integer with a value that is not negative (e.g. >= 0)
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", "id": "bundle-example", "meta": { "lastUpdated": "2014-08-18T01:43:30Z" }, "type": "searchset", "total": 3, "link": [ { … }, { … } ], "entry": [ { … }, { … } ] }
- Mock server
https://docs.heydonto.com/_mock/apis/fhir/openapi/site/{siteId}/fhir/bundle/{id}
- Sandbox
https://api-staging.heydonto.com/site/{siteId}/fhir/bundle/{id}
- Production
https://api.heydonto.com/site/{siteId}/fhir/bundle/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.heydonto.com/_mock/apis/fhir/openapi/site/{siteId}/fhir/bundle/{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.
String of characters used to identify a name or a 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
An integer with a value that is not negative (e.g. >= 0)
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", "id": "bundle-example", "meta": { "lastUpdated": "2014-08-18T01:43:30Z" }, "type": "searchset", "total": 3, "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.
String of characters used to identify a name or a 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
An integer with a value that is not negative (e.g. >= 0)
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.
- Mock server
https://docs.heydonto.com/_mock/apis/fhir/openapi/site/{siteId}/fhir/bundle/{id}
- Sandbox
https://api-staging.heydonto.com/site/{siteId}/fhir/bundle/{id}
- Production
https://api.heydonto.com/site/{siteId}/fhir/bundle/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://docs.heydonto.com/_mock/apis/fhir/openapi/site/{siteId}/fhir/bundle/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"resourceType": "Bundle",
"id": "bundle-example",
"meta": {
"lastUpdated": "2014-08-18T01:43:30Z"
},
"type": "searchset",
"total": 3,
"link": [
{
"relation": "self",
"url": "https://example.com/base/MedicationRequest?patient=347&_include=MedicationRequest.medication&_count=2"
},
{
"relation": "next",
"url": "https://example.com/base/MedicationRequest?patient=347&searchId=ff15fd40-ff71-4b48-b366-09c706bed9d0&page=2"
}
],
"entry": [
{
"fullUrl": "https://example.com/base/MedicationRequest/3123",
"resource": {
"resourceType": "MedicationRequest",
"id": "3123",
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative with Details</b></p><p><b>id</b>: 3123</p><p><b>status</b>: unknown</p><p><b>intent</b>: order</p><p><b>medication</b>: <a>Medication/example</a></p><p><b>subject</b>: <a>Patient/347</a></p></div>"
},
"status": "unknown",
"intent": "order",
"medicationReference": {
"reference": "Medication/example"
},
"subject": {
"reference": "Patient/347"
}
},
"search": {
"mode": "match",
"score": 1
}
},
{
"fullUrl": "https://example.com/base/Medication/example",
"resource": {
"resourceType": "Medication",
"id": "example",
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative with Details</b></p><p><b>id</b>: example</p></div>"
}
},
"search": {
"mode": "include"
}
}
]
}'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.
String of characters used to identify a name or a 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
An integer with a value that is not negative (e.g. >= 0)
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", "id": "bundle-example", "meta": { "lastUpdated": "2014-08-18T01:43:30Z" }, "type": "searchset", "total": 3, "link": [ { … }, { … } ], "entry": [ { … }, { … } ] }
- Mock server
https://docs.heydonto.com/_mock/apis/fhir/openapi/site/{siteId}/fhir/bundle/{id}
- Sandbox
https://api-staging.heydonto.com/site/{siteId}/fhir/bundle/{id}
- Production
https://api.heydonto.com/site/{siteId}/fhir/bundle/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
'https://docs.heydonto.com/_mock/apis/fhir/openapi/site/{siteId}/fhir/bundle/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'{ "statusText": "OK", "status": 200 }
- Mock server
https://docs.heydonto.com/_mock/apis/fhir/openapi/site/{siteId}/fhir/bundle/{id}/history
- Sandbox
https://api-staging.heydonto.com/site/{siteId}/fhir/bundle/{id}/history
- Production
https://api.heydonto.com/site/{siteId}/fhir/bundle/{id}/history
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.heydonto.com/_mock/apis/fhir/openapi/site/{siteId}/fhir/bundle/{id}/history' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'{ "resourceType": "Bundle", "type": "history", "entry": [ { … } ], "total": 2 }