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 resource date, e.g. date=ge2024-01-01. date=ge2025-01-20&date=le2025-01-29
Filter by resource telecom, e.g. date=[SYSTEM]|[VALUE].
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/charge-item?_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&date=string&identifier=http%3A%2F%2Fhospital.org%2C12345&name%3Acontains=lic&name%3Aexact=Alice&patient.name=Alice&telecom=telecom%3Dphone%2C555-555-5555' \
-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 assigned to this event performer or other systems.
References the (external) source of pricing information, rules of application for the code this ChargeItem uses.
References the source of pricing information, rules of application for the code this ChargeItem uses.
The current state of the ChargeItem.
ChargeItems can be grouped to larger ChargeItems covering the whole set.
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
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 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.
Date/time(s) or duration when the charged service was applied.
Specifies an event that may occur multiple times. Timing schedules are used to record when things are planned, expected or requested to occur. The most common usage is in dosage instructions for medications. They are also used when planning care of various kinds, and may be used for reporting the schedule to which past regular activities were carried out.
Indicates who or what performed or participated in the charged service.
A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.
The anatomical location where the related service has been applied.
A rational number with implicit precision