Magentus Practice Management FHIR® Implementation Guide - Downloaded Version 1.3.2 See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• Examples
• JSON

Resource Profile: Genie HealthcareService

A service offered at a location by an organisation. In eBookings this is the hospital or day-surgery under which a theatre booking is made. Requires both the providing Organization and the Location where the service is delivered, each with a display name, and can carry a hospital provider number.

Usages:

• Use this Profile: EBookings Theatre List Bundle
• Refer to this Profile: EBookings Appointment Base, EBookings Appointment Response, EBookings Theatre List Composition, EOrders Task Fulfillment Request Base... Show 2 more, Referral Request and Referral Fulfilment Task
• Examples for this Profile: Ashford Private Hospital
• CapabilityStatements using this Profile: Genie Solutions eBookings Capability Statement and Genie Solutions eOrders Capability Statement

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

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

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
HealthcareService		0..*	AUCoreHealthcareService	A healthcare service in an Australian healthcare context
id	SΣ	0..1	id	Logical id of this artifact
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	SOΣ	0..*	Identifier, AUHPIO, AUResidentialAgedCareServiceIdentifier	External identifiers for this item Slice: Unordered, Closed by pattern:type Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core HealthcareService SHALL:no-error AU Core Requester from AU Core HealthcareService
identifier:hospitalcode	SOΣ	0..1	GSHospitalProviderNumber	External identifiers for this item Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core HealthcareService SHALL:no-error AU Core Requester from AU Core HealthcareService
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
text		0..1	string	Plain text representation of the concept
coding	Σ	1..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://terminology.hl7.org/CodeSystem/v2-0203
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: PRN
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
value	Σ	1..1	string	Hospital Provider Number Example General: 123456
active	?!SΣ	1..1	boolean	Whether this HealthcareService record is in active use
providedBy	SΣ	1..1	Reference(Genie Organization)	Providing organization
display	Σ	1..1	string	Providing organization name
type	SOΣ	0..*	CodeableConcept	Type of service that may be delivered or performed Binding: Service Type (extensible) Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core HealthcareService SHALL:no-error AU Core Requester from AU Core HealthcareService
location	Σ	1..1	Reference(Genie Location)	Location(s) where service may be provided
display	Σ	1..1	string	Location name
name	SOΣ	1..1	string	Health service name Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core HealthcareService SHALL:no-error AU Core Requester from AU Core HealthcareService
telecom	SO	0..*	ContactPoint	Contacts related to the healthcare service Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core HealthcareService SHALL:no-error AU Core Requester from AU Core HealthcareService
Documentation for this format

Name	AU Core Responder	AU Core Requester
HealthcareService
Slices for identifier	SHALL:populate-if-known	SHALL:no-error
identifier:hospitalcode	SHALL:populate-if-known	SHALL:no-error
type	SHALL:populate-if-known	SHALL:no-error
name	SHALL:populate-if-known	SHALL:no-error
telecom	SHALL:populate-if-known	SHALL:no-error
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
HealthcareService.identifier:hospitalcode.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
HealthcareService.identifier:hospitalcode.​type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
HealthcareService.type	Base	extensible	Service Type	⏿1.0.0	tx.hl7.org.au

Constraints

Id	Grade	Path(s)	Description	Expression
dom-2	error	HealthcareService	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	HealthcareService	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	HealthcareService	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	HealthcareService	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	HealthcareService	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()

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
HealthcareService			AUCoreHealthcareService
id	S	0..1	id	Logical id of this artifact
Slices for identifier		0..*	Identifier, AUHPIO, AUResidentialAgedCareServiceIdentifier	External identifiers for this item Slice: Unordered, Closed by pattern:type
identifier:hospitalcode	S	0..1	GSHospitalProviderNumber	External identifiers for this item
type
coding		1..1	Coding	Code defined by a terminology system
active	S	1..1	boolean	Whether this HealthcareService record is in active use
providedBy	S	1..1	Reference(Genie Organization)	Providing organization
display		1..1	string	Providing organization name
location		1..1	Reference(Genie Location)	Location(s) where service may be provided
display		1..1	string	Location name
name		1..1	string	Health service name
Documentation for this format

Name
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
HealthcareService		0..*	AUCoreHealthcareService	A healthcare service in an Australian healthcare context
id	SΣ	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 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
Slices for identifier	SOΣ	0..*	Identifier, AUHPIO, AUResidentialAgedCareServiceIdentifier	External identifiers for this item Slice: Unordered, Closed by pattern:type Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core HealthcareService SHALL:no-error AU Core Requester from AU Core HealthcareService
identifier:hospitalcode	SOΣ	0..1	GSHospitalProviderNumber	External identifiers for this item Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core HealthcareService SHALL:no-error AU Core Requester from AU Core HealthcareService
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	1..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://terminology.hl7.org/CodeSystem/v2-0203
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: PRN
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
system	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	Hospital Provider Number Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
active	?!SΣ	1..1	boolean	Whether this HealthcareService record is in active use
providedBy	SΣ	1..1	Reference(Genie Organization)	Providing organization
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	1..1	string	Providing organization name
category	Σ	0..*	CodeableConcept	Broad category of service being performed or delivered Binding: ServiceCategory (example): A category of the service(s) that could be provided.
type	SOΣ	0..*	CodeableConcept	Type of service that may be delivered or performed Binding: Service Type (extensible) Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core HealthcareService SHALL:no-error AU Core Requester from AU Core HealthcareService
specialty	Σ	0..*	CodeableConcept	Specialties handled by the HealthcareService Binding: Clinical Specialty (preferred)
location	Σ	1..1	Reference(Genie Location)	Location(s) where service may be provided
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	1..1	string	Location name
name	SOΣ	1..1	string	Health service name Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core HealthcareService SHALL:no-error AU Core Requester from AU Core HealthcareService
comment	Σ	0..1	string	Additional description and/or any specific issues not covered elsewhere
extraDetails		0..1	markdown	Extra details about the service that can't be placed in the other fields
photo	Σ	0..1	Attachment	Facilitates quick identification of the service
telecom	SO	0..*	ContactPoint	Contacts related to the healthcare service Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core HealthcareService SHALL:no-error AU Core Requester from AU Core HealthcareService
coverageArea		0..*	Reference(Location)	Location(s) service is intended for/available to
serviceProvisionCode		0..*	CodeableConcept	Conditions under which service is available/offered Binding: Service Provision Conditions Australian Concepts (preferred)
eligibility		0..*	BackboneElement	Specific eligibility requirements required to use the service
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
code		0..1	CodeableConcept	Coded value for the eligibility Binding Description: (example): Coded values underwhich a specific service is made available.
comment		0..1	markdown	Describes the eligibility conditions for the service
program		0..*	CodeableConcept	Programs that this service is applicable to Binding: Program (example): Government or local programs that this service applies to.
characteristic		0..*	CodeableConcept	Collection of characteristics (attributes) Binding Description: (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy).
communication		0..*	CodeableConcept	The language that this service is offered in Binding: Common Languages in Australia (extensible)
referralMethod		0..*	CodeableConcept	Ways that the service accepts referrals Binding: ReferralMethod (example): The methods of referral can be used when referring to a specific HealthCareService resource.
appointmentRequired		0..1	boolean	If an appointment is required for access to this service
availableTime		0..*	BackboneElement	Times the Service Site is available
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
daysOfWeek		0..*	code	mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week.
allDay		0..1	boolean	Always available? e.g. 24 hour service
availableStartTime		0..1	time	Opening time of day (ignored if allDay = true)
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:timeZone		0..1	code	IANA Timezone Code per BCP 175 URL: http://hl7.org/fhir/StructureDefinition/timezone Binding: IANATimezones (required): IANA Timezones (BCP 175)
value		0..1	time	Primitive value for time
availableEndTime		0..1	time	Closing time of day (ignored if allDay = true)
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:timeZone		0..1	code	IANA Timezone Code per BCP 175 URL: http://hl7.org/fhir/StructureDefinition/timezone Binding: IANATimezones (required): IANA Timezones (BCP 175)
value		0..1	time	Primitive value for time
notAvailable		0..*	BackboneElement	Not available during this time due to provided reason
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
description		1..1	string	Reason presented to the user explaining why time not available
during		0..1	Period	Service not available from this date
availabilityExceptions		0..1	string	Description of availability exceptions
endpoint		0..*	Reference(Endpoint)	Technical endpoints providing access to electronic services operated for the healthcare service
Documentation for this format

Name	AU Core Responder	AU Core Requester
HealthcareService
Slices for identifier	SHALL:populate-if-known	SHALL:no-error
identifier:hospitalcode	SHALL:populate-if-known	SHALL:no-error
type	SHALL:populate-if-known	SHALL:no-error
name	SHALL:populate-if-known	SHALL:no-error
telecom	SHALL:populate-if-known	SHALL:no-error
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
HealthcareService.language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
HealthcareService.identifier:hospitalcode.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
HealthcareService.identifier:hospitalcode.​type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
HealthcareService.providedBy.​type	Base	extensible	ResourceType	📍4.0.1	FHIR Std.
HealthcareService.category	Base	example	Service category	📍4.0.1	FHIR Std.
HealthcareService.type	Base	extensible	Service Type	⏿1.0.0	tx.hl7.org.au
HealthcareService.specialty	Base	preferred	Clinical Specialty	⏿1.1.0	tx.hl7.org.au
HealthcareService.location.​type	Base	extensible	ResourceType	📍4.0.1	FHIR Std.
HealthcareService.serviceProvisionCode	Base	preferred	Service Provision Conditions Australian Concepts	📦6.0.0	AU Base Implementation Guide v6.0
HealthcareService.eligibility.​code	Base	example		Not State	Unknown
HealthcareService.program	Base	example	Program	📍4.0.1	FHIR Std.
HealthcareService.characteristic	Base	example		Not State	Unknown
HealthcareService.communication	Base	extensible	Common Languages in Australia	⏿2.2.1	tx.hl7.org.au
HealthcareService.referralMethod	Base	example	ReferralMethod	📍4.0.1	FHIR Std.
HealthcareService.availableTime.​daysOfWeek	Base	required	DaysOfWeek	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
dom-2	error	HealthcareService	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	HealthcareService	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	HealthcareService	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	HealthcareService	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	HealthcareService	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()

Name	AU Core Responder	AU Core Requester
HealthcareService
Slices for identifier	SHALL:populate-if-known	SHALL:no-error
identifier:hospitalcode	SHALL:populate-if-known	SHALL:no-error
type	SHALL:populate-if-known	SHALL:no-error
name	SHALL:populate-if-known	SHALL:no-error
telecom	SHALL:populate-if-known	SHALL:no-error
Documentation for this format

Summary

Mandatory: 5 elements(1 nested mandatory element)
Must-Support: 4 elements

Structures

This structure refers to these other structures:

• Australian Hospital Provider Number (http://fhir.geniesolutions.io/StructureDefinition/gs-hospitalprovidernumber)
• Genie Organization (http://fhir.geniesolutions.io/StructureDefinition/gs-organization)
• Genie Location (http://fhir.geniesolutions.io/StructureDefinition/gs-location)

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of HealthcareService.identifier (Closed)

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
HealthcareService		0..*	AUCoreHealthcareService	A healthcare service in an Australian healthcare context
id	SΣ	0..1	id	Logical id of this artifact
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	SOΣ	0..*	Identifier, AUHPIO, AUResidentialAgedCareServiceIdentifier	External identifiers for this item Slice: Unordered, Closed by pattern:type Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core HealthcareService SHALL:no-error AU Core Requester from AU Core HealthcareService
identifier:hospitalcode	SOΣ	0..1	GSHospitalProviderNumber	External identifiers for this item Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core HealthcareService SHALL:no-error AU Core Requester from AU Core HealthcareService
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
text		0..1	string	Plain text representation of the concept
coding	Σ	1..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://terminology.hl7.org/CodeSystem/v2-0203
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: PRN
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
value	Σ	1..1	string	Hospital Provider Number Example General: 123456
active	?!SΣ	1..1	boolean	Whether this HealthcareService record is in active use
providedBy	SΣ	1..1	Reference(Genie Organization)	Providing organization
display	Σ	1..1	string	Providing organization name
type	SOΣ	0..*	CodeableConcept	Type of service that may be delivered or performed Binding: Service Type (extensible) Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core HealthcareService SHALL:no-error AU Core Requester from AU Core HealthcareService
location	Σ	1..1	Reference(Genie Location)	Location(s) where service may be provided
display	Σ	1..1	string	Location name
name	SOΣ	1..1	string	Health service name Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core HealthcareService SHALL:no-error AU Core Requester from AU Core HealthcareService
telecom	SO	0..*	ContactPoint	Contacts related to the healthcare service Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core HealthcareService SHALL:no-error AU Core Requester from AU Core HealthcareService
Documentation for this format

Name	AU Core Responder	AU Core Requester
HealthcareService
Slices for identifier	SHALL:populate-if-known	SHALL:no-error
identifier:hospitalcode	SHALL:populate-if-known	SHALL:no-error
type	SHALL:populate-if-known	SHALL:no-error
name	SHALL:populate-if-known	SHALL:no-error
telecom	SHALL:populate-if-known	SHALL:no-error
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
HealthcareService.identifier:hospitalcode.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
HealthcareService.identifier:hospitalcode.​type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
HealthcareService.type	Base	extensible	Service Type	⏿1.0.0	tx.hl7.org.au

Constraints

Id	Grade	Path(s)	Description	Expression
dom-2	error	HealthcareService	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	HealthcareService	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	HealthcareService	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	HealthcareService	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	HealthcareService	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()

Differential View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
HealthcareService			AUCoreHealthcareService
id	S	0..1	id	Logical id of this artifact
Slices for identifier		0..*	Identifier, AUHPIO, AUResidentialAgedCareServiceIdentifier	External identifiers for this item Slice: Unordered, Closed by pattern:type
identifier:hospitalcode	S	0..1	GSHospitalProviderNumber	External identifiers for this item
type
coding		1..1	Coding	Code defined by a terminology system
active	S	1..1	boolean	Whether this HealthcareService record is in active use
providedBy	S	1..1	Reference(Genie Organization)	Providing organization
display		1..1	string	Providing organization name
location		1..1	Reference(Genie Location)	Location(s) where service may be provided
display		1..1	string	Location name
name		1..1	string	Health service name
Documentation for this format

Name
Documentation for this format

Snapshot ViewView

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
HealthcareService		0..*	AUCoreHealthcareService	A healthcare service in an Australian healthcare context
id	SΣ	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 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
Slices for identifier	SOΣ	0..*	Identifier, AUHPIO, AUResidentialAgedCareServiceIdentifier	External identifiers for this item Slice: Unordered, Closed by pattern:type Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core HealthcareService SHALL:no-error AU Core Requester from AU Core HealthcareService
identifier:hospitalcode	SOΣ	0..1	GSHospitalProviderNumber	External identifiers for this item Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core HealthcareService SHALL:no-error AU Core Requester from AU Core HealthcareService
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	1..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://terminology.hl7.org/CodeSystem/v2-0203
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: PRN
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
system	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	Hospital Provider Number Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
active	?!SΣ	1..1	boolean	Whether this HealthcareService record is in active use
providedBy	SΣ	1..1	Reference(Genie Organization)	Providing organization
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	1..1	string	Providing organization name
category	Σ	0..*	CodeableConcept	Broad category of service being performed or delivered Binding: ServiceCategory (example): A category of the service(s) that could be provided.
type	SOΣ	0..*	CodeableConcept	Type of service that may be delivered or performed Binding: Service Type (extensible) Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core HealthcareService SHALL:no-error AU Core Requester from AU Core HealthcareService
specialty	Σ	0..*	CodeableConcept	Specialties handled by the HealthcareService Binding: Clinical Specialty (preferred)
location	Σ	1..1	Reference(Genie Location)	Location(s) where service may be provided
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	1..1	string	Location name
name	SOΣ	1..1	string	Health service name Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core HealthcareService SHALL:no-error AU Core Requester from AU Core HealthcareService
comment	Σ	0..1	string	Additional description and/or any specific issues not covered elsewhere
extraDetails		0..1	markdown	Extra details about the service that can't be placed in the other fields
photo	Σ	0..1	Attachment	Facilitates quick identification of the service
telecom	SO	0..*	ContactPoint	Contacts related to the healthcare service Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core HealthcareService SHALL:no-error AU Core Requester from AU Core HealthcareService
coverageArea		0..*	Reference(Location)	Location(s) service is intended for/available to
serviceProvisionCode		0..*	CodeableConcept	Conditions under which service is available/offered Binding: Service Provision Conditions Australian Concepts (preferred)
eligibility		0..*	BackboneElement	Specific eligibility requirements required to use the service
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
code		0..1	CodeableConcept	Coded value for the eligibility Binding Description: (example): Coded values underwhich a specific service is made available.
comment		0..1	markdown	Describes the eligibility conditions for the service
program		0..*	CodeableConcept	Programs that this service is applicable to Binding: Program (example): Government or local programs that this service applies to.
characteristic		0..*	CodeableConcept	Collection of characteristics (attributes) Binding Description: (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy).
communication		0..*	CodeableConcept	The language that this service is offered in Binding: Common Languages in Australia (extensible)
referralMethod		0..*	CodeableConcept	Ways that the service accepts referrals Binding: ReferralMethod (example): The methods of referral can be used when referring to a specific HealthCareService resource.
appointmentRequired		0..1	boolean	If an appointment is required for access to this service
availableTime		0..*	BackboneElement	Times the Service Site is available
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
daysOfWeek		0..*	code	mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week.
allDay		0..1	boolean	Always available? e.g. 24 hour service
availableStartTime		0..1	time	Opening time of day (ignored if allDay = true)
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:timeZone		0..1	code	IANA Timezone Code per BCP 175 URL: http://hl7.org/fhir/StructureDefinition/timezone Binding: IANATimezones (required): IANA Timezones (BCP 175)
value		0..1	time	Primitive value for time
availableEndTime		0..1	time	Closing time of day (ignored if allDay = true)
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:timeZone		0..1	code	IANA Timezone Code per BCP 175 URL: http://hl7.org/fhir/StructureDefinition/timezone Binding: IANATimezones (required): IANA Timezones (BCP 175)
value		0..1	time	Primitive value for time
notAvailable		0..*	BackboneElement	Not available during this time due to provided reason
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
description		1..1	string	Reason presented to the user explaining why time not available
during		0..1	Period	Service not available from this date
availabilityExceptions		0..1	string	Description of availability exceptions
endpoint		0..*	Reference(Endpoint)	Technical endpoints providing access to electronic services operated for the healthcare service
Documentation for this format

Name	AU Core Responder	AU Core Requester
HealthcareService
Slices for identifier	SHALL:populate-if-known	SHALL:no-error
identifier:hospitalcode	SHALL:populate-if-known	SHALL:no-error
type	SHALL:populate-if-known	SHALL:no-error
name	SHALL:populate-if-known	SHALL:no-error
telecom	SHALL:populate-if-known	SHALL:no-error
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
HealthcareService.language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
HealthcareService.identifier:hospitalcode.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
HealthcareService.identifier:hospitalcode.​type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
HealthcareService.providedBy.​type	Base	extensible	ResourceType	📍4.0.1	FHIR Std.
HealthcareService.category	Base	example	Service category	📍4.0.1	FHIR Std.
HealthcareService.type	Base	extensible	Service Type	⏿1.0.0	tx.hl7.org.au
HealthcareService.specialty	Base	preferred	Clinical Specialty	⏿1.1.0	tx.hl7.org.au
HealthcareService.location.​type	Base	extensible	ResourceType	📍4.0.1	FHIR Std.
HealthcareService.serviceProvisionCode	Base	preferred	Service Provision Conditions Australian Concepts	📦6.0.0	AU Base Implementation Guide v6.0
HealthcareService.eligibility.​code	Base	example		Not State	Unknown
HealthcareService.program	Base	example	Program	📍4.0.1	FHIR Std.
HealthcareService.characteristic	Base	example		Not State	Unknown
HealthcareService.communication	Base	extensible	Common Languages in Australia	⏿2.2.1	tx.hl7.org.au
HealthcareService.referralMethod	Base	example	ReferralMethod	📍4.0.1	FHIR Std.
HealthcareService.availableTime.​daysOfWeek	Base	required	DaysOfWeek	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
dom-2	error	HealthcareService	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	HealthcareService	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	HealthcareService	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	HealthcareService	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	HealthcareService	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()

Name	AU Core Responder	AU Core Requester
HealthcareService
Slices for identifier	SHALL:populate-if-known	SHALL:no-error
identifier:hospitalcode	SHALL:populate-if-known	SHALL:no-error
type	SHALL:populate-if-known	SHALL:no-error
name	SHALL:populate-if-known	SHALL:no-error
telecom	SHALL:populate-if-known	SHALL:no-error
Documentation for this format

Summary

Mandatory: 5 elements(1 nested mandatory element)
Must-Support: 4 elements

Structures

This structure refers to these other structures:

• Australian Hospital Provider Number (http://fhir.geniesolutions.io/StructureDefinition/gs-hospitalprovidernumber)
• Genie Organization (http://fhir.geniesolutions.io/StructureDefinition/gs-organization)
• Genie Location (http://fhir.geniesolutions.io/StructureDefinition/gs-location)

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of HealthcareService.identifier (Closed)

Other representations of profile: CSV, Excel, Schematron