API documentation for HeyDonto API users
URL https://heydonto.com
HeyDonto services@heydonto.com
curl -i -X GET \ 'https://docs.heydonto.com/_mock/apis/fhir/openapi/fhir/goal?_count=0&_page_token=string' \ -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).
Business identifiers assigned to this goal by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
The state of the goal throughout its lifecycle.
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
Indicates a category the goal falls within.
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
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 to a code defined by a terminology system.
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.
The date or event after which the goal should begin being pursued.
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
Indicates what should be done by when.
A date or partial date (e.g. just year or year + month). There is no time zone. The format is a union of the schema types gYear, gYearMonth and date. Dates SHALL be valid dates.
The identified conditions and other health record elements that are intended to be addressed by the goal.
Identifies the change (or lack of change) at the point when the status of the goal is assessed.
curl -i -X POST \ https://docs.heydonto.com/_mock/apis/fhir/openapi/fhir/goal \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'Content-Type: application/json' \ -d '{ "resourceType": "Goal", "id": "example", "text": { "status": "additional", "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n\t\t\t<p> A simple care goal for a patient to lose weight due to obesity.</p>\n\t\t</div>" }, "identifier": [ { "value": "123" } ], "lifecycleStatus": "on-hold", "category": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/goal-category", "code": "dietary" } ] } ], "priority": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/goal-priority", "code": "high-priority", "display": "High Priority" } ], "text": "high" }, "description": { "text": "Target weight is 160 to 180 lbs." }, "subject": { "reference": "Patient/example", "display": "Peter James Chalmers" }, "startDate": "2015-04-05", "target": [ { "measure": { "coding": [ { "system": "http://loinc.org", "code": "3141-9", "display": "Weight Measured" } ] }, "detailRange": { "low": { "value": 160, "unit": "lbs", "system": "http://unitsofmeasure.org", "code": "[lb_av]" }, "high": { "value": 180, "unit": "lbs", "system": "http://unitsofmeasure.org", "code": "[lb_av]" } }, "dueDate": "2016-04-05" } ], "statusDate": "2016-02-14", "statusReason": "Patient wants to defer weight loss until after honeymoon.", "expressedBy": { "reference": "Patient/example", "display": "Peter James Chalmers" }, "addresses": [ { "display": "obesity condition" } ], "outcomeReference": [ { "reference": "Observation/example", "display": "Body Weight Measured" } ] }'
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).
Business identifiers assigned to this goal by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
The state of the goal throughout its lifecycle.
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
Indicates a category the goal falls within.
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
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 to a code defined by a terminology system.
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.
The date or event after which the goal should begin being pursued.
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
Indicates what should be done by when.
A date or partial date (e.g. just year or year + month). There is no time zone. The format is a union of the schema types gYear, gYearMonth and date. Dates SHALL be valid dates.
The identified conditions and other health record elements that are intended to be addressed by the goal.
Identifies the change (or lack of change) at the point when the status of the goal is assessed.
{ "resourceType": "Goal", "id": "example", "text": { "status": "additional", "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n\t\t\t<p> A simple care goal for a patient to lose weight due to obesity.</p>\n\t\t</div>" }, "identifier": [ { … } ], "lifecycleStatus": "on-hold", "category": [ { … } ], "priority": { "coding": [ … ], "text": "high" }, "description": { "text": "Target weight is 160 to 180 lbs." }, "subject": { "reference": "Patient/example", "display": "Peter James Chalmers" }, "startDate": "2015-04-05", "target": [ { … } ], "statusDate": "2016-02-14", "statusReason": "Patient wants to defer weight loss until after honeymoon.", "expressedBy": { "reference": "Patient/example", "display": "Peter James Chalmers" }, "addresses": [ { … } ], "outcomeReference": [ { … } ] }
curl -i -X GET \ 'https://docs.heydonto.com/_mock/apis/fhir/openapi/fhir/goal/{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).
Business identifiers assigned to this goal by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
The state of the goal throughout its lifecycle.
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
Indicates a category the goal falls within.
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
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 to a code defined by a terminology system.
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.
The date or event after which the goal should begin being pursued.
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
Indicates what should be done by when.
A date or partial date (e.g. just year or year + month). There is no time zone. The format is a union of the schema types gYear, gYearMonth and date. Dates SHALL be valid dates.
The identified conditions and other health record elements that are intended to be addressed by the goal.
Identifies the change (or lack of change) at the point when the status of the goal is assessed.
{ "resourceType": "Goal", "id": "example", "text": { "status": "additional", "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n\t\t\t<p> A simple care goal for a patient to lose weight due to obesity.</p>\n\t\t</div>" }, "identifier": [ { … } ], "lifecycleStatus": "on-hold", "category": [ { … } ], "priority": { "coding": [ … ], "text": "high" }, "description": { "text": "Target weight is 160 to 180 lbs." }, "subject": { "reference": "Patient/example", "display": "Peter James Chalmers" }, "startDate": "2015-04-05", "target": [ { … } ], "statusDate": "2016-02-14", "statusReason": "Patient wants to defer weight loss until after honeymoon.", "expressedBy": { "reference": "Patient/example", "display": "Peter James Chalmers" }, "addresses": [ { … } ], "outcomeReference": [ { … } ] }
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).
Business identifiers assigned to this goal by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
The state of the goal throughout its lifecycle.
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
Indicates a category the goal falls within.
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
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 to a code defined by a terminology system.
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.
The date or event after which the goal should begin being pursued.
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
Indicates what should be done by when.
A date or partial date (e.g. just year or year + month). There is no time zone. The format is a union of the schema types gYear, gYearMonth and date. Dates SHALL be valid dates.
The identified conditions and other health record elements that are intended to be addressed by the goal.
Identifies the change (or lack of change) at the point when the status of the goal is assessed.
curl -i -X PUT \ 'https://docs.heydonto.com/_mock/apis/fhir/openapi/fhir/goal/{id}' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'Content-Type: application/json' \ -d '{ "resourceType": "Goal", "id": "example", "text": { "status": "additional", "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n\t\t\t<p> A simple care goal for a patient to lose weight due to obesity.</p>\n\t\t</div>" }, "identifier": [ { "value": "123" } ], "lifecycleStatus": "on-hold", "category": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/goal-category", "code": "dietary" } ] } ], "priority": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/goal-priority", "code": "high-priority", "display": "High Priority" } ], "text": "high" }, "description": { "text": "Target weight is 160 to 180 lbs." }, "subject": { "reference": "Patient/example", "display": "Peter James Chalmers" }, "startDate": "2015-04-05", "target": [ { "measure": { "coding": [ { "system": "http://loinc.org", "code": "3141-9", "display": "Weight Measured" } ] }, "detailRange": { "low": { "value": 160, "unit": "lbs", "system": "http://unitsofmeasure.org", "code": "[lb_av]" }, "high": { "value": 180, "unit": "lbs", "system": "http://unitsofmeasure.org", "code": "[lb_av]" } }, "dueDate": "2016-04-05" } ], "statusDate": "2016-02-14", "statusReason": "Patient wants to defer weight loss until after honeymoon.", "expressedBy": { "reference": "Patient/example", "display": "Peter James Chalmers" }, "addresses": [ { "display": "obesity condition" } ], "outcomeReference": [ { "reference": "Observation/example", "display": "Body Weight Measured" } ] }'
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).
Business identifiers assigned to this goal by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
The state of the goal throughout its lifecycle.
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
Indicates a category the goal falls within.
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
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 to a code defined by a terminology system.
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.
The date or event after which the goal should begin being pursued.
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
Indicates what should be done by when.
A date or partial date (e.g. just year or year + month). There is no time zone. The format is a union of the schema types gYear, gYearMonth and date. Dates SHALL be valid dates.
The identified conditions and other health record elements that are intended to be addressed by the goal.
Identifies the change (or lack of change) at the point when the status of the goal is assessed.
{ "resourceType": "Goal", "id": "example", "text": { "status": "additional", "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n\t\t\t<p> A simple care goal for a patient to lose weight due to obesity.</p>\n\t\t</div>" }, "identifier": [ { … } ], "lifecycleStatus": "on-hold", "category": [ { … } ], "priority": { "coding": [ … ], "text": "high" }, "description": { "text": "Target weight is 160 to 180 lbs." }, "subject": { "reference": "Patient/example", "display": "Peter James Chalmers" }, "startDate": "2015-04-05", "target": [ { … } ], "statusDate": "2016-02-14", "statusReason": "Patient wants to defer weight loss until after honeymoon.", "expressedBy": { "reference": "Patient/example", "display": "Peter James Chalmers" }, "addresses": [ { … } ], "outcomeReference": [ { … } ] }
curl -i -X DELETE \ 'https://docs.heydonto.com/_mock/apis/fhir/openapi/fhir/goal/{id}' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>'
{ "statusText": "OK", "status": 200 }
curl -i -X GET \ 'https://docs.heydonto.com/_mock/apis/fhir/openapi/fhir/goal/{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 }