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/event-definition?_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 EventDefinition 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).
A formal identifier that is used to identify this event definition when it is represented in other formats, or referenced in a specification, model, design or an instance.
The status of this event definition. Enables tracking the life-cycle of the content.
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
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.
Contact details to assist a user in finding and communicating with the publisher.
A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine
The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate event definition instances.
A legal or geographic region in which the event definition is intended to be used.
A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine
A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine
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.
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.
Descriptive topics related to the module. Topics provide a high-level categorization of the module that can be useful for filtering and searching.
An individiual or organization primarily involved in the creation and maintenance of the content.
An individual or organization primarily responsible for internal coherence of the content.
An individual or organization primarily responsible for review of some aspect of the content.
An individual or organization responsible for officially endorsing the content for use in some setting.
Related resources such as additional documentation, justification, or bibliographic references.
The trigger element defines when the event occurs. If more than one trigger condition is specified, the event fires whenever any one of the trigger conditions is met.
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 type of triggering event.
The timing of the event (if this is a periodic trigger).
The timing of the event (if this is a periodic trigger).
The triggering data of the event (if this is a data trigger). If more than one data is requirement is specified, then all the data requirements must be true.
curl -i -X POST \ https://docs.heydonto.com/_mock/apis/fhir/openapi/fhir/event-definition \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'Content-Type: application/json' \ -d '{ "resourceType": "EventDefinition", "id": "example", "text": { "status": "generated", "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n </div>" }, "status": "draft", "purpose": "Monitor all admissions to Emergency", "trigger": [ { "type": "named-event", "name": "monitor-emergency-admissions", "data": [ { "type": "Encounter" } ], "condition": { "description": "Encounter Location = emergency (active/completed encounters, current or previous)", "language": "text/fhirpath", "expression": "(this | %previous).location.where(location = \"Location/emergency\" and status in {\"active\", \"completed\"}).exists()" } } ] }'
This is a EventDefinition 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).
A formal identifier that is used to identify this event definition when it is represented in other formats, or referenced in a specification, model, design or an instance.
The status of this event definition. Enables tracking the life-cycle of the content.
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
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.
Contact details to assist a user in finding and communicating with the publisher.
A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine
The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate event definition instances.
A legal or geographic region in which the event definition is intended to be used.
A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine
A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine
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.
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.
Descriptive topics related to the module. Topics provide a high-level categorization of the module that can be useful for filtering and searching.
An individiual or organization primarily involved in the creation and maintenance of the content.
An individual or organization primarily responsible for internal coherence of the content.
An individual or organization primarily responsible for review of some aspect of the content.
An individual or organization responsible for officially endorsing the content for use in some setting.
Related resources such as additional documentation, justification, or bibliographic references.
The trigger element defines when the event occurs. If more than one trigger condition is specified, the event fires whenever any one of the trigger conditions is met.
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 type of triggering event.
The timing of the event (if this is a periodic trigger).
The timing of the event (if this is a periodic trigger).
The triggering data of the event (if this is a data trigger). If more than one data is requirement is specified, then all the data requirements must be true.
{ "resourceType": "EventDefinition", "id": "example", "text": { "status": "generated", "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n </div>" }, "status": "draft", "purpose": "Monitor all admissions to Emergency", "trigger": [ { … } ] }
curl -i -X GET \ 'https://docs.heydonto.com/_mock/apis/fhir/openapi/fhir/event-definition/{id}' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>'
This is a EventDefinition 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).
A formal identifier that is used to identify this event definition when it is represented in other formats, or referenced in a specification, model, design or an instance.
The status of this event definition. Enables tracking the life-cycle of the content.
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
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.
Contact details to assist a user in finding and communicating with the publisher.
A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine
The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate event definition instances.
A legal or geographic region in which the event definition is intended to be used.
A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine
A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine
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.
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.
Descriptive topics related to the module. Topics provide a high-level categorization of the module that can be useful for filtering and searching.
An individiual or organization primarily involved in the creation and maintenance of the content.
An individual or organization primarily responsible for internal coherence of the content.
An individual or organization primarily responsible for review of some aspect of the content.
An individual or organization responsible for officially endorsing the content for use in some setting.
Related resources such as additional documentation, justification, or bibliographic references.
The trigger element defines when the event occurs. If more than one trigger condition is specified, the event fires whenever any one of the trigger conditions is met.
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 type of triggering event.
The timing of the event (if this is a periodic trigger).
The timing of the event (if this is a periodic trigger).
The triggering data of the event (if this is a data trigger). If more than one data is requirement is specified, then all the data requirements must be true.
{ "resourceType": "EventDefinition", "id": "example", "text": { "status": "generated", "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n </div>" }, "status": "draft", "purpose": "Monitor all admissions to Emergency", "trigger": [ { … } ] }
This is a EventDefinition 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).
A formal identifier that is used to identify this event definition when it is represented in other formats, or referenced in a specification, model, design or an instance.
The status of this event definition. Enables tracking the life-cycle of the content.
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
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.
Contact details to assist a user in finding and communicating with the publisher.
A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine
The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate event definition instances.
A legal or geographic region in which the event definition is intended to be used.
A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine
A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine
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.
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.
Descriptive topics related to the module. Topics provide a high-level categorization of the module that can be useful for filtering and searching.
An individiual or organization primarily involved in the creation and maintenance of the content.
An individual or organization primarily responsible for internal coherence of the content.
An individual or organization primarily responsible for review of some aspect of the content.
An individual or organization responsible for officially endorsing the content for use in some setting.
Related resources such as additional documentation, justification, or bibliographic references.
The trigger element defines when the event occurs. If more than one trigger condition is specified, the event fires whenever any one of the trigger conditions is met.
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 type of triggering event.
The timing of the event (if this is a periodic trigger).
The timing of the event (if this is a periodic trigger).
The triggering data of the event (if this is a data trigger). If more than one data is requirement is specified, then all the data requirements must be true.
curl -i -X PUT \ 'https://docs.heydonto.com/_mock/apis/fhir/openapi/fhir/event-definition/{id}' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'Content-Type: application/json' \ -d '{ "resourceType": "EventDefinition", "id": "example", "text": { "status": "generated", "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n </div>" }, "status": "draft", "purpose": "Monitor all admissions to Emergency", "trigger": [ { "type": "named-event", "name": "monitor-emergency-admissions", "data": [ { "type": "Encounter" } ], "condition": { "description": "Encounter Location = emergency (active/completed encounters, current or previous)", "language": "text/fhirpath", "expression": "(this | %previous).location.where(location = \"Location/emergency\" and status in {\"active\", \"completed\"}).exists()" } } ] }'
This is a EventDefinition 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).
A formal identifier that is used to identify this event definition when it is represented in other formats, or referenced in a specification, model, design or an instance.
The status of this event definition. Enables tracking the life-cycle of the content.
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
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.
Contact details to assist a user in finding and communicating with the publisher.
A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine
The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate event definition instances.
A legal or geographic region in which the event definition is intended to be used.
A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine
A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine
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.
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.
Descriptive topics related to the module. Topics provide a high-level categorization of the module that can be useful for filtering and searching.
An individiual or organization primarily involved in the creation and maintenance of the content.
An individual or organization primarily responsible for internal coherence of the content.
An individual or organization primarily responsible for review of some aspect of the content.
An individual or organization responsible for officially endorsing the content for use in some setting.
Related resources such as additional documentation, justification, or bibliographic references.
The trigger element defines when the event occurs. If more than one trigger condition is specified, the event fires whenever any one of the trigger conditions is met.
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 type of triggering event.
The timing of the event (if this is a periodic trigger).
The timing of the event (if this is a periodic trigger).
The triggering data of the event (if this is a data trigger). If more than one data is requirement is specified, then all the data requirements must be true.
{ "resourceType": "EventDefinition", "id": "example", "text": { "status": "generated", "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n </div>" }, "status": "draft", "purpose": "Monitor all admissions to Emergency", "trigger": [ { … } ] }
curl -i -X DELETE \ 'https://docs.heydonto.com/_mock/apis/fhir/openapi/fhir/event-definition/{id}' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>'
{ "statusText": "OK", "status": 200 }
curl -i -X GET \ 'https://docs.heydonto.com/_mock/apis/fhir/openapi/fhir/event-definition/{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 }