Skip to main content


class HS.FHIR.DTL.vR4.Model.Resource.EpisodeOfCare extends HS.FHIR.DTL.vR4.Model.Base.DomainResource

An association of a Patient with an Organization and Healthcare Provider(s) for a period of time that the Organization assumes some level of responsibility.

Property Inventory


Inherited description: ELEMENTQUALIFIED controls the format of exported XML. The ELEMENTQUALIFIED specification should be based on the elementFormDefault attribute of the schema that defines the type. To maintain compatibility, ELEMENTQUALIFIED will default to 1 (true) for literal format export and will default to 0 (false) for encoded or encoded12 format export. These were the values always previously assumed for the elementFormDefault attribute.

NOTE: Direct use of XMLExport method does not support the ELEMENTQUALIFIED. The export must be done using %XML.Writer or SOAP support.

parameter XMLNAME = EpisodeOfCare;
Inherited description: This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.
parameter XMLSEQUENCE = 1;
Inherited description: If the XMLSEQUENCE = 1, then the order of the XML elements must match the order of the class properties. This allows us to deal with XML where the same field appears multiple times and is distinguished by the order.
parameter XMLTYPE = EpisodeOfCare;
Inherited description: This parameter provides the default XMLTYPE for the class. If it is empty then the class name will be used to construct a default XML type.

The default XMLTYPE is used when naming and referencing this type in a schema and the schema context did not provide an XML type name.


property account as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "account", XMLPROJECTION = "ELEMENT");

The set of accounts that may be used for billing for this EpisodeOfCare.


Property methods: accountBuildValueArray(), accountCollectionToDisplay(), accountCollectionToOdbc(), accountDisplayToCollection(), accountGet(), accountGetObject(), accountGetObjectId(), accountGetSwizzled(), accountIsValid(), accountOdbcToCollection(), accountSet(), accountSetObject(), accountSetObjectId()
property careManager as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "careManager", XMLPROJECTION = "ELEMENT");

Care manager/care coordinator for the patient.

Practitioner | PractitionerRole

Property methods: careManagerGet(), careManagerGetSwizzled(), careManagerIsValid(), careManagerNewObject(), careManagerSet()
property diagnosis as list of HS.FHIR.DTL.vR4.Model.Element.EpisodeOfCare.diagnosis (XMLNAME = "diagnosis", XMLPROJECTION = "ELEMENT");

The list of diagnosis relevant to this episode of care.

Property methods: diagnosisBuildValueArray(), diagnosisCollectionToDisplay(), diagnosisCollectionToOdbc(), diagnosisDisplayToCollection(), diagnosisGet(), diagnosisGetObject(), diagnosisGetObjectId(), diagnosisGetSwizzled(), diagnosisIsValid(), diagnosisOdbcToCollection(), diagnosisSet(), diagnosisSetObject(), diagnosisSetObjectId()
property identifier as list of HS.FHIR.DTL.vR4.Model.Datatype.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");

Business Identifier(s) relevant for this EpisodeOfCare.

Property methods: identifierBuildValueArray(), identifierCollectionToDisplay(), identifierCollectionToOdbc(), identifierDisplayToCollection(), identifierGet(), identifierGetObject(), identifierGetObjectId(), identifierGetSwizzled(), identifierIsValid(), identifierOdbcToCollection(), identifierSet(), identifierSetObject(), identifierSetObjectId()
property managingOrganization as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "managingOrganization", XMLPROJECTION = "ELEMENT");

Organization that assumes care.


Property methods: managingOrganizationGet(), managingOrganizationGetSwizzled(), managingOrganizationIsValid(), managingOrganizationNewObject(), managingOrganizationSet()
property patient as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "patient", XMLPROJECTION = "ELEMENT") [ Required ];

The patient who is the focus of this episode of care.


Property methods: patientGet(), patientGetSwizzled(), patientIsValid(), patientNewObject(), patientSet()
property period as HS.FHIR.DTL.vR4.Model.Datatype.Period (XMLNAME = "period", XMLPROJECTION = "ELEMENT");

Interval during responsibility is assumed.

Property methods: periodGet(), periodGetSwizzled(), periodIsValid(), periodNewObject(), periodSet()
property referralRequest as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "referralRequest", XMLPROJECTION = "ELEMENT");

Originating Referral Request(s)


Property methods: referralRequestBuildValueArray(), referralRequestCollectionToDisplay(), referralRequestCollectionToOdbc(), referralRequestDisplayToCollection(), referralRequestGet(), referralRequestGetObject(), referralRequestGetObjectId(), referralRequestGetSwizzled(), referralRequestIsValid(), referralRequestOdbcToCollection(), referralRequestSet(), referralRequestSetObject(), referralRequestSetObjectId()
property status as %String (MAXLEN = 1000000, XMLNAME = "status", XMLPROJECTION = "ATTRIBUTE") [ Required ];

planned | waitlist | active | onhold | finished | cancelled | entered-in-error

episode-of-care-status|4.0.1 is the REQUIRED FHIR4 ValueSet for codes; you may NOT extend episode-of-care-status|4.0.1 and you may NOT use codes from other ValueSets.

Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()
property statusHistory as list of HS.FHIR.DTL.vR4.Model.Element.EpisodeOfCare.statusHistory (XMLNAME = "statusHistory", XMLPROJECTION = "ELEMENT");

Past list of status codes (the current status may be included to cover the start date of the status)

Property methods: statusHistoryBuildValueArray(), statusHistoryCollectionToDisplay(), statusHistoryCollectionToOdbc(), statusHistoryDisplayToCollection(), statusHistoryGet(), statusHistoryGetObject(), statusHistoryGetObjectId(), statusHistoryGetSwizzled(), statusHistoryIsValid(), statusHistoryOdbcToCollection(), statusHistorySet(), statusHistorySetObject(), statusHistorySetObjectId()
property team as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "team", XMLPROJECTION = "ELEMENT");

Other practitioners facilitating this episode of care.


Property methods: teamBuildValueArray(), teamCollectionToDisplay(), teamCollectionToOdbc(), teamDisplayToCollection(), teamGet(), teamGetObject(), teamGetObjectId(), teamGetSwizzled(), teamIsValid(), teamOdbcToCollection(), teamSet(), teamSetObject(), teamSetObjectId()
property type as list of HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "type", XMLPROJECTION = "ELEMENT");

Type/class - e.g. specialist referral, disease management.

any FHIR4 code may be used; episodeofcare-type shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: typeBuildValueArray(), typeCollectionToDisplay(), typeCollectionToOdbc(), typeDisplayToCollection(), typeGet(), typeGetObject(), typeGetObjectId(), typeGetSwizzled(), typeIsValid(), typeOdbcToCollection(), typeSet(), typeSetObject(), typeSetObjectId()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab