Skip to main content

HS.FHIR.DTL.vSTU3.Model.Resource.EpisodeOfCare

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

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.

Property Inventory

Parameters

parameter ELEMENTQUALIFIED = 1;
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 XMLPROJECTION = ELEMENT;
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.

Properties

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

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

Account

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

Care manager/care co-ordinator for the patient.

Practitioner

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

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.vSTU3.Model.Datatype.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");
Identifier

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.vSTU3.Model.Base.Reference (XMLNAME = "managingOrganization", XMLPROJECTION = "ELEMENT");
Reference

Organization that assumes care.

Organization

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

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

Patient

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

Interval during responsibility is assumed.

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

Originating Referral Request(s)

ReferralRequest

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 ];
code

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

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

Property methods: statusDisplayToLogical(), statusGet(), statusHistoryBuildValueArray(), statusHistoryCollectionToDisplay(), statusHistoryCollectionToOdbc(), statusHistoryDisplayToCollection(), statusHistoryGet(), statusHistoryGetObject(), statusHistoryGetObjectId(), statusHistoryGetSwizzled(), statusHistoryIsValid(), statusHistoryOdbcToCollection(), statusHistorySet(), statusHistorySetObject(), statusHistorySetObjectId(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()
property statusHistory as list of HS.FHIR.DTL.vSTU3.Model.Element.EpisodeOfCare.statusHistory (XMLNAME = "statusHistory", XMLPROJECTION = "ELEMENT");
BackboneElement

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.vSTU3.Model.Base.Reference (XMLNAME = "team", XMLPROJECTION = "ELEMENT");
Reference

Other practitioners facilitating this episode of care.

CareTeam

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

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

any FHIR3 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