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*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug

Body

resourceType*stringEpisodeOfCareThis is a EpisodeOfCare resource
identifierarray(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.
statusstringplanned|waitlist|active|onhold|finished|cancelled|entered-in-errorplanned | waitlist | active | onhold | finished | cancelled.
statusHistoryarray(EpisodeOfCare_StatusHistory)The history of statuses that the EpisodeOfCare has been through (without requiring processing the history of the resource).
typearray(CodeableConcept)A classification of the type of episode of care; e.g. specialist referral, disease management, type of funded care.
diagnosisarray(EpisodeOfCare_Diagnosis)The list of diagnosis relevant to this episode of care.
patient*ReferenceThe patient who is the focus of this episode of care.
managingOrganizationReferenceThe organization that has assumed the specific responsibilities for the specified duration.
periodPeriodThe interval during which the managing organization assumes the defined responsibility.
referralRequestarray(Reference)Referral Request(s) that are fulfilled by this EpisodeOfCare, incoming referrals.
careManagerReferenceThe practitioner that is the care manager/care co-ordinator for this patient.
teamarray(Reference)The list of practitioners that may be facilitating this episode of care for specific purposes.
accountarray(Reference)The set of accounts that may be used for billing for this EpisodeOfCare.

Response

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*stringapplication/json-patch+jsonapplication/json-patch+json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringEpisodeOfCareThis is a EpisodeOfCare resource
identifierarray(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.
statusstringplanned|waitlist|active|onhold|finished|cancelled|entered-in-errorplanned | waitlist | active | onhold | finished | cancelled.
statusHistoryarray(EpisodeOfCare_StatusHistory)The history of statuses that the EpisodeOfCare has been through (without requiring processing the history of the resource).
typearray(CodeableConcept)A classification of the type of episode of care; e.g. specialist referral, disease management, type of funded care.
diagnosisarray(EpisodeOfCare_Diagnosis)The list of diagnosis relevant to this episode of care.
patient*ReferenceThe patient who is the focus of this episode of care.
managingOrganizationReferenceThe organization that has assumed the specific responsibilities for the specified duration.
periodPeriodThe interval during which the managing organization assumes the defined responsibility.
referralRequestarray(Reference)Referral Request(s) that are fulfilled by this EpisodeOfCare, incoming referrals.
careManagerReferenceThe practitioner that is the care manager/care co-ordinator for this patient.
teamarray(Reference)The list of practitioners that may be facilitating this episode of care for specific purposes.
accountarray(Reference)The set of accounts that may be used for billing for this EpisodeOfCare.

Response

Read Episode Of Care

get
/organizations/{organizationId}/fhir/3/EpisodeOfCare/{resourceId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Read History Episode Of Care

get
/organizations/{organizationId}/fhir/3/EpisodeOfCare/{resourceId}/_history

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug
resourceId*

Response

Read Version Episode Of Care

get
/organizations/{organizationId}/fhir/3/EpisodeOfCare/{resourceId}/_history/{versionId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

Remove Episode Of Care

delete
/organizations/{organizationId}/fhir/3/EpisodeOfCare/{resourceId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Search Get Episode Of Care

get
/organizations/{organizationId}/fhir/3/EpisodeOfCare

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
care-managerstring
conditionstring
datestring
identifierstring
incomingreferralstring
organizationstring
patientstring
statusstring
typestring

Params

organizationId*string|stringid|slug

Response

Search History Episode Of Care

get
/organizations/{organizationId}/fhir/3/EpisodeOfCare/_history

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug

Response

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*stringapplication/json|application/x-www-form-urlencodedapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
care-managerstring
conditionstring
datestring
identifierstring
incomingreferralstring
organizationstring
patientstring
statusstring
typestring

Params

organizationId*string|stringid|slug

Body

resourceType*stringEpisodeOfCareThis is a EpisodeOfCare resource
identifierarray(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.
statusstringplanned|waitlist|active|onhold|finished|cancelled|entered-in-errorplanned | waitlist | active | onhold | finished | cancelled.
statusHistoryarray(EpisodeOfCare_StatusHistory)The history of statuses that the EpisodeOfCare has been through (without requiring processing the history of the resource).
typearray(CodeableConcept)A classification of the type of episode of care; e.g. specialist referral, disease management, type of funded care.
diagnosisarray(EpisodeOfCare_Diagnosis)The list of diagnosis relevant to this episode of care.
patient*ReferenceThe patient who is the focus of this episode of care.
managingOrganizationReferenceThe organization that has assumed the specific responsibilities for the specified duration.
periodPeriodThe interval during which the managing organization assumes the defined responsibility.
referralRequestarray(Reference)Referral Request(s) that are fulfilled by this EpisodeOfCare, incoming referrals.
careManagerReferenceThe practitioner that is the care manager/care co-ordinator for this patient.
teamarray(Reference)The list of practitioners that may be facilitating this episode of care for specific purposes.
accountarray(Reference)The set of accounts that may be used for billing for this EpisodeOfCare.

Response

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*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringEpisodeOfCareThis is a EpisodeOfCare resource
identifierarray(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.
statusstringplanned|waitlist|active|onhold|finished|cancelled|entered-in-errorplanned | waitlist | active | onhold | finished | cancelled.
statusHistoryarray(EpisodeOfCare_StatusHistory)The history of statuses that the EpisodeOfCare has been through (without requiring processing the history of the resource).
typearray(CodeableConcept)A classification of the type of episode of care; e.g. specialist referral, disease management, type of funded care.
diagnosisarray(EpisodeOfCare_Diagnosis)The list of diagnosis relevant to this episode of care.
patient*ReferenceThe patient who is the focus of this episode of care.
managingOrganizationReferenceThe organization that has assumed the specific responsibilities for the specified duration.
periodPeriodThe interval during which the managing organization assumes the defined responsibility.
referralRequestarray(Reference)Referral Request(s) that are fulfilled by this EpisodeOfCare, incoming referrals.
careManagerReferenceThe practitioner that is the care manager/care co-ordinator for this patient.
teamarray(Reference)The list of practitioners that may be facilitating this episode of care for specific purposes.
accountarray(Reference)The set of accounts that may be used for billing for this EpisodeOfCare.

Response