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/related-person?_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 RelatedPerson 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).
Identifier for a person within a particular scope.
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 nature of the relationship between a patient and the related person.
A name associated with the person.
A contact detail for the person, e.g. a telephone number or an email address.
Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.
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.
Address where the related person can be contacted or visited.
Image of the person.
curl -i -X POST \ https://docs.heydonto.com/_mock/apis/fhir/openapi/fhir/related-person \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'Content-Type: application/json' \ -d '{ "resourceType": "RelatedPerson", "id": "benedicte", "text": { "status": "generated", "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n <table>\n <tbody>\n <tr>\n <td>Name</td>\n <td>Bénédicte du Marché</td>\n </tr>\n <tr>\n <td>Address</td>\n <td>43, Place du Marché Sainte Catherine, 75004 Paris, France</td>\n </tr>\n <tr>\n <td>Contacts</td>\n <td>Phone: +33 (237) 998327</td>\n </tr>\n </tbody>\n </table>\n </div>" }, "identifier": [ { "use": "usual", "type": { "text": "INSEE" }, "system": "urn:oid:1.2.250.1.61", "value": "272117510400399" } ], "active": true, "patient": { "reference": "Patient/example" }, "relationship": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v2-0131", "code": "N" }, { "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode", "code": "WIFE" } ] } ], "name": [ { "family": "du Marché", "_family": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/humanname-own-prefix", "valueString": "VV" } ] }, "given": [ "Bénédicte" ] } ], "telecom": [ { "system": "phone", "value": "+33 (237) 998327" } ], "gender": "female", "address": [ { "line": [ "43, Place du Marché Sainte Catherine" ], "city": "Paris", "postalCode": "75004", "country": "FRA" } ], "photo": [ { "contentType": "image/jpeg", "url": "Binary/f016" } ] }'
This is a RelatedPerson 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).
Identifier for a person within a particular scope.
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 nature of the relationship between a patient and the related person.
A name associated with the person.
A contact detail for the person, e.g. a telephone number or an email address.
Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.
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.
Address where the related person can be contacted or visited.
Image of the person.
{ "resourceType": "RelatedPerson", "id": "benedicte", "text": { "status": "generated", "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n <table>\n <tbody>\n <tr>\n <td>Name</td>\n <td>Bénédicte du Marché</td>\n </tr>\n <tr>\n <td>Address</td>\n <td>43, Place du Marché Sainte Catherine, 75004 Paris, France</td>\n </tr>\n <tr>\n <td>Contacts</td>\n <td>Phone: +33 (237) 998327</td>\n </tr>\n </tbody>\n </table>\n </div>" }, "identifier": [ { … } ], "active": true, "patient": { "reference": "Patient/example" }, "relationship": [ { … } ], "name": [ { … } ], "telecom": [ { … } ], "gender": "female", "address": [ { … } ], "photo": [ { … } ] }
curl -i -X GET \ 'https://docs.heydonto.com/_mock/apis/fhir/openapi/fhir/related-person/{id}' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>'
This is a RelatedPerson 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).
Identifier for a person within a particular scope.
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 nature of the relationship between a patient and the related person.
A name associated with the person.
A contact detail for the person, e.g. a telephone number or an email address.
Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.
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.
Address where the related person can be contacted or visited.
Image of the person.
{ "resourceType": "RelatedPerson", "id": "benedicte", "text": { "status": "generated", "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n <table>\n <tbody>\n <tr>\n <td>Name</td>\n <td>Bénédicte du Marché</td>\n </tr>\n <tr>\n <td>Address</td>\n <td>43, Place du Marché Sainte Catherine, 75004 Paris, France</td>\n </tr>\n <tr>\n <td>Contacts</td>\n <td>Phone: +33 (237) 998327</td>\n </tr>\n </tbody>\n </table>\n </div>" }, "identifier": [ { … } ], "active": true, "patient": { "reference": "Patient/example" }, "relationship": [ { … } ], "name": [ { … } ], "telecom": [ { … } ], "gender": "female", "address": [ { … } ], "photo": [ { … } ] }
This is a RelatedPerson 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).
Identifier for a person within a particular scope.
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 nature of the relationship between a patient and the related person.
A name associated with the person.
A contact detail for the person, e.g. a telephone number or an email address.
Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.
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.
Address where the related person can be contacted or visited.
Image of the person.
curl -i -X PUT \ 'https://docs.heydonto.com/_mock/apis/fhir/openapi/fhir/related-person/{id}' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'Content-Type: application/json' \ -d '{ "resourceType": "RelatedPerson", "id": "benedicte", "text": { "status": "generated", "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n <table>\n <tbody>\n <tr>\n <td>Name</td>\n <td>Bénédicte du Marché</td>\n </tr>\n <tr>\n <td>Address</td>\n <td>43, Place du Marché Sainte Catherine, 75004 Paris, France</td>\n </tr>\n <tr>\n <td>Contacts</td>\n <td>Phone: +33 (237) 998327</td>\n </tr>\n </tbody>\n </table>\n </div>" }, "identifier": [ { "use": "usual", "type": { "text": "INSEE" }, "system": "urn:oid:1.2.250.1.61", "value": "272117510400399" } ], "active": true, "patient": { "reference": "Patient/example" }, "relationship": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v2-0131", "code": "N" }, { "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode", "code": "WIFE" } ] } ], "name": [ { "family": "du Marché", "_family": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/humanname-own-prefix", "valueString": "VV" } ] }, "given": [ "Bénédicte" ] } ], "telecom": [ { "system": "phone", "value": "+33 (237) 998327" } ], "gender": "female", "address": [ { "line": [ "43, Place du Marché Sainte Catherine" ], "city": "Paris", "postalCode": "75004", "country": "FRA" } ], "photo": [ { "contentType": "image/jpeg", "url": "Binary/f016" } ] }'
This is a RelatedPerson 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).
Identifier for a person within a particular scope.
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 nature of the relationship between a patient and the related person.
A name associated with the person.
A contact detail for the person, e.g. a telephone number or an email address.
Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.
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.
Address where the related person can be contacted or visited.
Image of the person.
{ "resourceType": "RelatedPerson", "id": "benedicte", "text": { "status": "generated", "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n <table>\n <tbody>\n <tr>\n <td>Name</td>\n <td>Bénédicte du Marché</td>\n </tr>\n <tr>\n <td>Address</td>\n <td>43, Place du Marché Sainte Catherine, 75004 Paris, France</td>\n </tr>\n <tr>\n <td>Contacts</td>\n <td>Phone: +33 (237) 998327</td>\n </tr>\n </tbody>\n </table>\n </div>" }, "identifier": [ { … } ], "active": true, "patient": { "reference": "Patient/example" }, "relationship": [ { … } ], "name": [ { … } ], "telecom": [ { … } ], "gender": "female", "address": [ { … } ], "photo": [ { … } ] }
curl -i -X DELETE \ 'https://docs.heydonto.com/_mock/apis/fhir/openapi/fhir/related-person/{id}' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>'
{ "statusText": "OK", "status": 200 }
curl -i -X GET \ 'https://docs.heydonto.com/_mock/apis/fhir/openapi/fhir/related-person/{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 }