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/location?_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).
Unique code or number identifying the location to its users.
The status property covers the general availability of the resource, not the current value which may be covered by the operationStatus, or by a schedule/slots if they are configured for the location.
A list of alternate names that the location is known as, or was known as, in the past.
Indicates whether a resource instance represents a specific location or a class of locations.
The contact details of communication devices available at the location. This can include phone numbers, fax numbers, mobile numbers, email addresses and web sites.
An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world.
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated.
What days/times during a week is this location usually open.
curl -i -X POST \
'https://docs.heydonto.com/_mock/apis/fhir/openapi/site/{siteId}/fhir/location' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"resourceType": "Location",
"id": "1",
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Burgers UMC, South Wing, second floor</div>"
},
"identifier": [
{
"value": "B1-S.F2"
}
],
"status": "active",
"name": "South Wing, second floor",
"alias": [
"BU MC, SW, F2",
"Burgers University Medical Center, South Wing, second floor"
],
"description": "Second floor of the Old South Wing, formerly in use by Psychiatry",
"mode": "instance",
"telecom": [
{
"system": "phone",
"value": "2328",
"use": "work"
},
{
"system": "fax",
"value": "2329",
"use": "work"
},
{
"system": "email",
"value": "second wing admissions"
},
{
"system": "url",
"value": "http://sampleorg.com/southwing",
"use": "work"
}
],
"address": {
"use": "work",
"line": [
"Galapagosweg 91, Building A"
],
"city": "Den Burg",
"postalCode": "9105 PZ",
"country": "NLD"
},
"physicalType": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/location-physical-type",
"code": "wi",
"display": "Wing"
}
]
},
"position": {
"longitude": -83.6945691,
"latitude": 42.25475478,
"altitude": 0
},
"managingOrganization": {
"reference": "Organization/f001"
},
"endpoint": [
{
"reference": "Endpoint/example"
}
]
}'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).
Unique code or number identifying the location to its users.
The status property covers the general availability of the resource, not the current value which may be covered by the operationStatus, or by a schedule/slots if they are configured for the location.
A list of alternate names that the location is known as, or was known as, in the past.
Indicates whether a resource instance represents a specific location or a class of locations.
The contact details of communication devices available at the location. This can include phone numbers, fax numbers, mobile numbers, email addresses and web sites.
An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world.
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated.
What days/times during a week is this location usually open.
{ "resourceType": "Location", "id": "1", "text": { "status": "generated", "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Burgers UMC, South Wing, second floor</div>" }, "identifier": [ { … } ], "status": "active", "name": "South Wing, second floor", "alias": [ "BU MC, SW, F2", "Burgers University Medical Center, South Wing, second floor" ], "description": "Second floor of the Old South Wing, formerly in use by Psychiatry", "mode": "instance", "telecom": [ { … }, { … }, { … }, { … } ], "address": { "use": "work", "line": [ … ], "city": "Den Burg", "postalCode": "9105 PZ", "country": "NLD" }, "physicalType": { "coding": [ … ] }, "position": { "longitude": -83.6945691, "latitude": 42.25475478, "altitude": 0 }, "managingOrganization": { "reference": "Organization/f001" }, "endpoint": [ { … } ] }
curl -i -X GET \
'https://docs.heydonto.com/_mock/apis/fhir/openapi/site/{siteId}/fhir/location/{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).
Unique code or number identifying the location to its users.
The status property covers the general availability of the resource, not the current value which may be covered by the operationStatus, or by a schedule/slots if they are configured for the location.
A list of alternate names that the location is known as, or was known as, in the past.
Indicates whether a resource instance represents a specific location or a class of locations.
The contact details of communication devices available at the location. This can include phone numbers, fax numbers, mobile numbers, email addresses and web sites.
An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world.
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated.
What days/times during a week is this location usually open.
{ "resourceType": "Location", "id": "1", "text": { "status": "generated", "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Burgers UMC, South Wing, second floor</div>" }, "identifier": [ { … } ], "status": "active", "name": "South Wing, second floor", "alias": [ "BU MC, SW, F2", "Burgers University Medical Center, South Wing, second floor" ], "description": "Second floor of the Old South Wing, formerly in use by Psychiatry", "mode": "instance", "telecom": [ { … }, { … }, { … }, { … } ], "address": { "use": "work", "line": [ … ], "city": "Den Burg", "postalCode": "9105 PZ", "country": "NLD" }, "physicalType": { "coding": [ … ] }, "position": { "longitude": -83.6945691, "latitude": 42.25475478, "altitude": 0 }, "managingOrganization": { "reference": "Organization/f001" }, "endpoint": [ { … } ] }
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).
Unique code or number identifying the location to its users.
The status property covers the general availability of the resource, not the current value which may be covered by the operationStatus, or by a schedule/slots if they are configured for the location.
A list of alternate names that the location is known as, or was known as, in the past.
Indicates whether a resource instance represents a specific location or a class of locations.
The contact details of communication devices available at the location. This can include phone numbers, fax numbers, mobile numbers, email addresses and web sites.
An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world.
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated.
What days/times during a week is this location usually open.
curl -i -X PUT \
'https://docs.heydonto.com/_mock/apis/fhir/openapi/site/{siteId}/fhir/location/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"resourceType": "Location",
"id": "1",
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Burgers UMC, South Wing, second floor</div>"
},
"identifier": [
{
"value": "B1-S.F2"
}
],
"status": "active",
"name": "South Wing, second floor",
"alias": [
"BU MC, SW, F2",
"Burgers University Medical Center, South Wing, second floor"
],
"description": "Second floor of the Old South Wing, formerly in use by Psychiatry",
"mode": "instance",
"telecom": [
{
"system": "phone",
"value": "2328",
"use": "work"
},
{
"system": "fax",
"value": "2329",
"use": "work"
},
{
"system": "email",
"value": "second wing admissions"
},
{
"system": "url",
"value": "http://sampleorg.com/southwing",
"use": "work"
}
],
"address": {
"use": "work",
"line": [
"Galapagosweg 91, Building A"
],
"city": "Den Burg",
"postalCode": "9105 PZ",
"country": "NLD"
},
"physicalType": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/location-physical-type",
"code": "wi",
"display": "Wing"
}
]
},
"position": {
"longitude": -83.6945691,
"latitude": 42.25475478,
"altitude": 0
},
"managingOrganization": {
"reference": "Organization/f001"
},
"endpoint": [
{
"reference": "Endpoint/example"
}
]
}'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).
Unique code or number identifying the location to its users.
The status property covers the general availability of the resource, not the current value which may be covered by the operationStatus, or by a schedule/slots if they are configured for the location.
A list of alternate names that the location is known as, or was known as, in the past.
Indicates whether a resource instance represents a specific location or a class of locations.
The contact details of communication devices available at the location. This can include phone numbers, fax numbers, mobile numbers, email addresses and web sites.
An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world.
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated.
What days/times during a week is this location usually open.
{ "resourceType": "Location", "id": "1", "text": { "status": "generated", "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Burgers UMC, South Wing, second floor</div>" }, "identifier": [ { … } ], "status": "active", "name": "South Wing, second floor", "alias": [ "BU MC, SW, F2", "Burgers University Medical Center, South Wing, second floor" ], "description": "Second floor of the Old South Wing, formerly in use by Psychiatry", "mode": "instance", "telecom": [ { … }, { … }, { … }, { … } ], "address": { "use": "work", "line": [ … ], "city": "Den Burg", "postalCode": "9105 PZ", "country": "NLD" }, "physicalType": { "coding": [ … ] }, "position": { "longitude": -83.6945691, "latitude": 42.25475478, "altitude": 0 }, "managingOrganization": { "reference": "Organization/f001" }, "endpoint": [ { … } ] }
curl -i -X DELETE \
'https://docs.heydonto.com/_mock/apis/fhir/openapi/site/{siteId}/fhir/location/{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/location/{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 }