episode of cares

Create Episode Of Care

post
/organizations/{organizationId}/fhir/4/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/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug

Body

resourceType*This is a EpisodeOfCare resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRulesuriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
languagecodeThe base language in which the resource is written.
textNarrativeA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
containedarray(ResourceList)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.
extensionarray(Extension)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.
modifierExtensionarray(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).
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.
statusplanned|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 coordinator 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/4/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*This is a EpisodeOfCare resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRulesuriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
languagecodeThe base language in which the resource is written.
textNarrativeA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
containedarray(ResourceList)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.
extensionarray(Extension)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.
modifierExtensionarray(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).
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.
statusplanned|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 coordinator 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/4/EpisodeOfCare/{resourceId}

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/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/4/EpisodeOfCare/{resourceId}/_history

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/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/4/EpisodeOfCare/{resourceId}/_history/{versionId}

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/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/4/EpisodeOfCare/{resourceId}

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/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/4/EpisodeOfCare

Request

Headers

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

Query params

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

Params

organizationId*string|stringid|slug

Response

Search History Episode Of Care

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

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/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/4/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
incoming-referralstring
organizationstring
patientstring
statusstring
typestring

Params

organizationId*string|stringid|slug

Body

resourceType*This is a EpisodeOfCare resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRulesuriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
languagecodeThe base language in which the resource is written.
textNarrativeA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
containedarray(ResourceList)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.
extensionarray(Extension)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.
modifierExtensionarray(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).
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.
statusplanned|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 coordinator 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/4/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|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*This is a EpisodeOfCare resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRulesuriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
languagecodeThe base language in which the resource is written.
textNarrativeA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
containedarray(ResourceList)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.
extensionarray(Extension)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.
modifierExtensionarray(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).
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.
statusplanned|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 coordinator 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