| Australian Digital Health Agency FHIR Implementation Guide 1.1.0

This page is part of the Australian Digital Health Agency FHIR Implementation Guide 1.1.0. It is based on FHIR® version 4.0.1. See the Directory of published versions for a list of available previous versions.

#### StructureDefinition: ADHA GP Practice Registration Entry - Detailed Descriptions

Definitions for the dh-episodeofcare-mymedicare-1 Profile.

1. EpisodeOfCare
Definition | Information about a GP practice that is or has been registered for the patient in the MyMedicare system.
Control | 0..*
Alternate Names | Case Program Problem
2. EpisodeOfCare.id
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Control | 0..1
Type | id
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
3. EpisodeOfCare.meta
Definition | 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.
Control | 0..1
Type | Meta
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
4. EpisodeOfCare.implicitRules
Definition | 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.
Control | 0..1
Type | uri
Is Modifier | true
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
5. EpisodeOfCare.language
Definition | The base language in which the resource is written.
Control | 0..1
Binding | The codes SHOULD be taken from CommonLanguages A human language
Additional Bindings | Purpose
AllLanguages | Max Binding
Type | code
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
6. EpisodeOfCare.text
Definition | 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.
Control | 0..1
Type | Narrative
Alternate Names | narrativehtmlxhtmldisplay
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
7. EpisodeOfCare.contained
Definition | 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.
Control | 0..*
Type | Resource
Alternate Names | inline resourcesanonymous resourcescontained resources
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
8. EpisodeOfCare.extension
Definition | 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.
Control | 0..*
Type | Extension
Alternate Names | extensionsuser content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
9. EpisodeOfCare.modifierExtension
Definition | 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).
Control | 0..*
Type | Extension
Is Modifier | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensionsuser content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
10. EpisodeOfCare.identifier
Definition | 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.
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..*
Type | Identifier
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
11. EpisodeOfCare.status
Definition | planned | waitlist | active | onhold | finished | cancelled.
Control | 1..1
Binding | The codes SHALL be taken from EpisodeOfCareStatus The status of the episode of care
Type | code
Is Modifier | true
Must Support | true
Comments | This element is labeled as a modifier because the status contains codes that mark the episode as not currently valid.
Fixed Value | active
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
12. EpisodeOfCare.statusHistory
Definition | The history of statuses that the EpisodeOfCare has been through (without requiring processing the history of the resource).
Control | 0..*
Type | BackboneElement
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
13. EpisodeOfCare.statusHistory.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control | 0..1
Type | string
XML Representation | In the XML format, this property is represented as an attribute.
14. EpisodeOfCare.statusHistory.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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.
Control | 0..*
Type | Extension
Alternate Names | extensionsuser content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
15. EpisodeOfCare.statusHistory.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 can 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).
Control | 0..*
Type | Extension
Is Modifier | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensionsuser contentmodifiers
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
16. EpisodeOfCare.statusHistory.status
Definition | planned | waitlist | active | onhold | finished | cancelled.
Control | 1..1
Binding | The codes SHALL be taken from EpisodeOfCareStatus The status of the episode of care
Type | code
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
17. EpisodeOfCare.statusHistory.period
Definition | The period during this EpisodeOfCare that the specific status applied.
Control | 1..1
Type | Period
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
18. EpisodeOfCare.type
Definition | A classification of the type of episode of care; e.g. specialist referral, disease management, type of funded care.
Control | 1..*
Binding | For example codes, see EpisodeOfCareType The type of the episode of care
Type | CodeableConcept
Must Support | true
Comments | The type can be very important in processing as this could be used in determining if the EpisodeOfCare is relevant to specific government reporting, or other types of classifications.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
Slicing | This element introduces a set of slices on EpisodeOfCare.type. The slices are unordered and Open, and can be differentiated using the following discriminators: pattern @ $this
19. EpisodeOfCare.type:primaryCare
SliceName | primaryCare
Definition | A classification of the type of episode of care; e.g. specialist referral, disease management, type of funded care.
Control | 1..1
Binding | For example codes, see EpisodeOfCareType The type of the episode of care
Type | CodeableConcept
Comments | The type can be very important in processing as this could be used in determining if the EpisodeOfCare is relevant to specific government reporting, or other types of classifications.
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://snomed.info/sct"/> <code value="737470001"/> </coding> </valueCodeableConcept>
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
20. EpisodeOfCare.diagnosis
Definition | The list of diagnosis relevant to this episode of care.
Control | 0..*
Type | BackboneElement
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
21. EpisodeOfCare.diagnosis.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control | 0..1
Type | string
XML Representation | In the XML format, this property is represented as an attribute.
22. EpisodeOfCare.diagnosis.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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.
Control | 0..*
Type | Extension
Alternate Names | extensionsuser content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
23. EpisodeOfCare.diagnosis.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 can 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).
Control | 0..*
Type | Extension
Is Modifier | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensionsuser contentmodifiers
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
24. EpisodeOfCare.diagnosis.condition
Definition | A list of conditions/problems/diagnoses that this episode of care is intended to be providing care for.
Control | 1..1
Type | Reference(Condition))
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
25. EpisodeOfCare.diagnosis.role
Definition | Role that this diagnosis has within the episode of care (e.g. admission, billing, discharge …).
Control | 0..1
Binding | The codes SHOULD be taken from DiagnosisRole The type of diagnosis this condition represents
Type | CodeableConcept
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
26. EpisodeOfCare.diagnosis.rank
Definition | Ranking of the diagnosis (for each role type).
Control | 0..1
Type | positiveInt
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
27. EpisodeOfCare.patient
Definition | The patient who is the focus of this episode of care.
Control | 1..1 This element is affected by the following invariants: inv-dh-epoc-01
Type | Reference(ADHAPatientCore))
Must Support | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) inv-dh-epoc-01: At least reference or a valid identifier shall be present (: reference.exists() or identifier.where(system.count() + value.count() >1).exists())
28. EpisodeOfCare.managingOrganization
Definition | The organization that has assumed the specific responsibilities for the specified duration.
Control | 1..1 This element is affected by the following invariants: inv-dh-epoc-02
Type | Reference(ADHAOrganizationCore))
Must Support | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) inv-dh-epoc-02: At least reference or a valid identifier shall be present (: reference.exists() or identifier.where(system.count() + value.count() >1).exists())
29. EpisodeOfCare.period
Definition | The interval during which the managing organization assumes the defined responsibility.
Control | 1..1
Type | Period
Must Support | true
Comments | In the context of a MyMedicare registration, a patient's current registered GP practice will only have period.start. A historical entry will have both period.start and period.end.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
30. EpisodeOfCare.period.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control | 0..1
Type | string
XML Representation | In the XML format, this property is represented as an attribute.
31. EpisodeOfCare.period.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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.
Control | 0..*
Type | Extension
Alternate Names | extensionsuser content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
Slicing | This element introduces a set of slices on EpisodeOfCare.period.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
32. EpisodeOfCare.period.start
Definition | The start of the period. The boundary is inclusive.
Control | 1..1 This element is affected by the following invariants: per-1inv-dh-epoc-03
Type | dateTime
Must Support | true
Comments | If the low element is missing, the meaning is that the low boundary is not known.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
33. EpisodeOfCare.period.end
Definition | The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.
Control | 0..1 This element is affected by the following invariants: per-1
Type | dateTime
Comments | The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.
Meaning if Missing | If the end of the period is missing, it means that the period is ongoing
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
34. EpisodeOfCare.referralRequest
Definition | Referral Request(s) that are fulfilled by this EpisodeOfCare, incoming referrals.
Control | 0..*
Type | Reference(ServiceRequest))
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
35. EpisodeOfCare.careManager
Definition | The practitioner that is the care manager/care coordinator for this patient.
Control | 0..1
Type | Reference(Practitioner PractitionerRole))
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
36. EpisodeOfCare.team
Definition | The list of practitioners that may be facilitating this episode of care for specific purposes.
Control | 0..*
Type | Reference(CareTeam))
Alternate Names | CareTeam
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
37. EpisodeOfCare.account
Definition | The set of accounts that may be used for billing for this EpisodeOfCare.
Control | 0..*
Type | Reference(Account))
Comments | The billing system may choose to allocate billable items associated with the EpisodeOfCare to different referenced Accounts based on internal business rules.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))