Australian Digital Health Agency FHIR
1.2.0-ci-build - draft Australia flag

Australian Digital Health Agency FHIR, published by Australian Digital Health Agency. This guide is not an authorized publication; it is the continuous build for version 1.2.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/AuDigitalHealth/mcv/ and changes regularly. See the Directory of published versions

Resource Profile: ADHA GP Practice Registration Entry

Official URL: http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-episodeofcare-mymedicare-1 Version: 1.0.0
Active as of 2024-09-16 Computable Name: ADHAEpisodeOfCareMyMedicare

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.

This profile identifies the additional constraints, extensions, and value sets that build on and extend EpisodeOfCare that are supported.

This profile is designed to set an EpisodeOfCare standard for:

  • Query for a patient's registered GP practice information from MyMedicare
  • Reading a patient’s registered GP practice information from MyMedicare

Profile specific guidance

  • Information about the GP Practice is represented with an Organization resource that is referenced in EpisodeOfCare.managingOrganization and Patient.generalPractitioner, see example Patient's registered GP practice
  • Practitioner name is represented in Patient.generalPractitioner.display with Patient.generalPractitioner.type="PractitionerRole", see example Patient's registered GP practice and practitioner name
  • In an exchange with the My Health Record system the set of resources that make up patient GP practice registration information are collected in a Bundle.

Usage:

  • This Resource Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from EpisodeOfCare

NameFlagsCard.TypeDescription & Constraintsdoco
.. EpisodeOfCare C 0..* EpisodeOfCare GP practice registration information
inv-dh-epoc-03: A patient's current GP practice shall not have a registration end date
... 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 pattern:$this
.... 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(ADHA Core Patient) The patient
inv-dh-epoc-01: At least reference or a valid identifier shall be present
... period S 1..1 Period Interval during responsibility is assumed
.... start SC 1..1 dateTime Registration start date

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
inv-dh-epoc-01errorEpisodeOfCare.patientAt least reference or a valid identifier shall be present
: reference.exists() or identifier.where(system.count() + value.count() >1).exists()
inv-dh-epoc-02errorEpisodeOfCare.managingOrganizationAt least reference or a valid identifier shall be present
: reference.exists() or identifier.where(system.count() + value.count() >1).exists()
inv-dh-epoc-03errorEpisodeOfCareA patient's current GP practice shall not have a registration end date
: (status = 'active') implies period.end.empty()
NameFlagsCard.TypeDescription & Constraintsdoco
.. EpisodeOfCare C 0..* EpisodeOfCare GP practice registration information
inv-dh-epoc-03: A patient's current GP practice shall not have a registration end date
... 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
.... 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
..... 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 SΣC 1..1 Reference(ADHA Core Patient) The patient
inv-dh-epoc-01: At least reference or a valid identifier shall be present
... managingOrganization SΣC 1..1 Reference(ADHA Core Organization) GP practice that is now, or was once, registered for the patient
inv-dh-epoc-02: At least reference or a valid identifier shall be present
... period SΣ 1..1 Period Interval during responsibility is assumed
.... start SΣC 1..1 dateTime Registration start date

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
EpisodeOfCare.statusrequiredFixed Value: active
http://hl7.org/fhir/ValueSet/episode-of-care-status|4.0.1
from the FHIR Standard
EpisodeOfCare.typeexampleEpisodeOfCareType
http://hl7.org/fhir/ValueSet/episodeofcare-type
from the FHIR Standard
EpisodeOfCare.type:primaryCareexamplePattern: SNOMED-CT Code 737470001
http://hl7.org/fhir/ValueSet/episodeofcare-type
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
inv-dh-epoc-01errorEpisodeOfCare.patientAt least reference or a valid identifier shall be present
: reference.exists() or identifier.where(system.count() + value.count() >1).exists()
inv-dh-epoc-02errorEpisodeOfCare.managingOrganizationAt least reference or a valid identifier shall be present
: reference.exists() or identifier.where(system.count() + value.count() >1).exists()
inv-dh-epoc-03errorEpisodeOfCareA patient's current GP practice shall not have a registration end date
: (status = 'active') implies period.end.empty()
NameFlagsCard.TypeDescription & Constraintsdoco
.. EpisodeOfCare C 0..* EpisodeOfCare GP practice registration information
inv-dh-epoc-03: A patient's current GP practice shall not have a registration end date
... 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
... 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 pattern:$this
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(ADHA Core Patient) The patient
inv-dh-epoc-01: At least reference or a valid identifier shall be present
... managingOrganization SΣC 1..1 Reference(ADHA Core Organization) GP practice that is now, or was once, registered for the patient
inv-dh-epoc-02: At least reference or a valid identifier shall be present
... 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
EpisodeOfCare.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
EpisodeOfCare.statusrequiredFixed Value: active
http://hl7.org/fhir/ValueSet/episode-of-care-status|4.0.1
from the FHIR Standard
EpisodeOfCare.statusHistory.statusrequiredEpisodeOfCareStatus
http://hl7.org/fhir/ValueSet/episode-of-care-status|4.0.1
from the FHIR Standard
EpisodeOfCare.typeexampleEpisodeOfCareType
http://hl7.org/fhir/ValueSet/episodeofcare-type
from the FHIR Standard
EpisodeOfCare.type:primaryCareexamplePattern: SNOMED-CT Code 737470001
http://hl7.org/fhir/ValueSet/episodeofcare-type
from the FHIR Standard
EpisodeOfCare.diagnosis.rolepreferredDiagnosisRole
http://hl7.org/fhir/ValueSet/diagnosis-role
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
inv-dh-epoc-01errorEpisodeOfCare.patientAt least reference or a valid identifier shall be present
: reference.exists() or identifier.where(system.count() + value.count() >1).exists()
inv-dh-epoc-02errorEpisodeOfCare.managingOrganizationAt least reference or a valid identifier shall be present
: reference.exists() or identifier.where(system.count() + value.count() >1).exists()
inv-dh-epoc-03errorEpisodeOfCareA 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:

  • The element 1 is sliced based on the value of EpisodeOfCare.type

Differential View

This structure is derived from EpisodeOfCare

NameFlagsCard.TypeDescription & Constraintsdoco
.. EpisodeOfCare C 0..* EpisodeOfCare GP practice registration information
inv-dh-epoc-03: A patient's current GP practice shall not have a registration end date
... 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 pattern:$this
.... 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(ADHA Core Patient) The patient
inv-dh-epoc-01: At least reference or a valid identifier shall be present
... period S 1..1 Period Interval during responsibility is assumed
.... start SC 1..1 dateTime Registration start date

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
inv-dh-epoc-01errorEpisodeOfCare.patientAt least reference or a valid identifier shall be present
: reference.exists() or identifier.where(system.count() + value.count() >1).exists()
inv-dh-epoc-02errorEpisodeOfCare.managingOrganizationAt least reference or a valid identifier shall be present
: reference.exists() or identifier.where(system.count() + value.count() >1).exists()
inv-dh-epoc-03errorEpisodeOfCareA patient's current GP practice shall not have a registration end date
: (status = 'active') implies period.end.empty()

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. EpisodeOfCare C 0..* EpisodeOfCare GP practice registration information
inv-dh-epoc-03: A patient's current GP practice shall not have a registration end date
... 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
.... 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
..... 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 SΣC 1..1 Reference(ADHA Core Patient) The patient
inv-dh-epoc-01: At least reference or a valid identifier shall be present
... managingOrganization SΣC 1..1 Reference(ADHA Core Organization) GP practice that is now, or was once, registered for the patient
inv-dh-epoc-02: At least reference or a valid identifier shall be present
... period SΣ 1..1 Period Interval during responsibility is assumed
.... start SΣC 1..1 dateTime Registration start date

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
EpisodeOfCare.statusrequiredFixed Value: active
http://hl7.org/fhir/ValueSet/episode-of-care-status|4.0.1
from the FHIR Standard
EpisodeOfCare.typeexampleEpisodeOfCareType
http://hl7.org/fhir/ValueSet/episodeofcare-type
from the FHIR Standard
EpisodeOfCare.type:primaryCareexamplePattern: SNOMED-CT Code 737470001
http://hl7.org/fhir/ValueSet/episodeofcare-type
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
inv-dh-epoc-01errorEpisodeOfCare.patientAt least reference or a valid identifier shall be present
: reference.exists() or identifier.where(system.count() + value.count() >1).exists()
inv-dh-epoc-02errorEpisodeOfCare.managingOrganizationAt least reference or a valid identifier shall be present
: reference.exists() or identifier.where(system.count() + value.count() >1).exists()
inv-dh-epoc-03errorEpisodeOfCareA patient's current GP practice shall not have a registration end date
: (status = 'active') implies period.end.empty()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. EpisodeOfCare C 0..* EpisodeOfCare GP practice registration information
inv-dh-epoc-03: A patient's current GP practice shall not have a registration end date
... 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
... 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 pattern:$this
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(ADHA Core Patient) The patient
inv-dh-epoc-01: At least reference or a valid identifier shall be present
... managingOrganization SΣC 1..1 Reference(ADHA Core Organization) GP practice that is now, or was once, registered for the patient
inv-dh-epoc-02: At least reference or a valid identifier shall be present
... 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
EpisodeOfCare.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
EpisodeOfCare.statusrequiredFixed Value: active
http://hl7.org/fhir/ValueSet/episode-of-care-status|4.0.1
from the FHIR Standard
EpisodeOfCare.statusHistory.statusrequiredEpisodeOfCareStatus
http://hl7.org/fhir/ValueSet/episode-of-care-status|4.0.1
from the FHIR Standard
EpisodeOfCare.typeexampleEpisodeOfCareType
http://hl7.org/fhir/ValueSet/episodeofcare-type
from the FHIR Standard
EpisodeOfCare.type:primaryCareexamplePattern: SNOMED-CT Code 737470001
http://hl7.org/fhir/ValueSet/episodeofcare-type
from the FHIR Standard
EpisodeOfCare.diagnosis.rolepreferredDiagnosisRole
http://hl7.org/fhir/ValueSet/diagnosis-role
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
inv-dh-epoc-01errorEpisodeOfCare.patientAt least reference or a valid identifier shall be present
: reference.exists() or identifier.where(system.count() + value.count() >1).exists()
inv-dh-epoc-02errorEpisodeOfCare.managingOrganizationAt least reference or a valid identifier shall be present
: reference.exists() or identifier.where(system.count() + value.count() >1).exists()
inv-dh-epoc-03errorEpisodeOfCareA 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:

  • The element 1 is sliced based on the value of EpisodeOfCare.type

 

Other representations of profile: CSV, Excel, Schematron