Australian Provider Directory Implementation Guide (PD 2)

This page is part of the Australian Provider Directory IG (v2.0.1: PD 2 on FHIR R4) based on FHIR R4. This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

D.4.1.4 StructureDefinition: - Detailed Descriptions

Definitions for the StructureDefinition-au-pd-healthcareservice Profile.

1. HealthcareService
Definition

The details of a healthcare service for directory use.

Control0..*
InvariantsDefined on this element
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (: contained.contained.empty())
dom-3: 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: 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: If a resource is contained in another resource, it SHALL NOT have a security label (: contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (: text.div.exists())
2. HealthcareService.id
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Control0..1
Typeid
Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

3. HealthcareService.meta
Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Control0..1
TypeMeta
4. HealthcareService.meta.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
5. HealthcareService.meta.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingThis element introduces a set of slices on HealthcareService.meta.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
6. HealthcareService.meta.versionId
Definition

The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.

Control0..1
Typeid
Comments

The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.

7. HealthcareService.meta.lastUpdated
Definition

When the resource last changed - e.g. when the version changed.

Control0..1
Typeinstant
Comments

This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.

8. HealthcareService.meta.source
Definition

A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.

Control0..1
Typeuri
Must Supporttrue
Comments

In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used.

This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.

9. HealthcareService.meta.profile
Definition

A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.

Control0..*
Typecanonical(StructureDefinition)
Comments

It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.

10. HealthcareService.meta.security
Definition

Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.

Control0..*
BindingSecurity Labels from the Healthcare Privacy and Security Classification System.
The codes SHALL be taken from All Security Labels; other codes may be used where these codes are not suitable
TypeCoding
Comments

The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.

11. HealthcareService.meta.tag
Definition

Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

Control0..*
BindingCodes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
For example codes, see CommonTags
TypeCoding
Comments

The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

12. HealthcareService.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

Control0..1
Typeuri
Is Modifiertrue
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

13. HealthcareService.language
Definition

The base language in which the resource is written.

Control0..1
BindingA human language.
The codes SHOULD be taken from CommonLanguages
Max Binding: AllLanguages
Typecode
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

14. HealthcareService.text
Definition

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

Control0..1
TypeNarrative
Alternate Namesnarrative, html, xhtml, display
Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

15. HealthcareService.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

Control0..*
TypeResource
Alternate Namesinline resources, anonymous resources, contained resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

16. HealthcareService.extension
Definition

An Extension

Control0..*
TypeExtension
SlicingThis element introduces a set of slices on HealthcareService.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
17. HealthcareService.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Control0..*
TypeExtension
Is Modifiertrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

18. HealthcareService.identifier
Definition

External identifiers for this item.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Must Supporttrue
SlicingThis element introduces a set of slices on HealthcareService.identifier. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • pattern @ type
  • ,
  • value @ system
19. HealthcareService.identifier:hpio
SliceNamehpio
Definition

National identifier Health Provider Identifier for Organisations for Healthcare Service

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Must Supporttrue
InvariantsDefined on this element
inv-hpio-0: HPI-O shall be an exactly 16 digit number (: value.matches('^([0-9]{16})$'))
inv-hpio-1: HPI-O prefix is 800362 (: value.startsWith('800362'))
inv-hpio-2: HPI-O shall pass the Luhn algorithm check (: (((select(value.substring(0,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(9,1).toInteger())+(select(value.substring(10,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(11,1).toInteger())+(select(value.substring(12,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(13,1).toInteger())+(select(value.substring(14,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(15,1).toInteger())) mod 10 = 0))
20. HealthcareService.identifier:hpio.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
21. HealthcareService.identifier:hpio.extension
Definition

An Extension

Control0..*
TypeExtension
SlicingThis element introduces a set of slices on HealthcareService.identifier.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
22. HealthcareService.identifier:hpio.extension:hpioassigningauthority
SliceNamehpioassigningauthority
Definition

Optional HL7 V2 routing content

Control0..1
TypeExtension(HL7V2AssigningAuthority) (Extension Type: Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage)
Must Supporttrue
23. HealthcareService.identifier:hpio.extension:hpioassigningauthority.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
24. HealthcareService.identifier:hpio.extension:hpioassigningauthority.extension
Definition

An Extension

Control0..*
TypeExtension
SlicingThis element introduces a set of slices on HealthcareService.identifier.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
25. HealthcareService.identifier:hpio.extension:hpioassigningauthority.extension:namespace-id
SliceNamenamespace-id
Definition

An Extension

Control0..1
TypeExtension
26. HealthcareService.identifier:hpio.extension:hpioassigningauthority.extension:namespace-id.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
27. HealthcareService.identifier:hpio.extension:hpioassigningauthority.extension:namespace-id.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingThis element introduces a set of slices on HealthcareService.identifier.extension.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
28. HealthcareService.identifier:hpio.extension:hpioassigningauthority.extension:namespace-id.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Valuenamespace-id
29. HealthcareService.identifier:hpio.extension:hpioassigningauthority.extension:namespace-id.value[x]
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Control0..1
Typestring
[x] NoteSee Choice of Data Types for further information about how to use [x]
SlicingThis element introduces a set of slices on HealthcareService.identifier.extension.extension.value[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
30. HealthcareService.identifier:hpio.extension:hpioassigningauthority.extension:namespace-id.value[x]:valueString
SliceNamevalueString
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Control0..1
Typestring
[x] NoteSee Choice of Data Types for further information about how to use [x]
31. HealthcareService.identifier:hpio.extension:hpioassigningauthority.extension:universal-id
SliceNameuniversal-id
Definition

Identifier values follwing the universal-id-type defined scheme.

Control0..1
TypeExtension
32. HealthcareService.identifier:hpio.extension:hpioassigningauthority.extension:universal-id.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
33. HealthcareService.identifier:hpio.extension:hpioassigningauthority.extension:universal-id.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingThis element introduces a set of slices on HealthcareService.identifier.extension.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
34. HealthcareService.identifier:hpio.extension:hpioassigningauthority.extension:universal-id.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Valueuniversal-id
35. HealthcareService.identifier:hpio.extension:hpioassigningauthority.extension:universal-id.value[x]
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Control0..1
Typestring
[x] NoteSee Choice of Data Types for further information about how to use [x]
SlicingThis element introduces a set of slices on HealthcareService.identifier.extension.extension.value[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
36. HealthcareService.identifier:hpio.extension:hpioassigningauthority.extension:universal-id.value[x]:valueString
SliceNamevalueString
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Control0..1
Typestring
[x] NoteSee Choice of Data Types for further information about how to use [x]
37. HealthcareService.identifier:hpio.extension:hpioassigningauthority.extension:universal-id-type
SliceNameuniversal-id-type
Definition

Provides scheme to use to interpret the universal-id value .e.g. GUID, ISO etc. see HL7 V2 Table 0301 - Universal ID type.

Control0..1
TypeExtension
38. HealthcareService.identifier:hpio.extension:hpioassigningauthority.extension:universal-id-type.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
39. HealthcareService.identifier:hpio.extension:hpioassigningauthority.extension:universal-id-type.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingThis element introduces a set of slices on HealthcareService.identifier.extension.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
40. HealthcareService.identifier:hpio.extension:hpioassigningauthority.extension:universal-id-type.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Valueuniversal-id-type
41. HealthcareService.identifier:hpio.extension:hpioassigningauthority.extension:universal-id-type.value[x]
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Control0..1
Typestring
[x] NoteSee Choice of Data Types for further information about how to use [x]
SlicingThis element introduces a set of slices on HealthcareService.identifier.extension.extension.value[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
42. HealthcareService.identifier:hpio.extension:hpioassigningauthority.extension:universal-id-type.value[x]:valueString
SliceNamevalueString
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Control0..1
Typestring
[x] NoteSee Choice of Data Types for further information about how to use [x]
43. HealthcareService.identifier:hpio.extension:hpioassigningauthority.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

44. HealthcareService.identifier:hpio.extension:hpioassigningauthority.value[x]
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Control0..0
TypeChoice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage
[x] NoteSee Choice of Data Types for further information about how to use [x]
45. HealthcareService.identifier:hpio.use
Definition

The purpose of this identifier.

Control0..1
BindingIdentifies the purpose for this identifier, if known .
The codes SHALL be taken from IdentifierUse
Typecode
Is Modifiertrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

46. HealthcareService.identifier:hpio.type
Definition

Element describing the type of identifier

Control0..1
BindingLocal identifier type
The codes SHALL be taken from V2 Identifier Type - AU Extended
TypeCodeableConcept
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://terminology.hl7.org.au/CodeSystem/v2-0203"/>
    <code value="NOI"/>
  </coding>
</valueCodeableConcept>
47. HealthcareService.identifier:hpio.type.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
48. HealthcareService.identifier:hpio.type.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingThis element introduces a set of slices on HealthcareService.identifier.type.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
49. HealthcareService.identifier:hpio.type.coding
Definition

Coding for the identifier type

Control1..*
TypeCoding
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

50. HealthcareService.identifier:hpio.type.text
Definition

Descriptive text for the identifier type

Control0..1
Typestring
Requirements

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Comments

Very often the text is the same as a displayName of one of the codings.

Fixed ValueHPI-O
51. HealthcareService.identifier:hpio.system
Definition

This namespace is used for qualified identifiers to represent Healthcare Provider Identifier for Organisations (HPI-O) numbers. An example of the syntax of a HPI-O represented as a qualified identifer using this namespace is: http://ns.electronichealth.net.au/id/hi/hpio/1.0/8003620000000000

Control1..1
Typeuri
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comments

Identifier.system is always case sensitive.

Fixed Valuehttp://ns.electronichealth.net.au/id/hi/hpio/1.0
Example
General:http://www.acme.com/identifiers/patient
52. HealthcareService.identifier:hpio.value
Definition

Identifier for the organization that is used to identify the organization across multiple disparate systems.

Control1..1
Typestring
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Max Length16
Example
General:123456
HPI-O number:8003621566684455
53. HealthcareService.identifier:hpio.period
Definition

Time period during which identifier is/was valid for use.

Control0..1
TypePeriod
54. HealthcareService.identifier:hpio.assigner
Definition

Organization that issued/manages the identifier.

Control0..1
TypeReference(Organization)
Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

55. HealthcareService.identifier:pdvendor
SliceNamepdvendor
Definition

Vendor allocated directory identifier this can be used for search for specific healtchare service directory entry and/or for routing of messages.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Must Supporttrue
56. HealthcareService.identifier:pdvendor.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
57. HealthcareService.identifier:pdvendor.extension
Definition

An Extension

Control0..*
TypeExtension
SlicingThis element introduces a set of slices on HealthcareService.identifier.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
58. HealthcareService.identifier:pdvendor.extension:pdvendorassigningauthority
SliceNamepdvendorassigningauthority
Definition

Optional Extension Element - found in all resources.

Control0..1
TypeExtension(HL7V2AssigningAuthority) (Extension Type: Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage)
Must Supporttrue
59. HealthcareService.identifier:pdvendor.extension:pdvendorassigningauthority.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
60. HealthcareService.identifier:pdvendor.extension:pdvendorassigningauthority.extension
Definition

An Extension

Control0..*
TypeExtension
SlicingThis element introduces a set of slices on HealthcareService.identifier.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
61. HealthcareService.identifier:pdvendor.extension:pdvendorassigningauthority.extension:namespace-id
SliceNamenamespace-id
Definition

An Extension

Control0..1
TypeExtension
62. HealthcareService.identifier:pdvendor.extension:pdvendorassigningauthority.extension:namespace-id.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
63. HealthcareService.identifier:pdvendor.extension:pdvendorassigningauthority.extension:namespace-id.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingThis element introduces a set of slices on HealthcareService.identifier.extension.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
64. HealthcareService.identifier:pdvendor.extension:pdvendorassigningauthority.extension:namespace-id.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Valuenamespace-id
65. HealthcareService.identifier:pdvendor.extension:pdvendorassigningauthority.extension:namespace-id.value[x]
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Control0..1
Typestring
[x] NoteSee Choice of Data Types for further information about how to use [x]
SlicingThis element introduces a set of slices on HealthcareService.identifier.extension.extension.value[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
66. HealthcareService.identifier:pdvendor.extension:pdvendorassigningauthority.extension:namespace-id.value[x]:valueString
SliceNamevalueString
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Control0..1
Typestring
[x] NoteSee Choice of Data Types for further information about how to use [x]
67. HealthcareService.identifier:pdvendor.extension:pdvendorassigningauthority.extension:universal-id
SliceNameuniversal-id
Definition

Identifier values follwing the universal-id-type defined scheme.

Control0..1
TypeExtension
68. HealthcareService.identifier:pdvendor.extension:pdvendorassigningauthority.extension:universal-id.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
69. HealthcareService.identifier:pdvendor.extension:pdvendorassigningauthority.extension:universal-id.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingThis element introduces a set of slices on HealthcareService.identifier.extension.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
70. HealthcareService.identifier:pdvendor.extension:pdvendorassigningauthority.extension:universal-id.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Valueuniversal-id
71. HealthcareService.identifier:pdvendor.extension:pdvendorassigningauthority.extension:universal-id.value[x]
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Control0..1
Typestring
[x] NoteSee Choice of Data Types for further information about how to use [x]
SlicingThis element introduces a set of slices on HealthcareService.identifier.extension.extension.value[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
72. HealthcareService.identifier:pdvendor.extension:pdvendorassigningauthority.extension:universal-id.value[x]:valueString
SliceNamevalueString
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Control0..1
Typestring
[x] NoteSee Choice of Data Types for further information about how to use [x]
73. HealthcareService.identifier:pdvendor.extension:pdvendorassigningauthority.extension:universal-id-type
SliceNameuniversal-id-type
Definition

Provides scheme to use to interpret the universal-id value .e.g. GUID, ISO etc. see HL7 V2 Table 0301 - Universal ID type.

Control0..1
TypeExtension
74. HealthcareService.identifier:pdvendor.extension:pdvendorassigningauthority.extension:universal-id-type.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
75. HealthcareService.identifier:pdvendor.extension:pdvendorassigningauthority.extension:universal-id-type.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingThis element introduces a set of slices on HealthcareService.identifier.extension.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
76. HealthcareService.identifier:pdvendor.extension:pdvendorassigningauthority.extension:universal-id-type.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Valueuniversal-id-type
77. HealthcareService.identifier:pdvendor.extension:pdvendorassigningauthority.extension:universal-id-type.value[x]
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Control0..1
Typestring
[x] NoteSee Choice of Data Types for further information about how to use [x]
SlicingThis element introduces a set of slices on HealthcareService.identifier.extension.extension.value[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
78. HealthcareService.identifier:pdvendor.extension:pdvendorassigningauthority.extension:universal-id-type.value[x]:valueString
SliceNamevalueString
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Control0..1
Typestring
[x] NoteSee Choice of Data Types for further information about how to use [x]
79. HealthcareService.identifier:pdvendor.extension:pdvendorassigningauthority.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

80. HealthcareService.identifier:pdvendor.extension:pdvendorassigningauthority.value[x]
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Control0..0
TypeChoice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage
[x] NoteSee Choice of Data Types for further information about how to use [x]
81. HealthcareService.identifier:pdvendor.use
Definition

The purpose of this identifier.

Control0..1
BindingIdentifies the purpose for this identifier, if known .
The codes SHALL be taken from IdentifierUse
Typecode
Is Modifiertrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

82. HealthcareService.identifier:pdvendor.type
Definition

Element describing the type of identifier

Control1..1
BindingLocal Identifier Type
The codes SHALL be taken from V2 Identifier Type - AU Extended
TypeCodeableConcept
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

83. HealthcareService.identifier:pdvendor.type.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
84. HealthcareService.identifier:pdvendor.type.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingThis element introduces a set of slices on HealthcareService.identifier.type.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
85. HealthcareService.identifier:pdvendor.type.coding
Definition

Type code for vendor directory identifier

Control1..1
TypeCoding
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

86. HealthcareService.identifier:pdvendor.type.coding.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
87. HealthcareService.identifier:pdvendor.type.coding.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingThis element introduces a set of slices on HealthcareService.identifier.type.coding.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
88. HealthcareService.identifier:pdvendor.type.coding.system
Definition

The identification of the code system that defines the meaning of the symbol in the code.

Control1..1
Typeuri
Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

Fixed Valuehttp://hl7.org.au/fhir/v2/0203
89. HealthcareService.identifier:pdvendor.type.coding.version
Definition

The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

NoteThis is a business versionId, not a resource version id (see discussion)
Control0..1
Typestring
Comments

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

90. HealthcareService.identifier:pdvendor.type.coding.code
Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Control1..1
Typecode
Requirements

Need to refer to a particular code in the system.

Fixed ValueVDI
91. HealthcareService.identifier:pdvendor.type.coding.display
Definition

A representation of the meaning of the code in the system, following the rules of the system.

Control0..1
Typestring
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

92. HealthcareService.identifier:pdvendor.type.coding.userSelected
Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Control0..1
Typeboolean
Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

93. HealthcareService.identifier:pdvendor.type.text
Definition

Vendor Directory Identifier type descripition

Control1..1
Typestring
Requirements

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Comments

Very often the text is the same as a displayName of one of the codings.

Fixed ValueVendor Directory Identifier
94. HealthcareService.identifier:pdvendor.system
Definition

Unique namespace for the assigning vendor's identifier value.

Control1..1
Typeuri
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comments

Identifier.system is always case sensitive.

Example
General:http://www.acme.com/identifiers/patient
95. HealthcareService.identifier:pdvendor.value
Definition

Assigning vendor's identifier value.

Control1..1
Typestring
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Example
General:123456
96. HealthcareService.identifier:pdvendor.period
Definition

Time period during which identifier is/was valid for use.

Control0..1
TypePeriod
97. HealthcareService.identifier:pdvendor.assigner
Definition

Organization that issued/manages the identifier.

Control1..1
TypeReference(Organization)
Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

98. HealthcareService.identifier:pdvendor.assigner.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
99. HealthcareService.identifier:pdvendor.assigner.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingThis element introduces a set of slices on HealthcareService.identifier.assigner.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
100. HealthcareService.identifier:pdvendor.assigner.reference
Definition

A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

Control0..1 This element is affected by the following invariants: ref-1
Typestring
Comments

Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

101. HealthcareService.identifier:pdvendor.assigner.type
Definition

The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

Control0..1
BindingAa resource (or, for logical models, the URI of the logical model).
The codes SHALL be taken from ResourceType; other codes may be used where these codes are not suitable
Typeuri
Comments

This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

102. HealthcareService.identifier:pdvendor.assigner.identifier
Definition

An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1
TypeIdentifier
Comments

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

103. HealthcareService.identifier:pdvendor.assigner.display
Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Control1..1
Typestring
Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

104. HealthcareService.active
Definition

This flag is used to mark the record to not be used. This is not used when a center is closed for maintenance, or for holidays, the notAvailable period is to be used for this.

Control1..1
Typeboolean
Is Modifiertrue
Must Supporttrue
Comments

This element is labeled as a modifier because it may be used to mark that the resource was created in error.

Meaning if MissingThis resource is generally assumed to be active if no value is provided for the active element
105. HealthcareService.providedBy
Definition

The organization that provides this healthcare service.

Control1..1
TypeReference(AUPDOrganisation)
Must Supporttrue
Comments

This property is recommended to be the same as the Location's managingOrganization, and if not provided should be interpreted as such. If the Location does not have a managing Organization, then this property should be populated.

106. HealthcareService.category
Definition

Identifies the broad category of service being performed or delivered.

Control0..*
BindingA category of the service(s) that could be provided.
For example codes, see ServiceCategory
TypeCodeableConcept
Alternate Namesservice category
Comments

Selecting a Service Category then determines the list of relevant service types that can be selected in the primary service type.

107. HealthcareService.type
Definition

The specific type of service that may be delivered or performed.

Control0..*
BindingA type of service that a healthcare service may provide.
The codes SHOULD be taken from Healthcare Service Types (SNOMED CT AU)
TypeCodeableConcept
Must Supporttrue
Alternate Namesservice type
108. HealthcareService.specialty
Definition

Collection of specialties handled by the service site. This is more of a medical term.

Control0..*
BindingA specialty role that a healthcare service may provide.
The codes SHOULD be taken from Healthcare Service Specialties (SNOMED CT AU)
TypeCodeableConcept
Must Supporttrue
109. HealthcareService.location
Definition

The location(s) where this healthcare service may be provided.

Control1..1
TypeReference(AUPDLocation)
Must Supporttrue
110. HealthcareService.name
Definition

Further description of the service as it would be presented to a consumer while searching.

Control1..1
Typestring
Must Supporttrue
111. HealthcareService.comment
Definition

Any additional description of the service and/or any specific issues not covered by the other attributes, which can be displayed as further detail under the serviceName.

Control0..1
Typestring
Comments

Would expect that a user would not see this information on a search results, and it would only be available when viewing the complete details of the service.

112. HealthcareService.extraDetails
Definition

Extra details about the service that can't be placed in the other fields.

Control0..1
Typemarkdown
113. HealthcareService.photo
Definition

If there is a photo/symbol associated with this HealthcareService, it may be included here to facilitate quick identification of the service in a list.

Control0..1
TypeAttachment
114. HealthcareService.telecom
Definition

List of contacts related to this specific healthcare service.

Control0..*
TypeContactPoint
Must Supporttrue
Comments

If this is empty, then refer to the location's contacts.

115. HealthcareService.coverageArea
Definition

The location(s) that this service is available to (not where the service is provided).

Control0..*
TypeReference(Location)
Comments

The locations referenced by the coverage area can include both specific locations, including areas, and also conceptual domains too (mode = kind), such as a physical area (tri-state area) and some other attribute (covered by Example Care Organization). These types of Locations are often not managed by any specific organization. This could also include generic locations such as "in-home".

116. HealthcareService.serviceProvisionCode
Definition

The code(s) that detail the conditions under which the healthcare service is available/offered.

Control0..*
BindingThe codes SHOULD be taken from Service Provision Conditions Australian Concepts
TypeCodeableConcept
Comments

The provision means being commissioned by, contractually obliged or financially sourced. Types of costings that may apply to this healthcare service, such if the service may be available for free, some discounts available, or fees apply.

117. HealthcareService.eligibility
Definition

Does this service have specific eligibility requirements that need to be met in order to use the service?

Control0..*
TypeBackboneElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
118. HealthcareService.eligibility.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
119. HealthcareService.eligibility.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

120. HealthcareService.eligibility.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Control0..*
TypeExtension
Is Modifiertrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

121. HealthcareService.eligibility.code
Definition

Coded value for the eligibility.

Control0..1
BindingCoded values underwhich a specific service is made available.
TypeCodeableConcept
122. HealthcareService.eligibility.comment
Definition

Describes the eligibility conditions for the service.

Control0..1
Typemarkdown
Comments

The description of service eligibility should, in general, not exceed one or two paragraphs. It should be sufficient for a prospective consumer to determine if they are likely to be eligible or not. Where eligibility requirements and conditions are complex, it may simply be noted that an eligibility assessment is required. Where eligibility is determined by an outside source, such as an Act of Parliament, this should be noted, preferably with a reference to a commonly available copy of the source document such as a web page.

123. HealthcareService.program
Definition

Programs that this service is applicable to.

Control0..*
BindingGovernment or local programs that this service applies to.
For example codes, see Program
TypeCodeableConcept
Comments

Programs are often defined externally to an Organization, commonly by governments; e.g. Home and Community Care Programs, Homeless Program, ….

124. HealthcareService.characteristic
Definition

Collection of characteristics (attributes).

Control0..*
BindingA custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy).
TypeCodeableConcept
Comments

These could be such things as is wheelchair accessible.

125. HealthcareService.communication
Definition

Some services are specifically made available in multiple languages, this property permits a directory to declare the languages this is offered in. Typically this is only provided where a service operates in communities with mixed languages used.

Control0..*
BindingA human language.
The codes SHOULD be taken from CommonLanguages
Max Binding: AllLanguages
TypeCodeableConcept
Comments

When using this property it indicates that the service is available with this language, it is not derived from the practitioners, and not all are required to use this language, just that this language is available while scheduling.

126. HealthcareService.referralMethod
Definition

Ways that the service accepts referrals, if this is not provided then it is implied that no referral is required.

Control0..*
BindingThe methods of referral can be used when referring to a specific HealthCareService resource.
For example codes, see ReferralMethod
TypeCodeableConcept
127. HealthcareService.appointmentRequired
Definition

Indicates whether or not a prospective consumer will require an appointment for a particular service at a site to be provided by the Organization. Indicates if an appointment is required for access to this service.

Control0..1
Typeboolean
128. HealthcareService.availableTime
Definition

A collection of times that the Service Site is available.

Control0..*
TypeBackboneElement
Comments

More detailed availability information may be provided in associated Schedule/Slot resources.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
129. HealthcareService.availableTime.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
130. HealthcareService.availableTime.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

131. HealthcareService.availableTime.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Control0..*
TypeExtension
Is Modifiertrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

132. HealthcareService.availableTime.daysOfWeek
Definition

Indicates which days of the week are available between the start and end Times.

Control0..*
BindingThe days of the week.
The codes SHALL be taken from DaysOfWeek
Typecode
133. HealthcareService.availableTime.allDay
Definition

Is this always available? (hence times are irrelevant) e.g. 24 hour service.

Control0..1
Typeboolean
134. HealthcareService.availableTime.availableStartTime
Definition

The opening time of day. Note: If the AllDay flag is set, then this time is ignored.

Control0..1
Typetime
Comments

The time zone is expected to be for where this HealthcareService is provided at.

135. HealthcareService.availableTime.availableEndTime
Definition

The closing time of day. Note: If the AllDay flag is set, then this time is ignored.

Control0..1
Typetime
Comments

The time zone is expected to be for where this HealthcareService is provided at.

136. HealthcareService.notAvailable
Definition

The HealthcareService is not available during this period of time due to the provided reason.

Control0..*
TypeBackboneElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
137. HealthcareService.notAvailable.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
138. HealthcareService.notAvailable.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

139. HealthcareService.notAvailable.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Control0..*
TypeExtension
Is Modifiertrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

140. HealthcareService.notAvailable.description
Definition

The reason that can be presented to the user as to why this time is not available.

Control1..1
Typestring
141. HealthcareService.notAvailable.during
Definition

Service is not available (seasonally or for a public holiday) from this date.

Control0..1
TypePeriod
142. HealthcareService.availabilityExceptions
Definition

A description of site availability exceptions, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as details in the available Times and not available Times.

Control0..1
Typestring
143. HealthcareService.endpoint
Definition

Technical endpoints providing access to services operated for the specific healthcare services defined at this resource.

Control0..*
TypeChoice of: Reference(AUPDSecureMessagingEndpoint), Reference(Endpoint)
Must Supporttrue