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/research-study?_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 ResearchStudy 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).
Identifiers assigned to this research study by the sponsor or other systems.
The set of steps expected to be performed as part of the execution of the study.
A larger research study of which this particular study is a component or step.
The current state of the study.
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.
Codes categorizing the type of study such as investigational vs. observational, type of blinding, type of randomization, safety vs. efficacy, etc.
The medication(s), food(s), therapy(ies), device(s) or other concerns or interventions that the study is seeking to gain more information about.
The condition that is the focus of the study. For example, In a study to examine risk factors for Lupus, might have as an inclusion criterion "healthy volunteer", but the target condition code would be a Lupus SNOMED code.
Contact details to assist a user in learning more about or engaging with the study.
Indicates a country, state or other region where the study is taking place.
A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine
Reference to a Group that defines the criteria for and quantity of subjects participating in the study. E.g. " 200 female Europeans between the ages of 20 and 45 with early onset diabetes".
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
Comments made about the study by the performer, subject or other participants.
Describes an expected sequence of events for one of the participants of a study. E.g. Exposure to drug A, wash-out, exposure to drug B, wash-out, follow-up.
curl -i -X POST \ https://docs.heydonto.com/_mock/apis/fhir/openapi/fhir/research-study \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'Content-Type: application/json' \ -d '{ "resourceType": "ResearchStudy", "id": "example", "text": { "status": "generated", "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">[Put rendering here]</div>" }, "status": "completed" }'
This is a ResearchStudy 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).
Identifiers assigned to this research study by the sponsor or other systems.
The set of steps expected to be performed as part of the execution of the study.
A larger research study of which this particular study is a component or step.
The current state of the study.
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.
Codes categorizing the type of study such as investigational vs. observational, type of blinding, type of randomization, safety vs. efficacy, etc.
The medication(s), food(s), therapy(ies), device(s) or other concerns or interventions that the study is seeking to gain more information about.
The condition that is the focus of the study. For example, In a study to examine risk factors for Lupus, might have as an inclusion criterion "healthy volunteer", but the target condition code would be a Lupus SNOMED code.
Contact details to assist a user in learning more about or engaging with the study.
Indicates a country, state or other region where the study is taking place.
A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine
Reference to a Group that defines the criteria for and quantity of subjects participating in the study. E.g. " 200 female Europeans between the ages of 20 and 45 with early onset diabetes".
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
Comments made about the study by the performer, subject or other participants.
Describes an expected sequence of events for one of the participants of a study. E.g. Exposure to drug A, wash-out, exposure to drug B, wash-out, follow-up.
{ "resourceType": "ResearchStudy", "id": "example", "text": { "status": "generated", "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">[Put rendering here]</div>" }, "status": "completed" }
curl -i -X GET \ 'https://docs.heydonto.com/_mock/apis/fhir/openapi/fhir/research-study/{id}' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>'
This is a ResearchStudy 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).
Identifiers assigned to this research study by the sponsor or other systems.
The set of steps expected to be performed as part of the execution of the study.
A larger research study of which this particular study is a component or step.
The current state of the study.
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.
Codes categorizing the type of study such as investigational vs. observational, type of blinding, type of randomization, safety vs. efficacy, etc.
The medication(s), food(s), therapy(ies), device(s) or other concerns or interventions that the study is seeking to gain more information about.
The condition that is the focus of the study. For example, In a study to examine risk factors for Lupus, might have as an inclusion criterion "healthy volunteer", but the target condition code would be a Lupus SNOMED code.
Contact details to assist a user in learning more about or engaging with the study.
Indicates a country, state or other region where the study is taking place.
A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine
Reference to a Group that defines the criteria for and quantity of subjects participating in the study. E.g. " 200 female Europeans between the ages of 20 and 45 with early onset diabetes".
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
Comments made about the study by the performer, subject or other participants.
Describes an expected sequence of events for one of the participants of a study. E.g. Exposure to drug A, wash-out, exposure to drug B, wash-out, follow-up.
{ "resourceType": "ResearchStudy", "id": "example", "text": { "status": "generated", "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">[Put rendering here]</div>" }, "status": "completed" }
This is a ResearchStudy 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).
Identifiers assigned to this research study by the sponsor or other systems.
The set of steps expected to be performed as part of the execution of the study.
A larger research study of which this particular study is a component or step.
The current state of the study.
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.
Codes categorizing the type of study such as investigational vs. observational, type of blinding, type of randomization, safety vs. efficacy, etc.
The medication(s), food(s), therapy(ies), device(s) or other concerns or interventions that the study is seeking to gain more information about.
The condition that is the focus of the study. For example, In a study to examine risk factors for Lupus, might have as an inclusion criterion "healthy volunteer", but the target condition code would be a Lupus SNOMED code.
Contact details to assist a user in learning more about or engaging with the study.
Indicates a country, state or other region where the study is taking place.
A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine
Reference to a Group that defines the criteria for and quantity of subjects participating in the study. E.g. " 200 female Europeans between the ages of 20 and 45 with early onset diabetes".
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
Comments made about the study by the performer, subject or other participants.
Describes an expected sequence of events for one of the participants of a study. E.g. Exposure to drug A, wash-out, exposure to drug B, wash-out, follow-up.
curl -i -X PUT \ 'https://docs.heydonto.com/_mock/apis/fhir/openapi/fhir/research-study/{id}' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'Content-Type: application/json' \ -d '{ "resourceType": "ResearchStudy", "id": "example", "text": { "status": "generated", "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">[Put rendering here]</div>" }, "status": "completed" }'
This is a ResearchStudy 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).
Identifiers assigned to this research study by the sponsor or other systems.
The set of steps expected to be performed as part of the execution of the study.
A larger research study of which this particular study is a component or step.
The current state of the study.
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.
Codes categorizing the type of study such as investigational vs. observational, type of blinding, type of randomization, safety vs. efficacy, etc.
The medication(s), food(s), therapy(ies), device(s) or other concerns or interventions that the study is seeking to gain more information about.
The condition that is the focus of the study. For example, In a study to examine risk factors for Lupus, might have as an inclusion criterion "healthy volunteer", but the target condition code would be a Lupus SNOMED code.
Contact details to assist a user in learning more about or engaging with the study.
Indicates a country, state or other region where the study is taking place.
A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine
Reference to a Group that defines the criteria for and quantity of subjects participating in the study. E.g. " 200 female Europeans between the ages of 20 and 45 with early onset diabetes".
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
Comments made about the study by the performer, subject or other participants.
Describes an expected sequence of events for one of the participants of a study. E.g. Exposure to drug A, wash-out, exposure to drug B, wash-out, follow-up.
{ "resourceType": "ResearchStudy", "id": "example", "text": { "status": "generated", "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">[Put rendering here]</div>" }, "status": "completed" }
curl -i -X DELETE \ 'https://docs.heydonto.com/_mock/apis/fhir/openapi/fhir/research-study/{id}' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>'
{ "statusText": "OK", "status": 200 }
curl -i -X GET \ 'https://docs.heydonto.com/_mock/apis/fhir/openapi/fhir/research-study/{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 }