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/communication?_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": [ { … } ] }
This is a Communication resource
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 communication by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Communication.
The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Communication.
An order, proposal or plan fulfilled in whole or in part by this Communication.
Part of this action.
Prior communication that this communication is in response to.
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 concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
The type of message conveyed such as alert, notification, reminder, instruction, etc.
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 channel that was used for this communication (e.g. email, fax).
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
Other resources that pertain to this communication and to which this communication should be associated.
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 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.
The entity (e.g. person, organization, clinical information system, care team or device) which was the target of the communication. If receipts need to be tracked by an individual, a separate resource instance will need to be created for each recipient. Multiple recipient communications are intended where either receipts are not tracked (e.g. a mass mail-out) or a receipt is captured in aggregate (all emails confirmed received by a particular time).
Indicates another resource whose existence justifies this communication.
Text, attachment(s), or resource(s) that was communicated to the recipient.
curl -i -X POST \ https://docs.heydonto.com/_mock/apis/fhir/openapi/fhir/communication \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'Content-Type: application/json' \ -d '{ "resourceType": "Communication", "id": "example", "text": { "status": "generated", "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Patient has very high serum potassium</div>" }, "identifier": [ { "type": { "text": "Paging System" }, "system": "urn:oid:1.3.4.5.6.7", "value": "2345678901" } ], "instantiatesUri": [ "http://example.org/hyperkalemia" ], "partOf": [ { "display": "Serum Potassium Observation" } ], "status": "completed", "category": [ { "coding": [ { "system": "http://acme.org/messagetypes", "code": "Alert" } ], "text": "Alert" } ], "medium": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationMode", "code": "WRITTEN", "display": "written" } ], "text": "written" } ], "subject": { "reference": "Patient/example" }, "encounter": { "reference": "Encounter/example" }, "sent": "2014-12-12T18:01:10-08:00", "received": "2014-12-12T18:01:11-08:00", "recipient": [ { "reference": "Practitioner/example" } ], "sender": { "reference": "Device/f001" }, "payload": [ { "contentString": "Patient 1 has a very high serum potassium value (7.2 mmol/L on 2014-Dec-12 at 5:55 pm)" }, { "contentReference": { "display": "Serum Potassium Observation" } } ] }'
This is a Communication resource
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 communication by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Communication.
The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Communication.
An order, proposal or plan fulfilled in whole or in part by this Communication.
Part of this action.
Prior communication that this communication is in response to.
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 concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
The type of message conveyed such as alert, notification, reminder, instruction, etc.
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 channel that was used for this communication (e.g. email, fax).
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
Other resources that pertain to this communication and to which this communication should be associated.
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 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.
The entity (e.g. person, organization, clinical information system, care team or device) which was the target of the communication. If receipts need to be tracked by an individual, a separate resource instance will need to be created for each recipient. Multiple recipient communications are intended where either receipts are not tracked (e.g. a mass mail-out) or a receipt is captured in aggregate (all emails confirmed received by a particular time).
Indicates another resource whose existence justifies this communication.
Text, attachment(s), or resource(s) that was communicated to the recipient.
{ "resourceType": "Communication", "id": "example", "text": { "status": "generated", "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Patient has very high serum potassium</div>" }, "identifier": [ { … } ], "instantiatesUri": [ "http://example.org/hyperkalemia" ], "partOf": [ { … } ], "status": "completed", "category": [ { … } ], "medium": [ { … } ], "subject": { "reference": "Patient/example" }, "encounter": { "reference": "Encounter/example" }, "sent": "2014-12-12T18:01:10-08:00", "received": "2014-12-12T18:01:11-08:00", "recipient": [ { … } ], "sender": { "reference": "Device/f001" }, "payload": [ { … }, { … } ] }
curl -i -X GET \ 'https://docs.heydonto.com/_mock/apis/fhir/openapi/fhir/communication/{id}' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>'
This is a Communication resource
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 communication by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Communication.
The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Communication.
An order, proposal or plan fulfilled in whole or in part by this Communication.
Part of this action.
Prior communication that this communication is in response to.
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 concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
The type of message conveyed such as alert, notification, reminder, instruction, etc.
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 channel that was used for this communication (e.g. email, fax).
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
Other resources that pertain to this communication and to which this communication should be associated.
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 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.
The entity (e.g. person, organization, clinical information system, care team or device) which was the target of the communication. If receipts need to be tracked by an individual, a separate resource instance will need to be created for each recipient. Multiple recipient communications are intended where either receipts are not tracked (e.g. a mass mail-out) or a receipt is captured in aggregate (all emails confirmed received by a particular time).
Indicates another resource whose existence justifies this communication.
Text, attachment(s), or resource(s) that was communicated to the recipient.
{ "resourceType": "Communication", "id": "example", "text": { "status": "generated", "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Patient has very high serum potassium</div>" }, "identifier": [ { … } ], "instantiatesUri": [ "http://example.org/hyperkalemia" ], "partOf": [ { … } ], "status": "completed", "category": [ { … } ], "medium": [ { … } ], "subject": { "reference": "Patient/example" }, "encounter": { "reference": "Encounter/example" }, "sent": "2014-12-12T18:01:10-08:00", "received": "2014-12-12T18:01:11-08:00", "recipient": [ { … } ], "sender": { "reference": "Device/f001" }, "payload": [ { … }, { … } ] }
This is a Communication resource
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 communication by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Communication.
The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Communication.
An order, proposal or plan fulfilled in whole or in part by this Communication.
Part of this action.
Prior communication that this communication is in response to.
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 concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
The type of message conveyed such as alert, notification, reminder, instruction, etc.
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 channel that was used for this communication (e.g. email, fax).
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
Other resources that pertain to this communication and to which this communication should be associated.
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 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.
The entity (e.g. person, organization, clinical information system, care team or device) which was the target of the communication. If receipts need to be tracked by an individual, a separate resource instance will need to be created for each recipient. Multiple recipient communications are intended where either receipts are not tracked (e.g. a mass mail-out) or a receipt is captured in aggregate (all emails confirmed received by a particular time).
Indicates another resource whose existence justifies this communication.
Text, attachment(s), or resource(s) that was communicated to the recipient.
curl -i -X PUT \ 'https://docs.heydonto.com/_mock/apis/fhir/openapi/fhir/communication/{id}' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'Content-Type: application/json' \ -d '{ "resourceType": "Communication", "id": "example", "text": { "status": "generated", "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Patient has very high serum potassium</div>" }, "identifier": [ { "type": { "text": "Paging System" }, "system": "urn:oid:1.3.4.5.6.7", "value": "2345678901" } ], "instantiatesUri": [ "http://example.org/hyperkalemia" ], "partOf": [ { "display": "Serum Potassium Observation" } ], "status": "completed", "category": [ { "coding": [ { "system": "http://acme.org/messagetypes", "code": "Alert" } ], "text": "Alert" } ], "medium": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationMode", "code": "WRITTEN", "display": "written" } ], "text": "written" } ], "subject": { "reference": "Patient/example" }, "encounter": { "reference": "Encounter/example" }, "sent": "2014-12-12T18:01:10-08:00", "received": "2014-12-12T18:01:11-08:00", "recipient": [ { "reference": "Practitioner/example" } ], "sender": { "reference": "Device/f001" }, "payload": [ { "contentString": "Patient 1 has a very high serum potassium value (7.2 mmol/L on 2014-Dec-12 at 5:55 pm)" }, { "contentReference": { "display": "Serum Potassium Observation" } } ] }'
This is a Communication resource
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 communication by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Communication.
The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Communication.
An order, proposal or plan fulfilled in whole or in part by this Communication.
Part of this action.
Prior communication that this communication is in response to.
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 concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
The type of message conveyed such as alert, notification, reminder, instruction, etc.
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 channel that was used for this communication (e.g. email, fax).
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
Other resources that pertain to this communication and to which this communication should be associated.
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 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.
The entity (e.g. person, organization, clinical information system, care team or device) which was the target of the communication. If receipts need to be tracked by an individual, a separate resource instance will need to be created for each recipient. Multiple recipient communications are intended where either receipts are not tracked (e.g. a mass mail-out) or a receipt is captured in aggregate (all emails confirmed received by a particular time).
Indicates another resource whose existence justifies this communication.
Text, attachment(s), or resource(s) that was communicated to the recipient.
{ "resourceType": "Communication", "id": "example", "text": { "status": "generated", "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Patient has very high serum potassium</div>" }, "identifier": [ { … } ], "instantiatesUri": [ "http://example.org/hyperkalemia" ], "partOf": [ { … } ], "status": "completed", "category": [ { … } ], "medium": [ { … } ], "subject": { "reference": "Patient/example" }, "encounter": { "reference": "Encounter/example" }, "sent": "2014-12-12T18:01:10-08:00", "received": "2014-12-12T18:01:11-08:00", "recipient": [ { … } ], "sender": { "reference": "Device/f001" }, "payload": [ { … }, { … } ] }
curl -i -X DELETE \ 'https://docs.heydonto.com/_mock/apis/fhir/openapi/fhir/communication/{id}' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>'
{ "statusText": "OK", "status": 200 }
curl -i -X GET \ 'https://docs.heydonto.com/_mock/apis/fhir/openapi/fhir/communication/{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 }