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.

Nictiz profile: EpisodeOfCare

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug

Body


resourceType*			This is a EpisodeOfCare resource
id	id		The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
meta	Meta		The 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.
implicitRules	uri		A 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.
language	code		The base language in which the resource is written.
text	Narrative		A 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.
contained	array(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.
extension	array(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.
modifierExtension	array(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	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		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 coordinator 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

201 400 401 404

Patch Episode Of Care

patch

/organizations/{organizationId}/fhir/4/EpisodeOfCare/{resourceId}

Nictiz profile: EpisodeOfCare

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*			This is a EpisodeOfCare resource
id	id		The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
meta	Meta		The 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.
implicitRules	uri		A 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.
language	code		The base language in which the resource is written.
text	Narrative		A 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.
contained	array(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.
extension	array(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.
modifierExtension	array(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	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		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 coordinator 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

200 201 400 401 404 409

Read Episode Of Care

get

/organizations/{organizationId}/fhir/4/EpisodeOfCare/{resourceId}

Nictiz profile: EpisodeOfCare

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug
resourceId*

Response

200 401 404

Read History Episode Of Care

get

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

Nictiz profile: EpisodeOfCare

Request

Headers


content-type*	string	application/json\|application/json+fhir	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

200 401 404

Read Version Episode Of Care

get

/organizations/{organizationId}/fhir/4/EpisodeOfCare/{resourceId}/_history/{versionId}

Nictiz profile: EpisodeOfCare

Request

Headers


content-type*	string	application/json\|application/json+fhir	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

200 400 401 404

Remove Episode Of Care

delete

/organizations/{organizationId}/fhir/4/EpisodeOfCare/{resourceId}

Nictiz profile: EpisodeOfCare

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug
resourceId*

Response

200 204 400 401 404 409

Search Get Episode Of Care

get

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

Nictiz profile: EpisodeOfCare

Request

Headers


content-type*	string	application/json\|application/json+fhir	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
incoming-referral	string
organization	string
patient	string
status	string
type	string

Params


organizationId*	string\|string		id\|slug

Response

200 401 404

Search History Episode Of Care

get

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

Nictiz profile: EpisodeOfCare

Request

Headers


content-type*	string	application/json\|application/json+fhir	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

200 401 404

Search Post Episode Of Care

post

/organizations/{organizationId}/fhir/4/EpisodeOfCare/_search

Nictiz profile: EpisodeOfCare

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
incoming-referral	string
organization	string
patient	string
status	string
type	string

Params


organizationId*	string\|string		id\|slug

Body


resourceType*			This is a EpisodeOfCare resource
id	id		The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
meta	Meta		The 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.
implicitRules	uri		A 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.
language	code		The base language in which the resource is written.
text	Narrative		A 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.
contained	array(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.
extension	array(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.
modifierExtension	array(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	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		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 coordinator 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

200 401 404

Update Episode Of Care

put

/organizations/{organizationId}/fhir/4/EpisodeOfCare/{resourceId}

Nictiz profile: EpisodeOfCare

Request

Headers


content-type*	string	application/json\|application/json+fhir	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*			This is a EpisodeOfCare resource
id	id		The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
meta	Meta		The 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.
implicitRules	uri		A 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.
language	code		The base language in which the resource is written.
text	Narrative		A 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.
contained	array(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.
extension	array(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.
modifierExtension	array(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	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		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 coordinator 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

200 201 400 401 404 409