EpisodeOfCare - FHIR Resource (stu3)
This EpisodeOfCare Resource uses the FHIR API standard for access and structure.
Validate an EpisodeOfCare FHIR Resource (stu3)
EpisodeOfCare Attributes
AttributeField is listTypeDescription
Description: planned | waitlist | active | onhold | finished | cancelled | entered-in-error
FHIR Version: stu3
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"status": "active"Learn more about the (EpisodeOfCare) status FHIR attribute
Description: Organization that assumes care
FHIR Version: stu3
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"managingOrganization": {
"reference": "Organization/hl7"
}Learn more about the (EpisodeOfCare) managingOrganization FHIR attribute
Description: The set of accounts that may be used for billing for this EpisodeOfCare
FHIR Version: stu3
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"account": [
{
"display": "example account",
"reference": "Account/example"
}
]Learn more about the (EpisodeOfCare) account FHIR attribute
Description: Care manager/care co-ordinator for the patient
FHIR Version: stu3
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"careManager": {
"display": "Amanda Assigned",
"reference": "Practitioner/14"
}Learn more about the (EpisodeOfCare) careManager FHIR attribute
Description: The patient who is the focus of this episode of care
FHIR Version: stu3
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"patient": {
"reference": "Patient/example"
}Learn more about the (EpisodeOfCare) patient FHIR attribute
Description: Business Identifier(s) relevant for this EpisodeOfCare
FHIR Version: stu3
Attribute Type : Identifier
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"identifier": [
{
"system": "http://example.org/sampleepisodeofcare-identifier",
"value": "123"
}
]Learn more about the (EpisodeOfCare) identifier FHIR attribute
Description: Duration the EpisodeOfCare was in the specified status
FHIR Version: stu3
Attribute Type : Period
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"period": {
"start": "2014-09-01"
}Learn more about the (EpisodeOfCare) period FHIR attribute
Description: Originating Referral Request(s)
FHIR Version: stu3
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"referralRequest": [
{
"display": "Referral from Example Aged Care Services"
}
]Learn more about the (EpisodeOfCare) referralRequest FHIR attribute
Description: The list of diagnosis relevant to this episode of care
FHIR Version: stu3
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"diagnosis": [
{
"role": {
"coding": [
{
"code": "CC",
"system": "http://hl7.org/fhir/diagnosis-role",
"display": "Chief complaint"
}
]
},
"rank": 1,
"condition": {
"reference": "Condition/stroke"
}
}
]Learn more about the (EpisodeOfCare) diagnosis FHIR attribute
Description: Other practitioners facilitating this episode of care
FHIR Version: stu3
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"team": [
{
"display": "example care team",
"reference": "CareTeam/example"
}
]Learn more about the (EpisodeOfCare) team FHIR attribute
Description: Past list of status codes (the current status may be included to cover the start date of the status)
FHIR Version: stu3
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"statusHistory": [
{
"status": "planned",
"period": {
"start": "2014-09-01",
"end": "2014-09-14"
}
},
{
"status": "active",
"period": {
"start": "2014-09-15",
"end": "2014-09-21"
}
},
{
"status": "onhold",
"period": {
"start": "2014-09-22",
"end": "2014-09-24"
}
},
{
"status": "active",
"period": {
"start": "2014-09-25"
}
}
]Learn more about the (EpisodeOfCare) statusHistory FHIR attribute
Description: Type/class - e.g. specialist referral, disease management
FHIR Version: stu3
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"type": [
{
"coding": [
{
"code": "hacc",
"system": "http://hl7.org/fhir/episodeofcare-type",
"display": "Home and Community Care"
}
]
}
]Learn more about the (EpisodeOfCare) type FHIR attribute
EpisodeOfCare Example
{
"status": "active",
"managingOrganization": {
"reference": "Organization/hl7"
},
"account": [
{
"display": "example account",
"reference": "Account/example"
}
],
"statusHistory": [
{
"status": "planned",
"period": {
"start": "2014-09-01",
"end": "2014-09-14"
}
},
{
"status": "active",
"period": {
"start": "2014-09-15",
"end": "2014-09-21"
}
},
{
"status": "onhold",
"period": {
"start": "2014-09-22",
"end": "2014-09-24"
}
},
{
"status": "active",
"period": {
"start": "2014-09-25"
}
}
],
"patient": {
"reference": "Patient/example"
},
"resourceType": "EpisodeOfCare",
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n HACC Program for Peter James Chalmers at HL7 Healthcare 15 Sept 2014 - current<br/>\n\t\t\twas on leave from 22 Sept - 24 Sept while in respite care\n </div>"
},
"period": {
"start": "2014-09-01"
},
"careManager": {
"display": "Amanda Assigned",
"reference": "Practitioner/14"
},
"referralRequest": [
{
"display": "Referral from Example Aged Care Services"
}
],
"diagnosis": [
{
"role": {
"coding": [
{
"code": "CC",
"system": "http://hl7.org/fhir/diagnosis-role",
"display": "Chief complaint"
}
]
},
"rank": 1,
"condition": {
"reference": "Condition/stroke"
}
}
],
"team": [
{
"display": "example care team",
"reference": "CareTeam/example"
}
],
"identifier": [
{
"system": "http://example.org/sampleepisodeofcare-identifier",
"value": "123"
}
],
"type": [
{
"coding": [
{
"code": "hacc",
"system": "http://hl7.org/fhir/episodeofcare-type",
"display": "Home and Community Care"
}
]
}
],
"id": "example"
}EpisodeOfCare Structure
{
"resourceType" : "EpisodeOfCare",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"identifier" : [{ Identifier }], // Business Identifier(s) relevant for this EpisodeOfCare
"status" : "<code>", // R! planned | waitlist | active | onhold | finished | cancelled | entered-in-error
"statusHistory" : [{ // Past list of status codes (the current status may be included to cover the start date of the status)
"status" : "<code>", // R! planned | waitlist | active | onhold | finished | cancelled | entered-in-error
"period" : { Period } // R! Duration the EpisodeOfCare was in the specified status
}],
"type" : [{ CodeableConcept }], // Type/class - e.g. specialist referral, disease management
"diagnosis" : [{ // The list of diagnosis relevant to this episode of care
"condition" : { Reference(Condition) }, // R! Conditions/problems/diagnoses this episode of care is for
"role" : { CodeableConcept }, // Role that this diagnosis has within the episode of care (e.g. admission, billing, discharge …)
"rank" : "<positiveInt>" // Ranking of the diagnosis (for each role type)
}],
"patient" : { Reference(Patient) }, // R! The patient who is the focus of this episode of care
"managingOrganization" : { Reference(Organization) }, // Organization that assumes care
"period" : { Period }, // Interval during responsibility is assumed
"referralRequest" : [{ Reference(ReferralRequest) }], // Originating Referral Request(s)
"careManager" : { Reference(Practitioner) }, // Care manager/care co-ordinator for the patient
"team" : [{ Reference(CareTeam) }], // Other practitioners facilitating this episode of care
"account" : [{ Reference(Account) }] // The set of accounts that may be used for billing for this EpisodeOfCare
}
EpisodeOfCare Search Parameters
The following search parameters can be used to query EpisodeOfCare resources. Just submit them like so:
https://api.1up.health/fhir/stu3/EpisodeOfCare?query-param=queryvalue| Search Parameter | Field Type | Resource Fields Searched |
|---|---|---|
care-manager | reference | careManager |
condition | reference | diagnosis.condition |
date | date | period |
identifier | text | identifier |
incomingreferral | reference | referralRequest |
organization | reference | managingOrganization |
patient | reference | patient |
status | text | status |
type | text | type |
