episode of cares
Create Episode Of Care
post
/organizations/{organizationId}/fhir/3/EpisodeOfCare
An association between a patient and an organization / healthcare provider(s) during which time encounters may occur. The managing organization assumes a level of responsibility for the patient during this time.
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Params
| organizationId* | string|string | id|slug |
Body
| resourceType* | string | EpisodeOfCare | This is a EpisodeOfCare resource |
| identifier | array(Identifier) | The EpisodeOfCare may be known by different identifiers for different contexts of use, such as when an external agency is tracking the Episode for funding purposes. | |
| status | string | planned|waitlist|active|onhold|finished|cancelled|entered-in-error | planned | waitlist | active | onhold | finished | cancelled. |
| statusHistory | array(EpisodeOfCare_StatusHistory) | The history of statuses that the EpisodeOfCare has been through (without requiring processing the history of the resource). | |
| type | array(CodeableConcept) | A classification of the type of episode of care; e.g. specialist referral, disease management, type of funded care. | |
| diagnosis | array(EpisodeOfCare_Diagnosis) | The list of diagnosis relevant to this episode of care. | |
| patient* | Reference | The patient who is the focus of this episode of care. | |
| managingOrganization | Reference | The organization that has assumed the specific responsibilities for the specified duration. | |
| period | Period | The interval during which the managing organization assumes the defined responsibility. | |
| referralRequest | array(Reference) | Referral Request(s) that are fulfilled by this EpisodeOfCare, incoming referrals. | |
| careManager | Reference | The practitioner that is the care manager/care co-ordinator for this patient. | |
| team | array(Reference) | The list of practitioners that may be facilitating this episode of care for specific purposes. | |
| account | array(Reference) | The set of accounts that may be used for billing for this EpisodeOfCare. |
Response
keyboard_arrow_down
Patch Episode Of Care
patch
/organizations/{organizationId}/fhir/3/EpisodeOfCare/{resourceId}
An association between a patient and an organization / healthcare provider(s) during which time encounters may occur. The managing organization assumes a level of responsibility for the patient during this time.
Request
Headers
| content-type* | string | application/json-patch+json | application/json-patch+json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Params
| organizationId* | string|string | id|slug | |
| resourceId* |
Body
| resourceType* | string | EpisodeOfCare | This is a EpisodeOfCare resource |
| identifier | array(Identifier) | The EpisodeOfCare may be known by different identifiers for different contexts of use, such as when an external agency is tracking the Episode for funding purposes. | |
| status | string | planned|waitlist|active|onhold|finished|cancelled|entered-in-error | planned | waitlist | active | onhold | finished | cancelled. |
| statusHistory | array(EpisodeOfCare_StatusHistory) | The history of statuses that the EpisodeOfCare has been through (without requiring processing the history of the resource). | |
| type | array(CodeableConcept) | A classification of the type of episode of care; e.g. specialist referral, disease management, type of funded care. | |
| diagnosis | array(EpisodeOfCare_Diagnosis) | The list of diagnosis relevant to this episode of care. | |
| patient* | Reference | The patient who is the focus of this episode of care. | |
| managingOrganization | Reference | The organization that has assumed the specific responsibilities for the specified duration. | |
| period | Period | The interval during which the managing organization assumes the defined responsibility. | |
| referralRequest | array(Reference) | Referral Request(s) that are fulfilled by this EpisodeOfCare, incoming referrals. | |
| careManager | Reference | The practitioner that is the care manager/care co-ordinator for this patient. | |
| team | array(Reference) | The list of practitioners that may be facilitating this episode of care for specific purposes. | |
| account | array(Reference) | The set of accounts that may be used for billing for this EpisodeOfCare. |
Response
keyboard_arrow_down
Read Episode Of Care
get
/organizations/{organizationId}/fhir/3/EpisodeOfCare/{resourceId}
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Params
| organizationId* | string|string | id|slug | |
| resourceId* |
Response
keyboard_arrow_down
Read History Episode Of Care
get
/organizations/{organizationId}/fhir/3/EpisodeOfCare/{resourceId}/_history
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Query params
| _count | string | ||
| _since | string |
Params
| organizationId* | string|string | id|slug | |
| resourceId* |
Response
keyboard_arrow_down
Read Version Episode Of Care
get
/organizations/{organizationId}/fhir/3/EpisodeOfCare/{resourceId}/_history/{versionId}
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Params
| organizationId* | string|string | id|slug | |
| resourceId* | |||
| versionId* |
Response
keyboard_arrow_down
Remove Episode Of Care
delete
/organizations/{organizationId}/fhir/3/EpisodeOfCare/{resourceId}
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Params
| organizationId* | string|string | id|slug | |
| resourceId* |
Response
keyboard_arrow_down
Search Get Episode Of Care
get
/organizations/{organizationId}/fhir/3/EpisodeOfCare
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Query params
| _id | string | ||
| _language | string | ||
| care-manager | string | ||
| condition | string | ||
| date | string | ||
| identifier | string | ||
| incomingreferral | string | ||
| organization | string | ||
| patient | string | ||
| status | string | ||
| type | string |
Params
| organizationId* | string|string | id|slug |
Response
keyboard_arrow_down
Search History Episode Of Care
get
/organizations/{organizationId}/fhir/3/EpisodeOfCare/_history
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Query params
| _count | string | ||
| _since | string |
Params
| organizationId* | string|string | id|slug |
Response
keyboard_arrow_down
Search Post Episode Of Care
post
/organizations/{organizationId}/fhir/3/EpisodeOfCare/_search
An association between a patient and an organization / healthcare provider(s) during which time encounters may occur. The managing organization assumes a level of responsibility for the patient during this time.
Request
Headers
| content-type* | string | application/json|application/x-www-form-urlencoded | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Query params
| _id | string | ||
| _language | string | ||
| care-manager | string | ||
| condition | string | ||
| date | string | ||
| identifier | string | ||
| incomingreferral | string | ||
| organization | string | ||
| patient | string | ||
| status | string | ||
| type | string |
Params
| organizationId* | string|string | id|slug |
Body
| resourceType* | string | EpisodeOfCare | This is a EpisodeOfCare resource |
| identifier | array(Identifier) | The EpisodeOfCare may be known by different identifiers for different contexts of use, such as when an external agency is tracking the Episode for funding purposes. | |
| status | string | planned|waitlist|active|onhold|finished|cancelled|entered-in-error | planned | waitlist | active | onhold | finished | cancelled. |
| statusHistory | array(EpisodeOfCare_StatusHistory) | The history of statuses that the EpisodeOfCare has been through (without requiring processing the history of the resource). | |
| type | array(CodeableConcept) | A classification of the type of episode of care; e.g. specialist referral, disease management, type of funded care. | |
| diagnosis | array(EpisodeOfCare_Diagnosis) | The list of diagnosis relevant to this episode of care. | |
| patient* | Reference | The patient who is the focus of this episode of care. | |
| managingOrganization | Reference | The organization that has assumed the specific responsibilities for the specified duration. | |
| period | Period | The interval during which the managing organization assumes the defined responsibility. | |
| referralRequest | array(Reference) | Referral Request(s) that are fulfilled by this EpisodeOfCare, incoming referrals. | |
| careManager | Reference | The practitioner that is the care manager/care co-ordinator for this patient. | |
| team | array(Reference) | The list of practitioners that may be facilitating this episode of care for specific purposes. | |
| account | array(Reference) | The set of accounts that may be used for billing for this EpisodeOfCare. |
Response
keyboard_arrow_down
Update Episode Of Care
put
/organizations/{organizationId}/fhir/3/EpisodeOfCare/{resourceId}
An association between a patient and an organization / healthcare provider(s) during which time encounters may occur. The managing organization assumes a level of responsibility for the patient during this time.
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Params
| organizationId* | string|string | id|slug | |
| resourceId* |
Body
| resourceType* | string | EpisodeOfCare | This is a EpisodeOfCare resource |
| identifier | array(Identifier) | The EpisodeOfCare may be known by different identifiers for different contexts of use, such as when an external agency is tracking the Episode for funding purposes. | |
| status | string | planned|waitlist|active|onhold|finished|cancelled|entered-in-error | planned | waitlist | active | onhold | finished | cancelled. |
| statusHistory | array(EpisodeOfCare_StatusHistory) | The history of statuses that the EpisodeOfCare has been through (without requiring processing the history of the resource). | |
| type | array(CodeableConcept) | A classification of the type of episode of care; e.g. specialist referral, disease management, type of funded care. | |
| diagnosis | array(EpisodeOfCare_Diagnosis) | The list of diagnosis relevant to this episode of care. | |
| patient* | Reference | The patient who is the focus of this episode of care. | |
| managingOrganization | Reference | The organization that has assumed the specific responsibilities for the specified duration. | |
| period | Period | The interval during which the managing organization assumes the defined responsibility. | |
| referralRequest | array(Reference) | Referral Request(s) that are fulfilled by this EpisodeOfCare, incoming referrals. | |
| careManager | Reference | The practitioner that is the care manager/care co-ordinator for this patient. | |
| team | array(Reference) | The list of practitioners that may be facilitating this episode of care for specific purposes. | |
| account | array(Reference) | The set of accounts that may be used for billing for this EpisodeOfCare. |
Response
keyboard_arrow_down