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

This profile may be referred to by APIs, which will be listed here when available.

Profile specific guidance

• Information about the GP Practice is represented with an Organization resource that is referenced in EpisodeOfCare.managingOrganization and Patient.generalPractitioner
• 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

Boundaries and relationships

This profile is not referenced by another profile in this implementation guide.

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from EpisodeOfCare

Name	Flags	Card.	Type	Description & Constraints
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
managingOrganization	SC	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	SC	1..1	dateTime	Registration start date
Documentation for this format

Constraints

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
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
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
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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
EpisodeOfCare.status	required	Fixed Value: active http://hl7.org/fhir/ValueSet/episode-of-care-status|4.0.1 from the FHIR Standard
EpisodeOfCare.type	example	EpisodeOfCareType http://hl7.org/fhir/ValueSet/episodeofcare-type from the FHIR Standard
EpisodeOfCare.type:primaryCare	example	Pattern: SNOMED-CT Code 737470001 http://hl7.org/fhir/ValueSet/episodeofcare-type from the FHIR Standard

Constraints

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
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
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
EpisodeOfCare.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
EpisodeOfCare.status	required	Fixed Value: active http://hl7.org/fhir/ValueSet/episode-of-care-status|4.0.1 from the FHIR Standard
EpisodeOfCare.statusHistory.status	required	EpisodeOfCareStatus http://hl7.org/fhir/ValueSet/episode-of-care-status|4.0.1 from the FHIR Standard
EpisodeOfCare.type	example	EpisodeOfCareType http://hl7.org/fhir/ValueSet/episodeofcare-type from the FHIR Standard
EpisodeOfCare.type:primaryCare	example	Pattern: SNOMED-CT Code 737470001 http://hl7.org/fhir/ValueSet/episodeofcare-type from the FHIR Standard
EpisodeOfCare.diagnosis.role	preferred	DiagnosisRole http://hl7.org/fhir/ValueSet/diagnosis-role from the FHIR Standard

Constraints

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()

Differential View

This structure is derived from EpisodeOfCare

Name	Flags	Card.	Type	Description & Constraints
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
managingOrganization	SC	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	SC	1..1	dateTime	Registration start date
Documentation for this format

Constraints

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()

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
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
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
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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
EpisodeOfCare.status	required	Fixed Value: active http://hl7.org/fhir/ValueSet/episode-of-care-status|4.0.1 from the FHIR Standard
EpisodeOfCare.type	example	EpisodeOfCareType http://hl7.org/fhir/ValueSet/episodeofcare-type from the FHIR Standard
EpisodeOfCare.type:primaryCare	example	Pattern: SNOMED-CT Code 737470001 http://hl7.org/fhir/ValueSet/episodeofcare-type from the FHIR Standard

Constraints

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
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
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
EpisodeOfCare.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
EpisodeOfCare.status	required	Fixed Value: active http://hl7.org/fhir/ValueSet/episode-of-care-status|4.0.1 from the FHIR Standard
EpisodeOfCare.statusHistory.status	required	EpisodeOfCareStatus http://hl7.org/fhir/ValueSet/episode-of-care-status|4.0.1 from the FHIR Standard
EpisodeOfCare.type	example	EpisodeOfCareType http://hl7.org/fhir/ValueSet/episodeofcare-type from the FHIR Standard
EpisodeOfCare.type:primaryCare	example	Pattern: SNOMED-CT Code 737470001 http://hl7.org/fhir/ValueSet/episodeofcare-type from the FHIR Standard
EpisodeOfCare.diagnosis.role	preferred	DiagnosisRole http://hl7.org/fhir/ValueSet/diagnosis-role from the FHIR Standard

Constraints

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()

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:

• ADHA Core Patient (http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-patient-core-1)
• ADHA Core Organization (http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-organization-core-1)

Slices

This structure defines the following Slices:

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

Below is an overview of the mandatory and optional search parameters. FHIR search operations and the syntax used to describe the interactions is described here.

Mandatory Search Parameters

The following search parameters and search parameter combinations SHALL be supported:

1. SHALL support searching for all consent statements for a patient using the patient:identifier search parameter:

   GET [base]/EpisodeOfCare?patient:identifier={system|}[code]

   Example:

    GET [base]/EpisodeOfCare?patient:identifier=http://ns.electronichealth.net.au/id/hi/ihi/1.0|8003608000228437
   

   Implementation Notes: Fetches a bundle of all EpisodeOfCare resources for the specified patient (how to search by :identifier)

2. SHALL support searching using the combination patient:identifier and status search parameter:
   • including support for OR search on status (e.g.status={system|}[code],{system|}[code],...)

   GET [base]/EpisodeOfCare?patient:identifier={system|}[code]&status={system|}[code]

   Example:

    GET [base]/EpisodeOfCare?patient:identifier=http://ns.electronichealth.net.au/id/hi/ihi/1.0|8003608000228437&status=active
   

   Implementation Notes: Fetches a bundle of the active EpisodeOfCare resources for the specified patient (how to search by :identifier and how to search by token)

3. SHOULD support searching using the combination of the patient:identifier and date and status search parameters:
   • including support for OR search on status (e.g.status={system|}[code],{system|}[code],...)

   GET [base]/EpisodeOfCare?patient:identifier={system|}[code]&date=[date]&status={system|}[code]

   Example:

    GET [base]/EpisodeOfCare?patient:identifier=http://ns.electronichealth.net.au/id/hi/ihi/1.0|8003608000228437&date=ge2013-03-14&status=active
   

   Implementation Notes: Fetches a bundle of all active EpisodeOfCare resources for the specified patient that have a date greater than or equal to 21st Jan 2013. (how to search by :identifier and how to search by date)