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/care-plan?_count=0&_page_token=string' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.
The metadata about a resource. This is content in the resource that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents
An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.
Indicates the purpose of this bundle - how it is intended to be used.
An instant in time - known at least to the second
A series of links that provide context to this bundle.
An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).
A signature along with supporting context. The signature may be a digital signature that is cryptographic in nature, or some other signature acceptable to the domain. This other signature may be as simple as a graphical image representing a hand-written signature, or a signature ceremony Different signature approaches have different utilities.
{ "resourceType": "Bundle", "type": "searchset", "total": 100, "link": [ { … }, { … }, { … }, { … } ], "entry": [ { … } ] }
Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.
The metadata about a resource. This is content in the resource that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents
A human-readable summary of the resource conveying the essential clinical and business information for the resource.
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Business identifiers assigned to this care plan 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, questionnaire or other definition that is adhered to in whole or in part by this CarePlan.
The URL pointing to an externally maintained protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan.
A care plan that is fulfilled in whole or in part by this care plan.
Completed or terminated care plan whose function is taken by this new care plan.
A larger care plan of which this particular care plan is a component or step.
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 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
Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", "wellness plan", etc.
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.
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.
Identifies the individual(s) or organization who provided the contents of the care plan.
Identifies all people and organizations who are expected to be involved in the care envisioned by this plan.
Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan.
Identifies portions of the patient's record that specifically influenced the formation of the plan. These might include comorbidities, recent procedures, limitations, recent assessments, etc.
Describes the intended objective(s) of carrying out the care plan.
Identifies a planned action to occur as part of the plan. For example, a medication to be used, lab tests to perform, self-monitoring, education, etc.
curl -i -X POST \ https://docs.heydonto.com/_mock/apis/fhir/openapi/fhir/care-plan \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'Content-Type: application/json' \ -d '{ "resourceType": "CarePlan", "id": "example", "text": { "status": "additional", "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n <p> A simple care plan to indicate a patient taking their weight once a day because of obesity.</p>\n </div>" }, "contained": [ { "resourceType": "Condition", "id": "p1", "clinicalStatus": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/condition-clinical", "code": "active" } ] }, "verificationStatus": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/condition-ver-status", "code": "confirmed" } ] }, "code": { "text": "Obesity" }, "subject": { "reference": "Patient/example", "display": "Peter James Chalmers" } } ], "identifier": [ { "value": "12345" } ], "instantiatesUri": [ "http://example.org/protocol-for-obesity" ], "basedOn": [ { "display": "Management of Type 2 Diabetes" } ], "replaces": [ { "display": "Plan from urgent care clinic" } ], "partOf": [ { "display": "Overall wellness plan" } ], "status": "active", "intent": "plan", "category": [ { "text": "Weight management plan" } ], "description": "Manage obesity and weight loss", "subject": { "reference": "Patient/example", "display": "Peter James Chalmers" }, "encounter": { "reference": "Encounter/home" }, "period": { "end": "2017-06-01" }, "created": "2016-01-01", "author": { "reference": "Practitioner/example", "display": "Dr Adam Careful" }, "careTeam": [ { "reference": "CareTeam/example" } ], "addresses": [ { "reference": "#p1", "display": "obesity" } ], "goal": [ { "reference": "Goal/example" } ], "activity": [ { "outcomeCodeableConcept": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "161832001", "display": "Progressive weight loss" } ] } ], "outcomeReference": [ { "reference": "Observation/example", "display": "Weight Measured" } ], "detail": { "code": { "coding": [ { "system": "http://loinc.org", "code": "3141-9", "display": "Weight Measured" }, { "system": "http://snomed.info/sct", "code": "27113001", "display": "Body weight" } ] }, "status": "completed", "statusReason": { "text": "Achieved weight loss to mitigate diabetes risk." }, "doNotPerform": false, "scheduledTiming": { "repeat": { "frequency": 1, "period": 1, "periodUnit": "d" } }, "location": { "display": "Patient'\''s home" }, "performer": [ { "reference": "Patient/example", "display": "Peter James Chalmers" } ] } } ] }'
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 care plan 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, questionnaire or other definition that is adhered to in whole or in part by this CarePlan.
The URL pointing to an externally maintained protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan.
A care plan that is fulfilled in whole or in part by this care plan.
Completed or terminated care plan whose function is taken by this new care plan.
A larger care plan of which this particular care plan is a component or step.
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 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
Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", "wellness plan", etc.
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.
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.
Identifies the individual(s) or organization who provided the contents of the care plan.
Identifies all people and organizations who are expected to be involved in the care envisioned by this plan.
Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan.
Identifies portions of the patient's record that specifically influenced the formation of the plan. These might include comorbidities, recent procedures, limitations, recent assessments, etc.
Describes the intended objective(s) of carrying out the care plan.
Identifies a planned action to occur as part of the plan. For example, a medication to be used, lab tests to perform, self-monitoring, education, etc.
{ "resourceType": "CarePlan", "id": "example", "text": { "status": "additional", "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n <p> A simple care plan to indicate a patient taking their weight once a day because of obesity.</p>\n </div>" }, "contained": [ { … } ], "identifier": [ { … } ], "instantiatesUri": [ "http://example.org/protocol-for-obesity" ], "basedOn": [ { … } ], "replaces": [ { … } ], "partOf": [ { … } ], "status": "active", "intent": "plan", "category": [ { … } ], "description": "Manage obesity and weight loss", "subject": { "reference": "Patient/example", "display": "Peter James Chalmers" }, "encounter": { "reference": "Encounter/home" }, "period": { "end": "2017-06-01" }, "created": "2016-01-01", "author": { "reference": "Practitioner/example", "display": "Dr Adam Careful" }, "careTeam": [ { … } ], "addresses": [ { … } ], "goal": [ { … } ], "activity": [ { … } ] }
curl -i -X GET \ 'https://docs.heydonto.com/_mock/apis/fhir/openapi/fhir/care-plan/{id}' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.
The metadata about a resource. This is content in the resource that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents
A human-readable summary of the resource conveying the essential clinical and business information for the resource.
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Business identifiers assigned to this care plan 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, questionnaire or other definition that is adhered to in whole or in part by this CarePlan.
The URL pointing to an externally maintained protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan.
A care plan that is fulfilled in whole or in part by this care plan.
Completed or terminated care plan whose function is taken by this new care plan.
A larger care plan of which this particular care plan is a component or step.
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 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
Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", "wellness plan", etc.
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.
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.
Identifies the individual(s) or organization who provided the contents of the care plan.
Identifies all people and organizations who are expected to be involved in the care envisioned by this plan.
Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan.
Identifies portions of the patient's record that specifically influenced the formation of the plan. These might include comorbidities, recent procedures, limitations, recent assessments, etc.
Describes the intended objective(s) of carrying out the care plan.
Identifies a planned action to occur as part of the plan. For example, a medication to be used, lab tests to perform, self-monitoring, education, etc.
{ "resourceType": "CarePlan", "id": "example", "text": { "status": "additional", "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n <p> A simple care plan to indicate a patient taking their weight once a day because of obesity.</p>\n </div>" }, "contained": [ { … } ], "identifier": [ { … } ], "instantiatesUri": [ "http://example.org/protocol-for-obesity" ], "basedOn": [ { … } ], "replaces": [ { … } ], "partOf": [ { … } ], "status": "active", "intent": "plan", "category": [ { … } ], "description": "Manage obesity and weight loss", "subject": { "reference": "Patient/example", "display": "Peter James Chalmers" }, "encounter": { "reference": "Encounter/home" }, "period": { "end": "2017-06-01" }, "created": "2016-01-01", "author": { "reference": "Practitioner/example", "display": "Dr Adam Careful" }, "careTeam": [ { … } ], "addresses": [ { … } ], "goal": [ { … } ], "activity": [ { … } ] }
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 care plan 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, questionnaire or other definition that is adhered to in whole or in part by this CarePlan.
The URL pointing to an externally maintained protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan.
A care plan that is fulfilled in whole or in part by this care plan.
Completed or terminated care plan whose function is taken by this new care plan.
A larger care plan of which this particular care plan is a component or step.
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 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
Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", "wellness plan", etc.
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.
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.
Identifies the individual(s) or organization who provided the contents of the care plan.
Identifies all people and organizations who are expected to be involved in the care envisioned by this plan.
Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan.
Identifies portions of the patient's record that specifically influenced the formation of the plan. These might include comorbidities, recent procedures, limitations, recent assessments, etc.
Describes the intended objective(s) of carrying out the care plan.
Identifies a planned action to occur as part of the plan. For example, a medication to be used, lab tests to perform, self-monitoring, education, etc.
curl -i -X PUT \ 'https://docs.heydonto.com/_mock/apis/fhir/openapi/fhir/care-plan/{id}' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'Content-Type: application/json' \ -d '{ "resourceType": "CarePlan", "id": "example", "text": { "status": "additional", "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n <p> A simple care plan to indicate a patient taking their weight once a day because of obesity.</p>\n </div>" }, "contained": [ { "resourceType": "Condition", "id": "p1", "clinicalStatus": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/condition-clinical", "code": "active" } ] }, "verificationStatus": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/condition-ver-status", "code": "confirmed" } ] }, "code": { "text": "Obesity" }, "subject": { "reference": "Patient/example", "display": "Peter James Chalmers" } } ], "identifier": [ { "value": "12345" } ], "instantiatesUri": [ "http://example.org/protocol-for-obesity" ], "basedOn": [ { "display": "Management of Type 2 Diabetes" } ], "replaces": [ { "display": "Plan from urgent care clinic" } ], "partOf": [ { "display": "Overall wellness plan" } ], "status": "active", "intent": "plan", "category": [ { "text": "Weight management plan" } ], "description": "Manage obesity and weight loss", "subject": { "reference": "Patient/example", "display": "Peter James Chalmers" }, "encounter": { "reference": "Encounter/home" }, "period": { "end": "2017-06-01" }, "created": "2016-01-01", "author": { "reference": "Practitioner/example", "display": "Dr Adam Careful" }, "careTeam": [ { "reference": "CareTeam/example" } ], "addresses": [ { "reference": "#p1", "display": "obesity" } ], "goal": [ { "reference": "Goal/example" } ], "activity": [ { "outcomeCodeableConcept": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "161832001", "display": "Progressive weight loss" } ] } ], "outcomeReference": [ { "reference": "Observation/example", "display": "Weight Measured" } ], "detail": { "code": { "coding": [ { "system": "http://loinc.org", "code": "3141-9", "display": "Weight Measured" }, { "system": "http://snomed.info/sct", "code": "27113001", "display": "Body weight" } ] }, "status": "completed", "statusReason": { "text": "Achieved weight loss to mitigate diabetes risk." }, "doNotPerform": false, "scheduledTiming": { "repeat": { "frequency": 1, "period": 1, "periodUnit": "d" } }, "location": { "display": "Patient'\''s home" }, "performer": [ { "reference": "Patient/example", "display": "Peter James Chalmers" } ] } } ] }'
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 care plan 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, questionnaire or other definition that is adhered to in whole or in part by this CarePlan.
The URL pointing to an externally maintained protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan.
A care plan that is fulfilled in whole or in part by this care plan.
Completed or terminated care plan whose function is taken by this new care plan.
A larger care plan of which this particular care plan is a component or step.
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 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
Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", "wellness plan", etc.
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.
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.
Identifies the individual(s) or organization who provided the contents of the care plan.
Identifies all people and organizations who are expected to be involved in the care envisioned by this plan.
Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan.
Identifies portions of the patient's record that specifically influenced the formation of the plan. These might include comorbidities, recent procedures, limitations, recent assessments, etc.
Describes the intended objective(s) of carrying out the care plan.
Identifies a planned action to occur as part of the plan. For example, a medication to be used, lab tests to perform, self-monitoring, education, etc.
{ "resourceType": "CarePlan", "id": "example", "text": { "status": "additional", "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n <p> A simple care plan to indicate a patient taking their weight once a day because of obesity.</p>\n </div>" }, "contained": [ { … } ], "identifier": [ { … } ], "instantiatesUri": [ "http://example.org/protocol-for-obesity" ], "basedOn": [ { … } ], "replaces": [ { … } ], "partOf": [ { … } ], "status": "active", "intent": "plan", "category": [ { … } ], "description": "Manage obesity and weight loss", "subject": { "reference": "Patient/example", "display": "Peter James Chalmers" }, "encounter": { "reference": "Encounter/home" }, "period": { "end": "2017-06-01" }, "created": "2016-01-01", "author": { "reference": "Practitioner/example", "display": "Dr Adam Careful" }, "careTeam": [ { … } ], "addresses": [ { … } ], "goal": [ { … } ], "activity": [ { … } ] }
curl -i -X DELETE \ 'https://docs.heydonto.com/_mock/apis/fhir/openapi/fhir/care-plan/{id}' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>'
{ "statusText": "OK", "status": 200 }
curl -i -X GET \ 'https://docs.heydonto.com/_mock/apis/fhir/openapi/fhir/care-plan/{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 }