My Health Record FHIR IG
1.4.0 - active
My Health Record FHIR IG - Local Development build (v1.4.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-episodeofcare-mymedicare-mhr-1 | Version: 1.4.0 | |||
| Computable Name: MHREpisodeOfCareMyMedicare | ||||
Copyright/Legal: Copyright © 2023 Australian Digital Health Agency - All rights reserved. This content is licensed under a Creative Commons Attribution 4.0 International License. See https://creativecommons.org/licenses/by/4.0/. This resource includes SNOMED Clinical Terms™ (SNOMED CT®) which is used by permission of the International Health Terminology Standards Development Organisation (IHTSDO). All rights reserved. SNOMED CT®, was originally created by The College of American Pathologists. “SNOMED” and “SNOMED CT” are registered trademarks of the IHTSDO. The rights to use and implement or implementation of SNOMED CT content are limited to the extent it is necessary to allow for the end use of this material. No further rights are granted in respect of the International Release and no further use of any SNOMED CT content by any other party is permitted. All copies of this resource must include this copyright statement and all information contained in this statement. |
||||
The purpose of this profile is to define a representation of GP practice registration information for a patient from MyMedicare for the electronic exchange of health information between individuals, healthcare providers, and the My Health Record system infrastructure in Australia.
Usages:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  EpisodeOfCare |
C | 0..* | EpisodeOfCare | GP practice registration information Constraints: inv-dh-epoc-03 |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| status |
?!SΣ | 1..1 | code | planned | waitlist | active | onhold | finished | cancelled | entered-in-error Binding: EpisodeOfCareStatus (required): The status of the episode of care. Fixed Value: active |
  Slices for type |
SΣ | 1..* | CodeableConcept | Type/class - e.g. specialist referral, disease management Slice: Unordered, Open by value:coding.code Binding: EpisodeOfCareType (example): The type of the episode of care. |
   type:primaryCare |
Σ | 1..1 | CodeableConcept | GP practice - primary care management Binding: EpisodeOfCareType (example): The type of the episode of care. Required Pattern: At least the following |
  id |
0..1 | string | Unique id for inter-element referencing | |
 extension |
0..* | Extension | Additional content defined by implementations | |
  coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
 id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 737470001 | |
| display |
0..1 | string | Representation defined by the system | |
 userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
 text |
0..1 | string | Plain text representation of the concept | |
 patient |
SΣC | 1..1 | Reference(AU Core Patient) | The patient Constraints: inv-dh-epoc-01 |
| managingOrganization |
SΣC | 1..1 | Reference(AU Core Organization) | GP practice that is now, or was once, registered for the patient Constraints: inv-dh-epoc-02 |
 period |
SΣ | 1..1 | Period | Interval during responsibility is assumed |
| start |
SΣC | 1..1 | dateTime | Registration start date |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| EpisodeOfCare.status | required | Fixed Value: activehttp://hl7.org/fhir/ValueSet/episode-of-care-status|4.0.1From the FHIR Standard | |
| EpisodeOfCare.type | example | EpisodeOfCareTypehttp://hl7.org/fhir/ValueSet/episodeofcare-typeFrom the FHIR Standard | |
| EpisodeOfCare.type:primaryCare | example | Pattern Value: SNOMED-CT Code 737470001http://hl7.org/fhir/ValueSet/episodeofcare-typeFrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | EpisodeOfCare | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | EpisodeOfCare | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | EpisodeOfCare | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | EpisodeOfCare | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | EpisodeOfCare | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| inv-dh-epoc-01 | error | EpisodeOfCare.patient | At least reference or a valid identifier shall be present : reference.exists() or identifier.where(system.count() + value.count() >1).exists() | |
| inv-dh-epoc-02 | error | EpisodeOfCare.managingOrganization | At least reference or a valid identifier shall be present : reference.exists() or identifier.where(system.count() + value.count() >1).exists() | |
| inv-dh-epoc-03 | error | EpisodeOfCare | A patient's current GP practice shall not have a registration end date : (status = 'active') implies period.end.empty() |
This structure is derived from EpisodeOfCare
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| EpisodeOfCare |
C | 0..* | EpisodeOfCare | GP practice registration information Constraints: inv-dh-epoc-03 |
 status |
S | 1..1 | code | planned | waitlist | active | onhold | finished | cancelled | entered-in-error Fixed Value: active |
| Slices for type |
S | 1..* | CodeableConcept | Type/class - e.g. specialist referral, disease management Slice: Unordered, Open by value:coding.code |
| type:primaryCare |
1..1 | CodeableConcept | GP practice - primary care management Required Pattern: At least the following | |
 coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 737470001 | |
| patient |
SC | 1..1 | Reference(AU Core Patient) | The patient Constraints: inv-dh-epoc-01 |
| managingOrganization |
SC | 1..1 | Reference(AU Core Organization) | GP practice that is now, or was once, registered for the patient Constraints: inv-dh-epoc-02 |
| period |
S | 1..1 | Period | Interval during responsibility is assumed |
| start |
SC | 1..1 | dateTime | Registration start date |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| inv-dh-epoc-01 | error | EpisodeOfCare.patient | At least reference or a valid identifier shall be present : reference.exists() or identifier.where(system.count() + value.count() >1).exists() | |
| inv-dh-epoc-02 | error | EpisodeOfCare.managingOrganization | At least reference or a valid identifier shall be present : reference.exists() or identifier.where(system.count() + value.count() >1).exists() | |
| inv-dh-epoc-03 | error | EpisodeOfCare | A patient's current GP practice shall not have a registration end date : (status = 'active') implies period.end.empty() |
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| EpisodeOfCare |
C | 0..* | EpisodeOfCare | GP practice registration information Constraints: inv-dh-epoc-03 | ||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
 extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
0..* | Identifier | Business Identifier(s) relevant for this EpisodeOfCare | |||||
| status |
?!SΣ | 1..1 | code | planned | waitlist | active | onhold | finished | cancelled | entered-in-error Binding: EpisodeOfCareStatus (required): The status of the episode of care. Fixed Value: active | ||||
| statusHistory |
0..* | BackboneElement | Past list of status codes (the current status may be included to cover the start date of the status) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| status |
1..1 | code | planned | waitlist | active | onhold | finished | cancelled | entered-in-error Binding: EpisodeOfCareStatus (required): The status of the episode of care. | |||||
| period |
1..1 | Period | Duration the EpisodeOfCare was in the specified status | |||||
| Slices for type |
SΣ | 1..* | CodeableConcept | Type/class - e.g. specialist referral, disease management Slice: Unordered, Open by value:coding.code Binding: EpisodeOfCareType (example): The type of the episode of care. | ||||
| type:primaryCare |
Σ | 1..1 | CodeableConcept | GP practice - primary care management Binding: EpisodeOfCareType (example): The type of the episode of care. Required Pattern: At least the following | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 737470001 | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| diagnosis |
Σ | 0..* | BackboneElement | The list of diagnosis relevant to this episode of care | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| condition |
Σ | 1..1 | Reference(Condition) | Conditions/problems/diagnoses this episode of care is for | ||||
| role |
Σ | 0..1 | CodeableConcept | Role that this diagnosis has within the episode of care (e.g. admission, billing, discharge …) Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents. | ||||
| rank |
Σ | 0..1 | positiveInt | Ranking of the diagnosis (for each role type) | ||||
| patient |
SΣC | 1..1 | Reference(AU Core Patient) | The patient Constraints: inv-dh-epoc-01 | ||||
| managingOrganization |
SΣC | 1..1 | Reference(AU Core Organization) | GP practice that is now, or was once, registered for the patient Constraints: inv-dh-epoc-02 | ||||
| period |
SΣ | 1..1 | Period | Interval during responsibility is assumed | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| start |
SΣC | 1..1 | dateTime | Registration start date | ||||
| end |
ΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
| referralRequest |
0..* | Reference(ServiceRequest) | Originating Referral Request(s) | |||||
| careManager |
0..1 | Reference(Practitioner | PractitionerRole) | Care manager/care coordinator for the patient | |||||
| team |
0..* | Reference(CareTeam) | Other practitioners facilitating this episode of care | |||||
| account |
0..* | Reference(Account) | The set of accounts that may be used for billing for this EpisodeOfCare | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| EpisodeOfCare.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard
| ||||
| EpisodeOfCare.status | required | Fixed Value: activehttp://hl7.org/fhir/ValueSet/episode-of-care-status|4.0.1From the FHIR Standard | ||||
| EpisodeOfCare.statusHistory.status | required | EpisodeOfCareStatushttp://hl7.org/fhir/ValueSet/episode-of-care-status|4.0.1From the FHIR Standard | ||||
| EpisodeOfCare.type | example | EpisodeOfCareTypehttp://hl7.org/fhir/ValueSet/episodeofcare-typeFrom the FHIR Standard | ||||
| EpisodeOfCare.type:primaryCare | example | Pattern Value: SNOMED-CT Code 737470001http://hl7.org/fhir/ValueSet/episodeofcare-typeFrom the FHIR Standard | ||||
| EpisodeOfCare.diagnosis.role | preferred | DiagnosisRolehttp://hl7.org/fhir/ValueSet/diagnosis-roleFrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | EpisodeOfCare | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | EpisodeOfCare | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | EpisodeOfCare | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | EpisodeOfCare | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | EpisodeOfCare | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| inv-dh-epoc-01 | error | EpisodeOfCare.patient | At least reference or a valid identifier shall be present : reference.exists() or identifier.where(system.count() + value.count() >1).exists() | |
| inv-dh-epoc-02 | error | EpisodeOfCare.managingOrganization | At least reference or a valid identifier shall be present : reference.exists() or identifier.where(system.count() + value.count() >1).exists() | |
| inv-dh-epoc-03 | error | EpisodeOfCare | A patient's current GP practice shall not have a registration end date : (status = 'active') implies period.end.empty() |
This structure is derived from EpisodeOfCare
Summary
Mandatory: 5 elements
Must-Support: 6 elements
Fixed: 1 element
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| EpisodeOfCare |
C | 0..* | EpisodeOfCare | GP practice registration information Constraints: inv-dh-epoc-03 |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| status |
?!SΣ | 1..1 | code | planned | waitlist | active | onhold | finished | cancelled | entered-in-error Binding: EpisodeOfCareStatus (required): The status of the episode of care. Fixed Value: active |
| Slices for type |
SΣ | 1..* | CodeableConcept | Type/class - e.g. specialist referral, disease management Slice: Unordered, Open by value:coding.code Binding: EpisodeOfCareType (example): The type of the episode of care. |
| type:primaryCare |
Σ | 1..1 | CodeableConcept | GP practice - primary care management Binding: EpisodeOfCareType (example): The type of the episode of care. Required Pattern: At least the following |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 737470001 | |
| display |
0..1 | string | Representation defined by the system | |
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
| text |
0..1 | string | Plain text representation of the concept | |
| patient |
SΣC | 1..1 | Reference(AU Core Patient) | The patient Constraints: inv-dh-epoc-01 |
| managingOrganization |
SΣC | 1..1 | Reference(AU Core Organization) | GP practice that is now, or was once, registered for the patient Constraints: inv-dh-epoc-02 |
| period |
SΣ | 1..1 | Period | Interval during responsibility is assumed |
| start |
SΣC | 1..1 | dateTime | Registration start date |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| EpisodeOfCare.status | required | Fixed Value: activehttp://hl7.org/fhir/ValueSet/episode-of-care-status|4.0.1From the FHIR Standard | |
| EpisodeOfCare.type | example | EpisodeOfCareTypehttp://hl7.org/fhir/ValueSet/episodeofcare-typeFrom the FHIR Standard | |
| EpisodeOfCare.type:primaryCare | example | Pattern Value: SNOMED-CT Code 737470001http://hl7.org/fhir/ValueSet/episodeofcare-typeFrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | EpisodeOfCare | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | EpisodeOfCare | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | EpisodeOfCare | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | EpisodeOfCare | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | EpisodeOfCare | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| inv-dh-epoc-01 | error | EpisodeOfCare.patient | At least reference or a valid identifier shall be present : reference.exists() or identifier.where(system.count() + value.count() >1).exists() | |
| inv-dh-epoc-02 | error | EpisodeOfCare.managingOrganization | At least reference or a valid identifier shall be present : reference.exists() or identifier.where(system.count() + value.count() >1).exists() | |
| inv-dh-epoc-03 | error | EpisodeOfCare | A patient's current GP practice shall not have a registration end date : (status = 'active') implies period.end.empty() |
Differential View
This structure is derived from EpisodeOfCare
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| EpisodeOfCare |
C | 0..* | EpisodeOfCare | GP practice registration information Constraints: inv-dh-epoc-03 |
| status |
S | 1..1 | code | planned | waitlist | active | onhold | finished | cancelled | entered-in-error Fixed Value: active |
| Slices for type |
S | 1..* | CodeableConcept | Type/class - e.g. specialist referral, disease management Slice: Unordered, Open by value:coding.code |
| type:primaryCare |
1..1 | CodeableConcept | GP practice - primary care management Required Pattern: At least the following | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 737470001 | |
| patient |
SC | 1..1 | Reference(AU Core Patient) | The patient Constraints: inv-dh-epoc-01 |
| managingOrganization |
SC | 1..1 | Reference(AU Core Organization) | GP practice that is now, or was once, registered for the patient Constraints: inv-dh-epoc-02 |
| period |
S | 1..1 | Period | Interval during responsibility is assumed |
| start |
SC | 1..1 | dateTime | Registration start date |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| inv-dh-epoc-01 | error | EpisodeOfCare.patient | At least reference or a valid identifier shall be present : reference.exists() or identifier.where(system.count() + value.count() >1).exists() | |
| inv-dh-epoc-02 | error | EpisodeOfCare.managingOrganization | At least reference or a valid identifier shall be present : reference.exists() or identifier.where(system.count() + value.count() >1).exists() | |
| inv-dh-epoc-03 | error | EpisodeOfCare | A patient's current GP practice shall not have a registration end date : (status = 'active') implies period.end.empty() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| EpisodeOfCare |
C | 0..* | EpisodeOfCare | GP practice registration information Constraints: inv-dh-epoc-03 | ||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
0..* | Identifier | Business Identifier(s) relevant for this EpisodeOfCare | |||||
| status |
?!SΣ | 1..1 | code | planned | waitlist | active | onhold | finished | cancelled | entered-in-error Binding: EpisodeOfCareStatus (required): The status of the episode of care. Fixed Value: active | ||||
| statusHistory |
0..* | BackboneElement | Past list of status codes (the current status may be included to cover the start date of the status) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| status |
1..1 | code | planned | waitlist | active | onhold | finished | cancelled | entered-in-error Binding: EpisodeOfCareStatus (required): The status of the episode of care. | |||||
| period |
1..1 | Period | Duration the EpisodeOfCare was in the specified status | |||||
| Slices for type |
SΣ | 1..* | CodeableConcept | Type/class - e.g. specialist referral, disease management Slice: Unordered, Open by value:coding.code Binding: EpisodeOfCareType (example): The type of the episode of care. | ||||
| type:primaryCare |
Σ | 1..1 | CodeableConcept | GP practice - primary care management Binding: EpisodeOfCareType (example): The type of the episode of care. Required Pattern: At least the following | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 737470001 | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| diagnosis |
Σ | 0..* | BackboneElement | The list of diagnosis relevant to this episode of care | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| condition |
Σ | 1..1 | Reference(Condition) | Conditions/problems/diagnoses this episode of care is for | ||||
| role |
Σ | 0..1 | CodeableConcept | Role that this diagnosis has within the episode of care (e.g. admission, billing, discharge …) Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents. | ||||
| rank |
Σ | 0..1 | positiveInt | Ranking of the diagnosis (for each role type) | ||||
| patient |
SΣC | 1..1 | Reference(AU Core Patient) | The patient Constraints: inv-dh-epoc-01 | ||||
| managingOrganization |
SΣC | 1..1 | Reference(AU Core Organization) | GP practice that is now, or was once, registered for the patient Constraints: inv-dh-epoc-02 | ||||
| period |
SΣ | 1..1 | Period | Interval during responsibility is assumed | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| start |
SΣC | 1..1 | dateTime | Registration start date | ||||
| end |
ΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
| referralRequest |
0..* | Reference(ServiceRequest) | Originating Referral Request(s) | |||||
| careManager |
0..1 | Reference(Practitioner | PractitionerRole) | Care manager/care coordinator for the patient | |||||
| team |
0..* | Reference(CareTeam) | Other practitioners facilitating this episode of care | |||||
| account |
0..* | Reference(Account) | The set of accounts that may be used for billing for this EpisodeOfCare | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| EpisodeOfCare.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard
| ||||
| EpisodeOfCare.status | required | Fixed Value: activehttp://hl7.org/fhir/ValueSet/episode-of-care-status|4.0.1From the FHIR Standard | ||||
| EpisodeOfCare.statusHistory.status | required | EpisodeOfCareStatushttp://hl7.org/fhir/ValueSet/episode-of-care-status|4.0.1From the FHIR Standard | ||||
| EpisodeOfCare.type | example | EpisodeOfCareTypehttp://hl7.org/fhir/ValueSet/episodeofcare-typeFrom the FHIR Standard | ||||
| EpisodeOfCare.type:primaryCare | example | Pattern Value: SNOMED-CT Code 737470001http://hl7.org/fhir/ValueSet/episodeofcare-typeFrom the FHIR Standard | ||||
| EpisodeOfCare.diagnosis.role | preferred | DiagnosisRolehttp://hl7.org/fhir/ValueSet/diagnosis-roleFrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | EpisodeOfCare | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | EpisodeOfCare | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | EpisodeOfCare | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | EpisodeOfCare | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | EpisodeOfCare | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| inv-dh-epoc-01 | error | EpisodeOfCare.patient | At least reference or a valid identifier shall be present : reference.exists() or identifier.where(system.count() + value.count() >1).exists() | |
| inv-dh-epoc-02 | error | EpisodeOfCare.managingOrganization | At least reference or a valid identifier shall be present : reference.exists() or identifier.where(system.count() + value.count() >1).exists() | |
| inv-dh-epoc-03 | error | EpisodeOfCare | A patient's current GP practice shall not have a registration end date : (status = 'active') implies period.end.empty() |
This structure is derived from EpisodeOfCare
Summary
Mandatory: 5 elements
Must-Support: 6 elements
Fixed: 1 element
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron
IG © 2025+ Australian Digital Health Agency. Package au.digitalhealth.r4#1.4.0 based on FHIR 4.0.1. Generated 2025-07-24
Links: Table of Contents | QA Report | Version History | Report an issue or propose a change
