NHSD Implementation Guide - Outbound
4.0.1 - active

NHSD Implementation Guide - Outbound - Local Development build (v4.0.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

## Resource Profile: NHSDHealthcareService - Detailed Descriptions

Draft as of 2023-11-21

Definitions for the nhsd-healthcareservice resource profile.

- Key Elements Table
- Differential Elements Table
- Snapshot Elements Table

Guidance on how to interpret the contents of this table can be foundhere

0. HealthcareService
Definition | The details of a healthcare service for directory use. The details of a healthcare service available at a location.
Short | A healthcare service in an Australian healthcare context e.g., a healthcare service provided at a siteThe details of a healthcare service available at a location
Comments | NHSD HealthcareService.
Control | 0..*
Is Modifier | false
Summary | false
Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.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-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-6: A resource should have narrative for robust management (`text.div.exists()`) dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.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-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.
Short | Logical FHIR id for unique identification of the Healthcare Service resource within the FHIR bundleLogical id of this artifact
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.
Control | 10..1
Type | id string
Is Modifier | false
Summary | true
4. 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.
Short | Metadata about Healthcare Service resourceMetadata about the resource
Control | 10..1
Type | Meta
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. 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.
Short | Unique id for inter-element referencing
Control | 0..01
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
8. HealthcareService.meta.extension
Definition | An Extension 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.
Short | ExtensionAdditional content defined by implementations
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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
Slicing | This element introduces a set of slices on `HealthcareService.meta.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
10. HealthcareService.meta.extension:proximityDistance
Slice Name | proximityDistance
Definition | An Extension
Short | The distance in meters/kilometers of the service
Control | 0..1
Type | Extension(proximity-distance) (Extension Type: decimal)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
12. HealthcareService.meta.extension:operationalStatus
Slice Name | operationalStatus
Definition | Defines the operational status of a service which could be OPEN, CLOSED OR UNKNOWN.
Short | Operational status of the service
Control | 0..1
Type | Extension(operationalStatus) (Complex Extension)
Is Modifier | false
14. 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.
Short | Version specific identifier
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.
Control | 0..01
Type | id
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
16. HealthcareService.meta.lastUpdated
Definition | When the resource last changed - e.g. when the version changed.
Short | The timestamp when the resource was last updatedWhen the resource version last changed
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. 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.
Control | 10..1
Type | instant
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
18. 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. 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.
Short | Identifies where the resource comes from
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.
Control | 0..01
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
20. 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. A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.
Short | Profiles this resource claims to conform to
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.
Control | 0..0*
Type | canonical(StructureDefinition)
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
22. HealthcareService.meta.security
Definition | Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.
Short | Security Labels applied to this resource
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.
Control | 0..0*
Binding | Unless not suitable, these codes SHALL be taken from All Security Labels http://hl7.org/fhir/ValueSet/security-labels (extensible to `http://hl7.org/fhir/ValueSet/security-labels` ) Security Labels from the Healthcare Privacy and Security Classification System.
Type | Coding
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
24. 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.
Short | Tags applied to this resource
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.
Control | 0..0*
Binding | For example codes, see CommonTags http://hl7.org/fhir/ValueSet/common-tags (example to `http://hl7.org/fhir/ValueSet/common-tags` ) Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
Type | Coding
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
26. 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.
Short | A set of rules under which this content was created
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.
Control | 0..01
Type | uri
Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
28. HealthcareService.language
Definition | The base language in which the resource is written.
Short | Language of the resource content
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).
Control | 0..01
Binding | The codes SHOULD be taken from CommonLanguages http://hl7.org/fhir/ValueSet/languages (preferred to `http://hl7.org/fhir/ValueSet/languages` ) A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
30. 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.
Short | Text summary of the resource, for human interpretation
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.
Control | 0..01
Type | Narrative
Is Modifier | false
Summary | false
Alternate Names | narrative, html, xhtml, display
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
32. HealthcareService.extension
Definition | An Extension May be used to represent additional information that is not part of the basic definition of the resource. 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.
Short | ExtensionAdditional content defined by implementations
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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
Slicing | This element introduces a set of slices on `HealthcareService.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
34. HealthcareService.extension:bookingProvider
Slice Name | bookingProvider
Definition | Lists booking providers which offer web accessible link in order to book with this service.
Short | Information about Booking Providers for a Healthcare Service
Control | 0..*
Type | Extension(nhsd-booking-provider) (Complex Extension)
Is Modifier | false
36. HealthcareService.modifierExtension
Definition | An Extension 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).
Short | ExtensionExtensions that cannot be ignored
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.
Control | 0..0*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Summary | false
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 Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
38. HealthcareService.identifier
Definition | External identifiers for this item.
Short | Healthcare service identifiersExternal identifiers for this item
Comments | NHSD HealthcareService
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..*
Type | Identifier
Is Modifier | false
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
Slicing | This element introduces a set of slices on `HealthcareService.identifier`. The slices areUnordered and Open, and can be differentiated using the following discriminators: pattern @ type value @ system
40. HealthcareService.identifier:hpio
Slice Name | hpio
Definition | National identifier Health Provider Identifier for Organisations for Healthcare Service External identifiers for this item.
Short | HPI-O for Directory Entry OrganisationExternal identifiers for this item
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..0*
Type | Identifier
Is Modifier | false
Must Support | true
Summary | true
Invariants | 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)`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
63. HealthcareService.identifier:pdvendor
Slice Name | pdvendor
Definition | Vendor allocated directory identifier this can be used for search for specific healtchare service directory entry and/or for routing of messages. External identifiers for this item.
Short | Secure Messaging Vendor's Healthcare Service IdentifierExternal identifiers for this item
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..0*
Type | Identifier
Is Modifier | false
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
90. HealthcareService.identifier:rid
Slice Name | rid
Definition | NHSD HealthcareService Resource Identifier External identifiers for this item.
Short | Healthcare service identifiersExternal identifiers for this item
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..1*
Type | Identifier(nhsd-resource-identifier)
Is Modifier | false
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
92. 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.
Short | Reflects the current status of the Healthcare Service resourceWhether this HealthcareService record is in active use
Comments | This element is labeled as a modifier because it may be used to mark that the resource was created in error.
Control | 10..1
Type | boolean
Is Modifier | true because This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Meaning if Missing | This resource is generally assumed to be active if no value is provided for the active element
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
94. HealthcareService.providedBy
Definition | The organization that provides this healthcare service.
Short | Reference to the Organization resource that provides the serviceOrganization that provides this service
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.
Control | 10..1
Type | Reference(NHSD Organisation, Organization)
Is Modifier | false
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
96. HealthcareService.category
Definition | Identifies the broad category of service being performed or delivered.
Short | Not currently supportedBroad category of service being performed or delivered
Comments | Selecting a Service Category then determines the list of relevant service types that can be selected in the primary service type.
Control | 0..0*
Binding | For example codes, see ServiceCategory http://hl7.org/fhir/ValueSet/service-category (example to `http://hl7.org/fhir/ValueSet/service-category` ) A category of the service(s) that could be provided.
Type | CodeableConcept
Is Modifier | false
Summary | true
Alternate Names | service category
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
98. HealthcareService.type
Definition | The specific type of service that may be delivered or performed.
Short | Type of service that may be delivered or performed. Each HealthcareService resource must have only 1 preferred service type
Control | 10..*
Binding | The codes SHOULD be taken from For example codes, see Healthcare Service Types SNOMED-CT http://hl7.org/fhir/ValueSet/service-type (preferred to `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-healthcareservice-serviceType` )
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | true
Alternate Names | service type
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
100. HealthcareService.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.
Short | Unique id for inter-element referencing
Control | 0..01
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
102. HealthcareService.type.coding
Definition | A reference to a code defined by a terminology system.
Short | Code defined by a terminology system
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.
Control | 10..*
Type | Coding
Is Modifier | false
Summary | true
Requirements | Allows for alternative encodings within a code system, and translations to other code systems.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
104. HealthcareService.specialty:snomedRole
Slice Name | snomedRole
Definition | Collection of specialties handled by the service site. This is more of a medical term.
Short | NHSD server makes use of type attributeSpecialties handled by the HealthcareService
Control | 0..0*
Binding | ​The codes SHOULD be taken from http://hl7.org.au/fhir/ValueSet/snomed-healthcareservice-specialties http://hl7.org/fhir/ValueSet/c80-practice-codes (preferred to `http://hl7.org.au/fhir/ValueSet/snomed-healthcareservice-specialties` ) A specialty role that a healthcare service may provide. A specialty that a healthcare service may provide.
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
106. HealthcareService.location
Definition | The location(s) where this healthcare service may be provided.
Short | Reference to the Location resource.Location(s) where service may be provided
Control | 10..1*
Type | Reference(NHSD Location, Location)
Is Modifier | false
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
108. HealthcareService.name
Definition | Further description of the service as it would be presented to a consumer while searching.
Short | Healthcare Service name, which may include department level information for Hospitals.Description of service as presented to a consumer while searching
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
110. 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.
Short | A short description of the Healthcare Service, which may include additional information not covered elsewhere.Additional description and/or any specific issues not covered elsewhere
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.
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
112. HealthcareService.extraDetails
Definition | Extra details about the service that can't be placed in the other fields.
Short | Extra details about the service that can't be placed in the other fields
Control | 0..01
Type | markdown
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
114. 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.
Short | Facilitates quick identification of the service
Control | 0..01
Type | Attachment
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
116. HealthcareService.telecom
Definition | List of contacts related to this specific healthcare service.
Short | Contact information related to the Healthcare ServiceContacts related to the healthcare service
Comments | If this is empty, then refer to the location's contacts.
Control | 0..*
Type | ContactPoint
Is Modifier | false
Must Support | true
Summary | false
Label | Communication Details
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
118. HealthcareService.telecom.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..01
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
120. HealthcareService.telecom.extension:contactPurpose
Slice Name | contactPurpose
Definition | Defines the contact purpose for the resource. T
Short | The contact purpose for the resource
Control | 0..*
Type | Extension(au-contact-purpose) (Extension Type: CodeableConcept)
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
122. HealthcareService.telecom.system
Definition | Telecommunications form for contact point - what communications system is required to make use of the contact.
Short | phone | fax | email | url phone | fax | email | pager | url | sms | other
Control | 10..1 This element is affected by the following invariants: cpt-2
Binding | The codes SHALL be taken from Contact Point System http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 (required to `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-contact-point-system` ) Telecommunications form for contact point.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
124. HealthcareService.telecom.value
Definition | The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).
Short | The actual contact point details
Comments | Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.
Control | 10..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to support legacy numbers that are not in a tightly controlled format.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
126. HealthcareService.telecom.use
Definition | Identifies the purpose for the contact point.
Short | home | work | temp | old | mobile - purpose of this contact point
Comments | Applications can assume that a contact is current unless it explicitly says that it is temporary or old.
Control | 0..01
Binding | The codes SHALL be taken from ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 (required to `http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1` ) Use of contact point.
Type | code
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
128. HealthcareService.telecom.rank
Definition | Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.
Short | Specify preferred order of use (1 = highest)
Comments | Note that rank does not necessarily follow the order in which the contacts are represented in the instance.
Control | 0..01
Type | positiveInt
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
130. HealthcareService.telecom.period
Definition | Time period when the contact point was/is in use.
Short | Time period when the contact point was/is in use
Control | 0..01
Type | Period
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
132. HealthcareService.coverageArea
Definition | The location(s) that this service is available to (not where the service is provided). The NHSD FHIR Server provide these resources as CONTAINED elements. The location(s) that this service is available to (not where the service is provided).
Short | Reference to the list of 'contained' Location resources defining the coverage area of virtual/home visit type of Healthcare Services.Location(s) service is intended for/available to
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".
Control | 0..*
Type | Reference(Location)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
134. HealthcareService.serviceProvisionCode
Definition | The code(s) that detail the conditions under which the healthcare service is available/offered.
Short | Reflects the billing option type the Healthcare Service supportsConditions under which service is available/offered
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.
Control | 0..1*
Binding | The codes SHALL be taken from For example codes, see Healthcare Service Provision Conditions http://hl7.org/fhir/ValueSet/service-provision-conditions (required to `http://fhir.nhsd.com.au/ValueSet/valueset-nhsd-service-provision-conditions` )
Type | CodeableConcept
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
136. HealthcareService.eligibility
Definition | Does this service have specific eligibility requirements that need to be met in order to use the service?
Short | Specific eligibility requirements required to use the service
Control | 0..*
Type | BackboneElement
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
138. 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).
Short | Extensions that cannot be ignored even if unrecognized
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.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
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 Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
140. HealthcareService.eligibility.code
Definition | Coded value for the eligibility.
Short | Coded value for the eligibility
Control | 10..1
Binding | The codes SHALL be taken from For example codes, see Healthcare Service Eligibility criteria (required to `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-eligibility` ) Eligibility for service provided by Healthcare provider Coded values underwhich a specific service is made available.
Type | CodeableConcept
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
142. HealthcareService.program
Definition | Programs that this service is applicable to.
Short | Name of program(s) that the Healthcare Service is a part ofPrograms that this service is applicable to
Comments | Programs are often defined externally to an Organization, commonly by governments; e.g. Home and Community Care Programs, Homeless Program, ….
Control | 0..*
Binding | Unless not suitable, these codes SHALL be taken from For example codes, see Healthcare Service Programs (Funded or Unfunded)http://hl7.org/fhir/ValueSet/program (extensible to `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-program` ) Name of program(s) that the Healthcare Service is a part of Government or local programs that this service applies to.
Type | CodeableConcept
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
144. HealthcareService.characteristic
Definition | Collection of characteristics (attributes), bound to known CodeSystems for various groups of characteristics. Collection of characteristics (attributes).
Short | Various characteristics of the Healthcare Service like offering etcCollection of characteristics (attributes)
Comments | These could be such things as is wheelchair accessible.
Control | 0..*
Binding | A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy).
Type | CodeableConcept
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
Slicing | This element introduces a set of slices on `HealthcareService.characteristic`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ coding.system
146. HealthcareService.characteristic:facility
Slice Name | facility
Definition | Collection of characteristics (attributes).
Short | Facilities available or provided at a Healthcare Service locationCollection of characteristics (attributes)
Comments | These could be such things as is wheelchair accessible.
Control | 0..*
Binding | The codes SHALL be taken from For example codes, see Healthcare Service Facilities (required to `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-facility` ) Facilities available or provided at a Healthcare Service location A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy).
Type | CodeableConcept
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
148. HealthcareService.characteristic:facility.extension
Definition | An Extension 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.
Short | ExtensionAdditional content defined by implementations
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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
Slicing | This element introduces a set of slices on `HealthcareService.characteristic.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
150. HealthcareService.characteristic:facility.extension:facilities-characteristic-group
Slice Name | facilities-characteristic-group
Definition | An Extension
Short | -
Control | 1..1
Type | Extension(Characteristic Group) (Extension Type: string)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
152. HealthcareService.characteristic:facility.extension:facilities-characteristic-group.url
Definition | Source of the definition for the extension code - a logical name or a URL.
Short | identifies the meaning of the extension
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.
Control | 1..1
Type | uri
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
Fixed Value | `http://fhir.nhsd.com.au/StructureDefinition/characteristic-group`
154. HealthcareService.characteristic:facility.extension:facilities-characteristic-group.value[x]
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short | Value of extension
Control | 10..1
Type | string, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
Slicing | This element introduces a set of slices on `HealthcareService.characteristic.extension.value[x]`. The slices areUnordered and Closed, and can be differentiated using the following discriminators: type @ $this
156. HealthcareService.characteristic:facility.extension:facilities-characteristic-group.value[x]:valueString
Slice Name | valueString
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short | Value of extension
Control | 10..1
Type | string, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Fixed Value | `facilities`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
158. HealthcareService.characteristic:facility.coding
Definition | A reference to a code defined by a terminology system.
Short | -Code defined by a terminology system
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.
Control | 0..*
Type | Coding
Is Modifier | false
Summary | true
Requirements | Allows for alternative encodings within a code system, and translations to other code systems.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
160. HealthcareService.characteristic:fundingsource
Slice Name | fundingsource
Definition | Collection of characteristics (attributes).
Short | Funding Sources which support this Healthcare Service.Collection of characteristics (attributes)
Comments | These could be such things as is wheelchair accessible.
Control | 0..*
Binding | The codes SHALL be taken from For example codes, see Healthcare Service Funding Sources (required to `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-fundingSource` ) Funding Sources which support this Healthcare Service. A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy).
Type | CodeableConcept
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
162. HealthcareService.characteristic:fundingsource.extension
Definition | An Extension 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.
Short | ExtensionAdditional content defined by implementations
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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
Slicing | This element introduces a set of slices on `HealthcareService.characteristic.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
164. HealthcareService.characteristic:fundingsource.extension:fundingsource-characteristic-group
Slice Name | fundingsource-characteristic-group
Definition | An Extension
Short | -
Control | 1..1
Type | Extension(Characteristic Group) (Extension Type: string)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
166. HealthcareService.characteristic:fundingsource.extension:fundingsource-characteristic-group.url
Definition | Source of the definition for the extension code - a logical name or a URL.
Short | identifies the meaning of the extension
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.
Control | 1..1
Type | uri
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
Fixed Value | `http://fhir.nhsd.com.au/StructureDefinition/characteristic-group`
168. HealthcareService.characteristic:fundingsource.extension:fundingsource-characteristic-group.value[x]
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short | Value of extension
Control | 10..1
Type | string, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
Slicing | This element introduces a set of slices on `HealthcareService.characteristic.extension.value[x]`. The slices areUnordered and Closed, and can be differentiated using the following discriminators: type @ $this
170. HealthcareService.characteristic:fundingsource.extension:fundingsource-characteristic-group.value[x]:valueString
Slice Name | valueString
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short | Value of extension
Control | 10..1
Type | string, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Fixed Value | `fundingSource`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
172. HealthcareService.characteristic:fundingsource.coding
Definition | A reference to a code defined by a terminology system.
Short | -Code defined by a terminology system
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.
Control | 0..*
Type | Coding
Is Modifier | false
Summary | true
Requirements | Allows for alternative encodings within a code system, and translations to other code systems.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
174. HealthcareService.characteristic:healthcareServiceCharacteristic
Slice Name | healthcareServiceCharacteristic
Definition | Collection of characteristics (attributes).
Short | Miscellaneous characteristics of a Healthcare ServiceCollection of characteristics (attributes)
Comments | These could be such things as is wheelchair accessible.
Control | 0..*
Binding | The codes SHALL be taken from For example codes, see Healthcare Service miscellaneous characteristics (required to `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-healthcareServiceCharacteristic` ) Miscellaneous characteristics of a Healthcare Service A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy).
Type | CodeableConcept
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
176. HealthcareService.characteristic:healthcareServiceCharacteristic.extension
Definition | An Extension 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.
Short | ExtensionAdditional content defined by implementations
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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
Slicing | This element introduces a set of slices on `HealthcareService.characteristic.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
178. HealthcareService.characteristic:healthcareServiceCharacteristic.extension:plsc-characteristic-group
Slice Name | plsc-characteristic-group
Definition | An Extension
Short | -
Control | 1..1
Type | Extension(Characteristic Group) (Extension Type: string)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
180. HealthcareService.characteristic:healthcareServiceCharacteristic.extension:plsc-characteristic-group.url
Definition | Source of the definition for the extension code - a logical name or a URL.
Short | identifies the meaning of the extension
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.
Control | 1..1
Type | uri
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
Fixed Value | `http://fhir.nhsd.com.au/StructureDefinition/characteristic-group`
182. HealthcareService.characteristic:healthcareServiceCharacteristic.extension:plsc-characteristic-group.value[x]
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short | Value of extension
Control | 10..1
Type | string, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
Slicing | This element introduces a set of slices on `HealthcareService.characteristic.extension.value[x]`. The slices areUnordered and Closed, and can be differentiated using the following discriminators: type @ $this
184. HealthcareService.characteristic:healthcareServiceCharacteristic.extension:plsc-characteristic-group.value[x]:valueString
Slice Name | valueString
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short | Value of extension
Control | 10..1
Type | string, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Fixed Value | `characteristics`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
186. HealthcareService.characteristic:healthcareServiceCharacteristic.coding
Definition | A reference to a code defined by a terminology system.
Short | -Code defined by a terminology system
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.
Control | 0..*
Type | Coding
Is Modifier | false
Summary | true
Requirements | Allows for alternative encodings within a code system, and translations to other code systems.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
188. HealthcareService.characteristic:referralInformation
Slice Name | referralInformation
Definition | Collection of characteristics (attributes).
Short | Referral Instructions and InformationCollection of characteristics (attributes)
Comments | These could be such things as is wheelchair accessible.
Control | 0..*
Binding | The codes SHALL be taken from For example codes, see Healthcare Service referral instructions and information (required to `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-referralInformation` ) Referral Instructions and Information A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy).
Type | CodeableConcept
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
190. HealthcareService.characteristic:referralInformation.extension
Definition | An Extension 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.
Short | ExtensionAdditional content defined by implementations
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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
Slicing | This element introduces a set of slices on `HealthcareService.characteristic.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
192. HealthcareService.characteristic:referralInformation.extension:referral-characteristic-group
Slice Name | referral-characteristic-group
Definition | An Extension
Short | -
Control | 1..1
Type | Extension(Characteristic Group) (Extension Type: string)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
194. HealthcareService.characteristic:referralInformation.extension:referral-characteristic-group.url
Definition | Source of the definition for the extension code - a logical name or a URL.
Short | identifies the meaning of the extension
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.
Control | 1..1
Type | uri
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
Fixed Value | `http://fhir.nhsd.com.au/StructureDefinition/characteristic-group`
196. HealthcareService.characteristic:referralInformation.extension:referral-characteristic-group.value[x]
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short | Value of extension
Control | 10..1
Type | string, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
Slicing | This element introduces a set of slices on `HealthcareService.characteristic.extension.value[x]`. The slices areUnordered and Closed, and can be differentiated using the following discriminators: type @ $this
198. HealthcareService.characteristic:referralInformation.extension:referral-characteristic-group.value[x]:valueString
Slice Name | valueString
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short | Value of extension
Control | 10..1
Type | string, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Fixed Value | `referralInformation`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
200. HealthcareService.characteristic:referralInformation.extension:referralInstruction
Slice Name | referralInstruction
Definition | An Extension
Short | Referral Instructions and Information
Control | 0..1
Type | Extension(characteristic-extendedValues) (Extension Type: string)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
202. HealthcareService.characteristic:referralInformation.coding
Definition | A reference to a code defined by a terminology system.
Short | -Code defined by a terminology system
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.
Control | 0..*
Type | Coding
Is Modifier | false
Summary | true
Requirements | Allows for alternative encodings within a code system, and translations to other code systems.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
204. HealthcareService.characteristic:offering
Slice Name | offering
Definition | Collection of characteristics (attributes), bound to known CodeSystems for various groups of characteristics. Collection of characteristics (attributes).
Short | This contains the list of various offerings that the Healthcare Service hasCollection of characteristics (attributes)
Comments | These could be such things as is wheelchair accessible.
Control | 0..*
Binding | The codes SHALL be taken from For example codes, see Healthcare Service Offerings (required to `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-offering` ) Supporting services offered at a Healthcare Service A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy).
Type | CodeableConcept
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
206. HealthcareService.characteristic:offering.extension
Definition | An Extension 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.
Short | ExtensionAdditional content defined by implementations
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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
Slicing | This element introduces a set of slices on `HealthcareService.characteristic.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
208. HealthcareService.characteristic:offering.extension:offering-characteristic-group
Slice Name | offering-characteristic-group
Definition | An Extension
Short | -
Control | 1..1
Type | Extension(Characteristic Group) (Extension Type: string)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
210. HealthcareService.characteristic:offering.extension:offering-characteristic-group.url
Definition | Source of the definition for the extension code - a logical name or a URL.
Short | identifies the meaning of the extension
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.
Control | 1..1
Type | uri
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
Fixed Value | `http://fhir.nhsd.com.au/StructureDefinition/characteristic-group`
212. HealthcareService.characteristic:offering.extension:offering-characteristic-group.value[x]
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short | Value of extension
Control | 10..1
Type | string, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
Slicing | This element introduces a set of slices on `HealthcareService.characteristic.extension.value[x]`. The slices areUnordered and Closed, and can be differentiated using the following discriminators: type @ $this
214. HealthcareService.characteristic:offering.extension:offering-characteristic-group.value[x]:valueString
Slice Name | valueString
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short | Value of extension
Control | 10..1
Type | string, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Fixed Value | `offerings`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
216. HealthcareService.characteristic:offering.coding
Definition | A reference to a code defined by a terminology system.
Short | -Code defined by a terminology system
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.
Control | 0..*
Type | Coding
Is Modifier | false
Summary | true
Requirements | Allows for alternative encodings within a code system, and translations to other code systems.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
218. 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.
Short | The language that this service is offered in
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.
Control | 0..*
Binding | The codes SHALL be taken from The codes SHOULD be taken from Common Languages in Australia http://hl7.org/fhir/ValueSet/languages (required to `https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2` )
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
220. HealthcareService.referralMethod
Definition | Ways that the service accepts referrals, if this is not provided then it is implied that no referral is required.
Short | Ways that the service accepts referrals
Control | 0..0*
Binding | For example codes, see ReferralMethod http://hl7.org/fhir/ValueSet/service-referral-method (example to `http://hl7.org/fhir/ValueSet/service-referral-method` ) The methods of referral can be used when referring to a specific HealthCareService resource.
Type | CodeableConcept
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
222. 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.
Short | It indicates if an appointment is required for this Healthcare ServiceIf an appointment is required for access to this service
Control | 0..1
Type | boolean
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
224. HealthcareService.availableTime
Definition | A collection of times that the Service Site is available.
Short | Times the Healthcare Service is availableTimes the Service Site is available
Comments | More detailed availability information may be provided in associated Schedule/Slot resources.
Control | 0..*
Type | BackboneElement
Is Modifier | false
Summary | false
Label | Operational Time
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
226. 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.
Short | Unique id for inter-element referencing
Control | 0..01
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
228. HealthcareService.availableTime.extension
Definition | An Extension 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.
Short | ExtensionAdditional content defined by implementations
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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
Slicing | This element introduces a set of slices on `HealthcareService.availableTime.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
230. HealthcareService.availableTime.extension:nhsd-timezone
Slice Name | nhsd-timezone
Definition | Australian time zone.
Short | Information about time zone for a Healthcare Service. NHSD supports ONLY ONE time zone per service
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(nhsd-timezone) (Extension Type: CodeableConcept)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
232. HealthcareService.availableTime.modifierExtension
Definition | An Extension 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).
Short | ExtensionExtensions that cannot be ignored even if unrecognized
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.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
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 Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
Slicing | This element introduces a set of slices on `HealthcareService.availableTime.modifierExtension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
234. HealthcareService.availableTime.modifierExtension:nhsd-availability-specificDate
Slice Name | nhsd-availability-specificDate
Definition | Defines the specific date at which a service is available or not available.
Short | The specific date at which a service is available or not available
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(nhsd-availability-specificDate) (Extension Type: string)
Is Modifier | false because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
236. HealthcareService.availableTime.modifierExtension:nhsd-availability-reason
Slice Name | nhsd-availability-reason
Definition | Defines the reason for the availability or unavailability of a Healthcare Service.
Short | Australian Public Holidays
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(nhsd-availability-reason) (Extension Type: CodeableConcept)
Is Modifier | false because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
238. HealthcareService.notAvailable
Definition | The HealthcareService is not available during this period of time due to the provided reason.
Short | Not available during this time due to provided reason
Control | 0..*
Type | BackboneElement
Is Modifier | false
Summary | false
Label | Non-Operational Time
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
240. 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.
Short | Unique id for inter-element referencing
Control | 0..01
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
242. HealthcareService.notAvailable.extension:nhsd-availability-specificDate
Slice Name | nhsd-availability-specificDate
Definition | Defines the specific date at which a service is available or not available.
Short | The specific date at which a service is available or not available
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(nhsd-availability-specificDate) (Extension Type: string)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
244. HealthcareService.notAvailable.extension:nhsd-availability-reason
Slice Name | nhsd-availability-reason
Definition | Defines the reason for the availability or unavailability of a Healthcare Service.
Short | Australian Public Holidays
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(nhsd-availability-reason) (Extension Type: CodeableConcept)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
246. HealthcareService.notAvailable.extension:nhsd-timezone
Slice Name | nhsd-timezone
Definition | Australian time zone.
Short | Information about time zone for a Healthcare Service. NHSD supports ONLY ONE time zone per service
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(nhsd-timezone) (Extension Type: CodeableConcept)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
248. 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).
Short | Extensions that cannot be ignored even if unrecognized
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.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
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 Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
250. HealthcareService.notAvailable.description
Definition | The reason that can be presented to the user as to why this time is not available.
Short | Reason presented to the user explaining why time not available
Control | 1..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
252. 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.
Short | Not supported, refer to availableTime and notAvailableDescription of availability exceptions
Control | 0..01
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
254. HealthcareService.endpoint
Definition | Technical endpoints providing access to services operated for the specific healthcare services defined at this resource.
Short | NHSD supports Healthcare Service to refer to maximum of one Endpoint resource (with corresponding SMD Target identifier) per secure messaging vendor productTechnical endpoints providing access to electronic services operated for the healthcare service
Control | 0..*
Type | Reference(NHSD Secure Messaging Endpoint, Endpoint)
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

Guidance on how to interpret the contents of this table can be foundhere

0. HealthcareService
Short | A healthcare service in an Australian healthcare context e.g., a healthcare service provided at a site
Comments | NHSD HealthcareService.
2. HealthcareService.id
Short | Logical FHIR id for unique identification of the Healthcare Service resource within the FHIR bundle
Control | 1..?
4. HealthcareService.meta
Short | Metadata about Healthcare Service resource
Control | 1..?
6. HealthcareService.meta.id
Control | 0..0
8. HealthcareService.meta.extension
Slicing | This element introduces a set of slices on `HealthcareService.meta.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
10. HealthcareService.meta.extension:proximityDistance
Slice Name | proximityDistance
Short | The distance in meters/kilometers of the service
Type | Extension(proximity-distance) (Extension Type: decimal)
12. HealthcareService.meta.extension:operationalStatus
Slice Name | operationalStatus
Definition | Defines the operational status of a service which could be OPEN, CLOSED OR UNKNOWN.
Short | Operational status of the service
Control | 0..1
Type | Extension(operationalStatus) (Complex Extension)
14. HealthcareService.meta.versionId
Control | 0..0
16. HealthcareService.meta.lastUpdated
Short | The timestamp when the resource was last updated
Control | 1..?
18. HealthcareService.meta.source
Control | 0..0
20. HealthcareService.meta.profile
Control | 0..0
22. HealthcareService.meta.security
Control | 0..0
24. HealthcareService.meta.tag
Control | 0..0
26. HealthcareService.implicitRules
Control | 0..0
28. HealthcareService.language
Control | 0..0
30. HealthcareService.text
Control | 0..0
32. HealthcareService.extension
Slicing | This element introduces a set of slices on `HealthcareService.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
34. HealthcareService.extension:bookingProvider
Slice Name | bookingProvider
Definition | Lists booking providers which offer web accessible link in order to book with this service.
Short | Information about Booking Providers for a Healthcare Service
Type | Extension(nhsd-booking-provider) (Complex Extension)
36. HealthcareService.modifierExtension
Control | 0..0
38. HealthcareService.identifier
Comments | NHSD HealthcareService
Note | This is a business identifier, not a resource identifier (see discussion)
40. HealthcareService.identifier:hpio
Slice Name | hpio
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..0
42. HealthcareService.identifier:pdvendor
Slice Name | pdvendor
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..0
44. HealthcareService.identifier:rid
Slice Name | rid
Definition | NHSD HealthcareService Resource Identifier
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..1
Type | Identifier(nhsd-resource-identifier)
Is Modifier | false
Must Support | true
46. HealthcareService.active
Short | Reflects the current status of the Healthcare Service resource
48. HealthcareService.providedBy
Short | Reference to the Organization resource that provides the service
Type | Reference(NHSD Organisation)
50. HealthcareService.category
Short | Not currently supported
Control | 0..0
52. HealthcareService.type
Short | Type of service that may be delivered or performed. Each HealthcareService resource must have only 1 preferred service type
Control | 1..?
Binding | The codes SHOULD be taken from Healthcare Service Types SNOMED-CT (preferred to `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-healthcareservice-serviceType` )
54. HealthcareService.type.id
Control | 0..0
56. HealthcareService.type.coding
Control | 1..?
58. HealthcareService.specialty:snomedRole
Slice Name | snomedRole
Short | NHSD server makes use of type attribute
Control | 0..0
60. HealthcareService.location
Short | Reference to the Location resource.
Type | Reference(NHSD Location)
62. HealthcareService.name
Short | Healthcare Service name, which may include department level information for Hospitals.
Control | 0..1
64. HealthcareService.comment
Short | A short description of the Healthcare Service, which may include additional information not covered elsewhere.
66. HealthcareService.extraDetails
Control | 0..0
68. HealthcareService.photo
Control | 0..0
70. HealthcareService.telecom
Short | Contact information related to the Healthcare Service
Type | ContactPoint
Label | Communication Details
72. HealthcareService.telecom.id
Control | 0..0
74. HealthcareService.telecom.extension:contactPurpose
Slice Name | contactPurpose
Type | Extension(au-contact-purpose) (Extension Type: CodeableConcept)
Must Support | true
76. HealthcareService.telecom.system
Short | phone | fax | email | url
Control | 1..?
Binding | The codes SHALL be taken from Contact Point System (required to `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-contact-point-system` ) Telecommunications form for contact point.
78. HealthcareService.telecom.value
Control | 1..?
80. HealthcareService.telecom.use
Control | 0..0
82. HealthcareService.telecom.rank
Control | 0..0
84. HealthcareService.telecom.period
Control | 0..0
86. HealthcareService.coverageArea
Definition | The location(s) that this service is available to (not where the service is provided). The NHSD FHIR Server provide these resources as CONTAINED elements.
Short | Reference to the list of 'contained' Location resources defining the coverage area of virtual/home visit type of Healthcare Services.
88. HealthcareService.serviceProvisionCode
Short | Reflects the billing option type the Healthcare Service supports
Control | 0..1
Binding | The codes SHALL be taken from Healthcare Service Provision Conditions (required to `http://fhir.nhsd.com.au/ValueSet/valueset-nhsd-service-provision-conditions` )
90. HealthcareService.eligibility
Short | Specific eligibility requirements required to use the service
Control | 0..*
Type | BackboneElement
92. HealthcareService.eligibility.code
Definition | Coded value for the eligibility.
Short | Coded value for the eligibility
Control | 1..1
Binding | The codes SHALL be taken from Healthcare Service Eligibility criteria (required to `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-eligibility` ) Eligibility for service provided by Healthcare provider
Type | CodeableConcept
94. HealthcareService.program
Short | Name of program(s) that the Healthcare Service is a part of
Binding | Unless not suitable, these codes SHALL be taken from Healthcare Service Programs (Funded or Unfunded) (extensible to `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-program` ) Name of program(s) that the Healthcare Service is a part of
96. HealthcareService.characteristic
Definition | Collection of characteristics (attributes), bound to known CodeSystems for various groups of characteristics.
Short | Various characteristics of the Healthcare Service like offering etc
Slicing | This element introduces a set of slices on `HealthcareService.characteristic`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ coding.system
98. HealthcareService.characteristic:facility
Slice Name | facility
Short | Facilities available or provided at a Healthcare Service location
Binding | The codes SHALL be taken from Healthcare Service Facilities (required to `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-facility` ) Facilities available or provided at a Healthcare Service location
100. HealthcareService.characteristic:facility.extension
Slicing | This element introduces a set of slices on `HealthcareService.characteristic.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
102. HealthcareService.characteristic:facility.extension:facilities-characteristic-group
Slice Name | facilities-characteristic-group
Short | -
Control | 1..1
Type | Extension(Characteristic Group) (Extension Type: string)
104. HealthcareService.characteristic:facility.extension:facilities-characteristic-group.valueString:valueString
Slice Name | valueString
Fixed Value | `facilities`
106. HealthcareService.characteristic:facility.coding
Short | -
108. HealthcareService.characteristic:fundingsource
Slice Name | fundingsource
Short | Funding Sources which support this Healthcare Service.
Binding | The codes SHALL be taken from Healthcare Service Funding Sources (required to `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-fundingSource` ) Funding Sources which support this Healthcare Service.
110. HealthcareService.characteristic:fundingsource.extension
Slicing | This element introduces a set of slices on `HealthcareService.characteristic.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
112. HealthcareService.characteristic:fundingsource.extension:fundingsource-characteristic-group
Slice Name | fundingsource-characteristic-group
Short | -
Control | 1..1
Type | Extension(Characteristic Group) (Extension Type: string)
114. HealthcareService.characteristic:fundingsource.extension:fundingsource-characteristic-group.valueString:valueString
Slice Name | valueString
Fixed Value | `fundingSource`
116. HealthcareService.characteristic:fundingsource.coding
Short | -
118. HealthcareService.characteristic:healthcareServiceCharacteristic
Slice Name | healthcareServiceCharacteristic
Short | Miscellaneous characteristics of a Healthcare Service
Binding | The codes SHALL be taken from Healthcare Service miscellaneous characteristics (required to `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-healthcareServiceCharacteristic` ) Miscellaneous characteristics of a Healthcare Service
120. HealthcareService.characteristic:healthcareServiceCharacteristic.extension
Slicing | This element introduces a set of slices on `HealthcareService.characteristic.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
122. HealthcareService.characteristic:healthcareServiceCharacteristic.extension:plsc-characteristic-group
Slice Name | plsc-characteristic-group
Short | -
Control | 1..1
Type | Extension(Characteristic Group) (Extension Type: string)
124. HealthcareService.characteristic:healthcareServiceCharacteristic.extension:plsc-characteristic-group.valueString:valueString
Slice Name | valueString
Fixed Value | `characteristics`
126. HealthcareService.characteristic:healthcareServiceCharacteristic.coding
Short | -
128. HealthcareService.characteristic:referralInformation
Slice Name | referralInformation
Short | Referral Instructions and Information
Binding | The codes SHALL be taken from Healthcare Service referral instructions and information (required to `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-referralInformation` ) Referral Instructions and Information
130. HealthcareService.characteristic:referralInformation.extension
Slicing | This element introduces a set of slices on `HealthcareService.characteristic.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
132. HealthcareService.characteristic:referralInformation.extension:referral-characteristic-group
Slice Name | referral-characteristic-group
Short | -
Control | 1..1
Type | Extension(Characteristic Group) (Extension Type: string)
134. HealthcareService.characteristic:referralInformation.extension:referral-characteristic-group.valueString:valueString
Slice Name | valueString
Fixed Value | `referralInformation`
136. HealthcareService.characteristic:referralInformation.extension:referralInstruction
Slice Name | referralInstruction
Short | Referral Instructions and Information
Control | 0..1
Type | Extension(characteristic-extendedValues) (Extension Type: string)
138. HealthcareService.characteristic:referralInformation.coding
Short | -
140. HealthcareService.characteristic:offering
Slice Name | offering
Definition | Collection of characteristics (attributes), bound to known CodeSystems for various groups of characteristics.
Short | This contains the list of various offerings that the Healthcare Service has
Binding | The codes SHALL be taken from Healthcare Service Offerings (required to `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-offering` ) Supporting services offered at a Healthcare Service
142. HealthcareService.characteristic:offering.extension
Slicing | This element introduces a set of slices on `HealthcareService.characteristic.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
144. HealthcareService.characteristic:offering.extension:offering-characteristic-group
Slice Name | offering-characteristic-group
Short | -
Control | 1..1
Type | Extension(Characteristic Group) (Extension Type: string)
146. HealthcareService.characteristic:offering.extension:offering-characteristic-group.valueString:valueString
Slice Name | valueString
Fixed Value | `offerings`
148. HealthcareService.characteristic:offering.coding
Short | -
150. HealthcareService.communication
Binding | The codes SHALL be taken from Common Languages in Australia (required to `https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2` )
Must Support | true
152. HealthcareService.referralMethod
Control | 0..0
154. HealthcareService.appointmentRequired
Short | It indicates if an appointment is required for this Healthcare Service
Control | 0..1
156. HealthcareService.availableTime
Short | Times the Healthcare Service is available
Label | Operational Time
158. HealthcareService.availableTime.id
Control | 0..0
160. HealthcareService.availableTime.extension
Slicing | This element introduces a set of slices on `HealthcareService.availableTime.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
162. HealthcareService.availableTime.extension:nhsd-timezone
Slice Name | nhsd-timezone
Definition | Australian time zone.
Short | Information about time zone for a Healthcare Service. NHSD supports ONLY ONE time zone per service
Control | 0..1
Type | Extension(nhsd-timezone) (Extension Type: CodeableConcept)
164. HealthcareService.availableTime.modifierExtension:nhsd-availability-specificDate
Slice Name | nhsd-availability-specificDate
Control | 0..1
Type | Extension(nhsd-availability-specificDate) (Extension Type: string)
166. HealthcareService.availableTime.modifierExtension:nhsd-availability-reason
Slice Name | nhsd-availability-reason
Control | 0..1
Type | Extension(nhsd-availability-reason) (Extension Type: CodeableConcept)
168. HealthcareService.availableTime.availableStartTime
170. HealthcareService.availableTime.availableStartTime.id
Control | 0..0
172. HealthcareService.availableTime.availableStartTime.extension
Control | 0..0
174. HealthcareService.availableTime.availableStartTime.value
Control | 0..0
176. HealthcareService.availableTime.availableEndTime
178. HealthcareService.availableTime.availableEndTime.id
Control | 0..0
180. HealthcareService.availableTime.availableEndTime.extension
Control | 0..0
182. HealthcareService.availableTime.availableEndTime.value
Control | 0..0
184. HealthcareService.notAvailable
Label | Non-Operational Time
186. HealthcareService.notAvailable.id
Control | 0..0
188. HealthcareService.notAvailable.extension:nhsd-availability-specificDate
Slice Name | nhsd-availability-specificDate
Control | 0..1
Type | Extension(nhsd-availability-specificDate) (Extension Type: string)
190. HealthcareService.notAvailable.extension:nhsd-availability-reason
Slice Name | nhsd-availability-reason
Control | 0..1
Type | Extension(nhsd-availability-reason) (Extension Type: CodeableConcept)
192. HealthcareService.notAvailable.extension:nhsd-timezone
Slice Name | nhsd-timezone
Definition | Australian time zone.
Short | Information about time zone for a Healthcare Service. NHSD supports ONLY ONE time zone per service
Control | 0..1
Type | Extension(nhsd-timezone) (Extension Type: CodeableConcept)
194. HealthcareService.availabilityExceptions
Short | Not supported, refer to availableTime and notAvailable
Control | 0..0
196. HealthcareService.endpoint
Short | NHSD supports Healthcare Service to refer to maximum of one Endpoint resource (with corresponding SMD Target identifier) per secure messaging vendor product
Type | Reference(NHSD Secure Messaging Endpoint)

Guidance on how to interpret the contents of this table can be foundhere

0. HealthcareService
Definition | The details of a healthcare service for directory use.
Short | A healthcare service in an Australian healthcare context e.g., a healthcare service provided at a site
Comments | NHSD HealthcareService.
Control | 0..*
Is Modifier | false
Summary | false
Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (`contained.contained.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-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-6: A resource should have narrative for robust management (`text.div.exists()`) dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (`contained.meta.security.empty()`)
2. HealthcareService.id
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Short | Logical FHIR id for unique identification of the Healthcare Service resource within the FHIR bundle
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.
Control | 1..1
Type | id
Is Modifier | false
Summary | true
4. 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.
Short | Metadata about Healthcare Service resource
Control | 1..1
Type | Meta
Is Modifier | false
Summary | true
6. 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.
Short | Unique id for inter-element referencing
Control | 0..0
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
8. HealthcareService.meta.extension
Definition | An Extension
Short | Extension
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Slicing | This element introduces a set of slices on `HealthcareService.meta.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
10. HealthcareService.meta.extension:proximityDistance
Slice Name | proximityDistance
Definition | An Extension
Short | The distance in meters/kilometers of the service
Control | 0..1
Type | Extension(proximity-distance) (Extension Type: decimal)
Is Modifier | false
Summary | false
12. HealthcareService.meta.extension:operationalStatus
Slice Name | operationalStatus
Definition | Defines the operational status of a service which could be OPEN, CLOSED OR UNKNOWN.
Short | Operational status of the service
Control | 0..1
Type | Extension(operationalStatus) (Complex Extension)
Is Modifier | false
14. 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.
Short | Version specific identifier
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.
Control | 0..0
Type | id
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
16. HealthcareService.meta.lastUpdated
Definition | When the resource last changed - e.g. when the version changed.
Short | The timestamp when the resource was last updated
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.
Control | 1..1
Type | instant
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
18. 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.
Short | Identifies where the resource comes from
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.
Control | 0..0
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
20. 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.
Short | Profiles this resource claims to conform to
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.
Control | 0..0
Type | canonical(StructureDefinition)
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
22. HealthcareService.meta.security
Definition | Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.
Short | Security Labels applied to this resource
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.
Control | 0..0
Binding | Unless not suitable, these codes SHALL be taken from All Security Labels (extensible to `http://hl7.org/fhir/ValueSet/security-labels` ) Security Labels from the Healthcare Privacy and Security Classification System.
Type | Coding
Is Modifier | false
Summary | true
24. 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.
Short | Tags applied to this resource
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.
Control | 0..0
Binding | For example codes, see CommonTags (example to `http://hl7.org/fhir/ValueSet/common-tags` ) Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
Type | Coding
Is Modifier | false
Summary | true
26. 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.
Short | A set of rules under which this content was created
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.
Control | 0..0
Type | uri
Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
28. HealthcareService.language
Definition | The base language in which the resource is written.
Short | Language of the resource content
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).
Control | 0..0
Binding | The codes SHOULD be taken from CommonLanguages (preferred to `http://hl7.org/fhir/ValueSet/languages` ) A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
30. 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.
Short | Text summary of the resource, for human interpretation
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.
Control | 0..0
Type | Narrative
Is Modifier | false
Summary | false
Alternate Names | narrative, html, xhtml, display
32. 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.
Short | Contained, inline 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.
Control | 0..*
Type | Resource
Is Modifier | false
Summary | false
Alternate Names | inline resources, anonymous resources, contained resources
34. HealthcareService.extension
Definition | An Extension
Short | Extension
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Slicing | This element introduces a set of slices on `HealthcareService.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
36. HealthcareService.extension:bookingProvider
Slice Name | bookingProvider
Definition | Lists booking providers which offer web accessible link in order to book with this service.
Short | Information about Booking Providers for a Healthcare Service
Control | 0..*
Type | Extension(nhsd-booking-provider) (Complex Extension)
Is Modifier | false
38. HealthcareService.modifierExtension
Definition | An Extension
Short | Extension
Control | 0..0
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Summary | false
40. HealthcareService.identifier
Definition | External identifiers for this item.
Short | Healthcare service identifiers
Comments | NHSD HealthcareService
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..*
Type | Identifier
Is Modifier | false
Must Support | true
Summary | true
Slicing | This element introduces a set of slices on `HealthcareService.identifier`. The slices areUnordered and Open, and can be differentiated using the following discriminators: pattern @ type value @ system
42. HealthcareService.identifier:hpio
Slice Name | hpio
Definition | National identifier Health Provider Identifier for Organisations for Healthcare Service
Short | HPI-O for Directory Entry Organisation
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..0
Type | Identifier
Is Modifier | false
Must Support | true
Summary | true
Invariants | 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)`)
79. HealthcareService.identifier:pdvendor
Slice Name | pdvendor
Definition | Vendor allocated directory identifier this can be used for search for specific healtchare service directory entry and/or for routing of messages.
Short | Secure Messaging Vendor's Healthcare Service Identifier
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..0
Type | Identifier
Is Modifier | false
Must Support | true
Summary | true
129. HealthcareService.identifier:rid
Slice Name | rid
Definition | NHSD HealthcareService Resource Identifier
Short | Healthcare service identifiers
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..1
Type | Identifier(nhsd-resource-identifier)
Is Modifier | false
Must Support | true
Summary | true
131. 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.
Short | Reflects the current status of the Healthcare Service resource
Comments | This element is labeled as a modifier because it may be used to mark that the resource was created in error.
Control | 1..1
Type | boolean
Is Modifier | true because This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Meaning if Missing | This resource is generally assumed to be active if no value is provided for the active element
133. HealthcareService.providedBy
Definition | The organization that provides this healthcare service.
Short | Reference to the Organization resource that provides the service
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.
Control | 1..1
Type | Reference(NHSD Organisation)
Is Modifier | false
Must Support | true
Summary | true
135. HealthcareService.category
Definition | Identifies the broad category of service being performed or delivered.
Short | Not currently supported
Comments | Selecting a Service Category then determines the list of relevant service types that can be selected in the primary service type.
Control | 0..0
Binding | For example codes, see ServiceCategory (example to `http://hl7.org/fhir/ValueSet/service-category` ) A category of the service(s) that could be provided.
Type | CodeableConcept
Is Modifier | false
Summary | true
Alternate Names | service category
137. HealthcareService.type
Definition | The specific type of service that may be delivered or performed.
Short | Type of service that may be delivered or performed. Each HealthcareService resource must have only 1 preferred service type
Control | 1..*
Binding | The codes SHOULD be taken from Healthcare Service Types SNOMED-CT (preferred to `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-healthcareservice-serviceType` )
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | true
Alternate Names | service type
139. HealthcareService.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.
Short | Unique id for inter-element referencing
Control | 0..0
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
141. HealthcareService.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.
Short | Additional content defined by implementations
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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `HealthcareService.type.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
143. HealthcareService.type.coding
Definition | A reference to a code defined by a terminology system.
Short | Code defined by a terminology system
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.
Control | 1..*
Type | Coding
Is Modifier | false
Summary | true
Requirements | Allows for alternative encodings within a code system, and translations to other code systems.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
145. HealthcareService.type.text
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
Short | Plain text representation of the concept
Comments | Very often the text is the same as a displayName of one of the codings.
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
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.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
147. HealthcareService.specialty:snomedRole
Slice Name | snomedRole
Definition | Collection of specialties handled by the service site. This is more of a medical term.
Short | NHSD server makes use of type attribute
Control | 0..0
Binding | ​The codes SHOULD be taken from http://hl7.org.au/fhir/ValueSet/snomed-healthcareservice-specialties (preferred to `http://hl7.org.au/fhir/ValueSet/snomed-healthcareservice-specialties` ) A specialty role that a healthcare service may provide.
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | true
149. HealthcareService.location
Definition | The location(s) where this healthcare service may be provided.
Short | Reference to the Location resource.
Control | 1..1
Type | Reference(NHSD Location)
Is Modifier | false
Must Support | true
Summary | true
151. HealthcareService.name
Definition | Further description of the service as it would be presented to a consumer while searching.
Short | Healthcare Service name, which may include department level information for Hospitals.
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
153. 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.
Short | A short description of the Healthcare Service, which may include additional information not covered elsewhere.
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.
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
155. HealthcareService.extraDetails
Definition | Extra details about the service that can't be placed in the other fields.
Short | Extra details about the service that can't be placed in the other fields
Control | 0..0
Type | markdown
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
157. 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.
Short | Facilitates quick identification of the service
Control | 0..0
Type | Attachment
Is Modifier | false
Summary | true
159. HealthcareService.telecom
Definition | List of contacts related to this specific healthcare service.
Short | Contact information related to the Healthcare Service
Comments | If this is empty, then refer to the location's contacts.
Control | 0..*
Type | ContactPoint
Is Modifier | false
Must Support | true
Summary | false
Label | Communication Details
161. HealthcareService.telecom.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..0
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
163. HealthcareService.telecom.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.
Short | Additional content defined by implementations
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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `HealthcareService.telecom.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
165. HealthcareService.telecom.extension:contactPurpose
Slice Name | contactPurpose
Definition | Defines the contact purpose for the resource. T
Short | The contact purpose for the resource
Control | 0..*
Type | Extension(au-contact-purpose) (Extension Type: CodeableConcept)
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
167. HealthcareService.telecom.system
Definition | Telecommunications form for contact point - what communications system is required to make use of the contact.
Short | phone | fax | email | url
Control | 1..1 This element is affected by the following invariants: cpt-2
Binding | The codes SHALL be taken from Contact Point System (required to `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-contact-point-system` ) Telecommunications form for contact point.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
169. HealthcareService.telecom.value
Definition | The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).
Short | The actual contact point details
Comments | Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.
Control | 1..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to support legacy numbers that are not in a tightly controlled format.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
171. HealthcareService.telecom.use
Definition | Identifies the purpose for the contact point.
Short | home | work | temp | old | mobile - purpose of this contact point
Comments | Applications can assume that a contact is current unless it explicitly says that it is temporary or old.
Control | 0..0
Binding | The codes SHALL be taken from ContactPointUse (required to `http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1` ) Use of contact point.
Type | code
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
173. HealthcareService.telecom.rank
Definition | Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.
Short | Specify preferred order of use (1 = highest)
Comments | Note that rank does not necessarily follow the order in which the contacts are represented in the instance.
Control | 0..0
Type | positiveInt
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
175. HealthcareService.telecom.period
Definition | Time period when the contact point was/is in use.
Short | Time period when the contact point was/is in use
Control | 0..0
Type | Period
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
177. HealthcareService.coverageArea
Definition | The location(s) that this service is available to (not where the service is provided). The NHSD FHIR Server provide these resources as CONTAINED elements.
Short | Reference to the list of 'contained' Location resources defining the coverage area of virtual/home visit type of Healthcare Services.
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".
Control | 0..*
Type | Reference(Location)
Is Modifier | false
Summary | false
179. HealthcareService.serviceProvisionCode
Definition | The code(s) that detail the conditions under which the healthcare service is available/offered.
Short | Reflects the billing option type the Healthcare Service supports
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.
Control | 0..1
Binding | The codes SHALL be taken from Healthcare Service Provision Conditions (required to `http://fhir.nhsd.com.au/ValueSet/valueset-nhsd-service-provision-conditions` )
Type | CodeableConcept
Is Modifier | false
Summary | false
181. HealthcareService.eligibility
Definition | Does this service have specific eligibility requirements that need to be met in order to use the service?
Short | Specific eligibility requirements required to use the service
Control | 0..*
Type | BackboneElement
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
183. 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.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
185. 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.
Short | Additional content defined by implementations
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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
187. 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).
Short | Extensions that cannot be ignored even if unrecognized
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.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
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 Names | extensions, user content, modifiers
189. HealthcareService.eligibility.code
Definition | Coded value for the eligibility.
Short | Coded value for the eligibility
Control | 1..1
Binding | The codes SHALL be taken from Healthcare Service Eligibility criteria (required to `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-eligibility` ) Eligibility for service provided by Healthcare provider
Type | CodeableConcept
Is Modifier | false
Summary | false
191. HealthcareService.eligibility.comment
Definition | Describes the eligibility conditions for the service.
Short | Describes the eligibility conditions for the service
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.
Control | 0..1
Type | markdown
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
193. HealthcareService.program
Definition | Programs that this service is applicable to.
Short | Name of program(s) that the Healthcare Service is a part of
Comments | Programs are often defined externally to an Organization, commonly by governments; e.g. Home and Community Care Programs, Homeless Program, ….
Control | 0..*
Binding | Unless not suitable, these codes SHALL be taken from Healthcare Service Programs (Funded or Unfunded) (extensible to `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-program` ) Name of program(s) that the Healthcare Service is a part of
Type | CodeableConcept
Is Modifier | false
Summary | false
195. HealthcareService.characteristic
Definition | Collection of characteristics (attributes), bound to known CodeSystems for various groups of characteristics.
Short | Various characteristics of the Healthcare Service like offering etc
Comments | These could be such things as is wheelchair accessible.
Control | 0..*
Binding | A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy).
Type | CodeableConcept
Is Modifier | false
Summary | false
Slicing | This element introduces a set of slices on `HealthcareService.characteristic`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ coding.system
197. HealthcareService.characteristic:facility
Slice Name | facility
Definition | Collection of characteristics (attributes).
Short | Facilities available or provided at a Healthcare Service location
Comments | These could be such things as is wheelchair accessible.
Control | 0..*
Binding | The codes SHALL be taken from Healthcare Service Facilities (required to `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-facility` ) Facilities available or provided at a Healthcare Service location
Type | CodeableConcept
Is Modifier | false
Summary | false
199. HealthcareService.characteristic:facility.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
201. HealthcareService.characteristic:facility.extension
Definition | An Extension
Short | Extension
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `HealthcareService.characteristic.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
203. HealthcareService.characteristic:facility.extension:facilities-characteristic-group
Slice Name | facilities-characteristic-group
Definition | An Extension
Short | -
Control | 1..1
Type | Extension(Characteristic Group) (Extension Type: string)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
205. HealthcareService.characteristic:facility.extension:facilities-characteristic-group.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
207. HealthcareService.characteristic:facility.extension:facilities-characteristic-group.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.
Short | Additional content defined by implementations
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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `HealthcareService.characteristic.extension.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
209. HealthcareService.characteristic:facility.extension:facilities-characteristic-group.url
Definition | Source of the definition for the extension code - a logical name or a URL.
Short | identifies the meaning of the extension
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.
Control | 1..1
Type | uri
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
Fixed Value | `http://fhir.nhsd.com.au/StructureDefinition/characteristic-group`
211. HealthcareService.characteristic:facility.extension:facilities-characteristic-group.value[x]
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short | Value of extension
Control | 1..1
Type | string
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
Slicing | This element introduces a set of slices on `HealthcareService.characteristic.extension.value[x]`. The slices areUnordered and Closed, and can be differentiated using the following discriminators: type @ $this
213. HealthcareService.characteristic:facility.extension:facilities-characteristic-group.value[x]:valueString
Slice Name | valueString
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short | Value of extension
Control | 1..1
Type | string
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Fixed Value | `facilities`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
215. HealthcareService.characteristic:facility.coding
Definition | A reference to a code defined by a terminology system.
Short | -
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.
Control | 0..*
Type | Coding
Is Modifier | false
Summary | true
Requirements | Allows for alternative encodings within a code system, and translations to other code systems.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
217. HealthcareService.characteristic:facility.text
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
Short | Plain text representation of the concept
Comments | Very often the text is the same as a displayName of one of the codings.
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
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.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
219. HealthcareService.characteristic:fundingsource
Slice Name | fundingsource
Definition | Collection of characteristics (attributes).
Short | Funding Sources which support this Healthcare Service.
Comments | These could be such things as is wheelchair accessible.
Control | 0..*
Binding | The codes SHALL be taken from Healthcare Service Funding Sources (required to `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-fundingSource` ) Funding Sources which support this Healthcare Service.
Type | CodeableConcept
Is Modifier | false
Summary | false
221. HealthcareService.characteristic:fundingsource.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
223. HealthcareService.characteristic:fundingsource.extension
Definition | An Extension
Short | Extension
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `HealthcareService.characteristic.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
225. HealthcareService.characteristic:fundingsource.extension:fundingsource-characteristic-group
Slice Name | fundingsource-characteristic-group
Definition | An Extension
Short | -
Control | 1..1
Type | Extension(Characteristic Group) (Extension Type: string)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
227. HealthcareService.characteristic:fundingsource.extension:fundingsource-characteristic-group.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
229. HealthcareService.characteristic:fundingsource.extension:fundingsource-characteristic-group.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.
Short | Additional content defined by implementations
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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `HealthcareService.characteristic.extension.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
231. HealthcareService.characteristic:fundingsource.extension:fundingsource-characteristic-group.url
Definition | Source of the definition for the extension code - a logical name or a URL.
Short | identifies the meaning of the extension
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.
Control | 1..1
Type | uri
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
Fixed Value | `http://fhir.nhsd.com.au/StructureDefinition/characteristic-group`
233. HealthcareService.characteristic:fundingsource.extension:fundingsource-characteristic-group.value[x]
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short | Value of extension
Control | 1..1
Type | string
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
Slicing | This element introduces a set of slices on `HealthcareService.characteristic.extension.value[x]`. The slices areUnordered and Closed, and can be differentiated using the following discriminators: type @ $this
235. HealthcareService.characteristic:fundingsource.extension:fundingsource-characteristic-group.value[x]:valueString
Slice Name | valueString
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short | Value of extension
Control | 1..1
Type | string
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Fixed Value | `fundingSource`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
237. HealthcareService.characteristic:fundingsource.coding
Definition | A reference to a code defined by a terminology system.
Short | -
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.
Control | 0..*
Type | Coding
Is Modifier | false
Summary | true
Requirements | Allows for alternative encodings within a code system, and translations to other code systems.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
239. HealthcareService.characteristic:fundingsource.text
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
Short | Plain text representation of the concept
Comments | Very often the text is the same as a displayName of one of the codings.
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
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.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
241. HealthcareService.characteristic:healthcareServiceCharacteristic
Slice Name | healthcareServiceCharacteristic
Definition | Collection of characteristics (attributes).
Short | Miscellaneous characteristics of a Healthcare Service
Comments | These could be such things as is wheelchair accessible.
Control | 0..*
Binding | The codes SHALL be taken from Healthcare Service miscellaneous characteristics (required to `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-healthcareServiceCharacteristic` ) Miscellaneous characteristics of a Healthcare Service
Type | CodeableConcept
Is Modifier | false
Summary | false
243. HealthcareService.characteristic:healthcareServiceCharacteristic.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
245. HealthcareService.characteristic:healthcareServiceCharacteristic.extension
Definition | An Extension
Short | Extension
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `HealthcareService.characteristic.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
247. HealthcareService.characteristic:healthcareServiceCharacteristic.extension:plsc-characteristic-group
Slice Name | plsc-characteristic-group
Definition | An Extension
Short | -
Control | 1..1
Type | Extension(Characteristic Group) (Extension Type: string)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
249. HealthcareService.characteristic:healthcareServiceCharacteristic.extension:plsc-characteristic-group.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
251. HealthcareService.characteristic:healthcareServiceCharacteristic.extension:plsc-characteristic-group.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.
Short | Additional content defined by implementations
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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `HealthcareService.characteristic.extension.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
253. HealthcareService.characteristic:healthcareServiceCharacteristic.extension:plsc-characteristic-group.url
Definition | Source of the definition for the extension code - a logical name or a URL.
Short | identifies the meaning of the extension
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.
Control | 1..1
Type | uri
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
Fixed Value | `http://fhir.nhsd.com.au/StructureDefinition/characteristic-group`
255. HealthcareService.characteristic:healthcareServiceCharacteristic.extension:plsc-characteristic-group.value[x]
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short | Value of extension
Control | 1..1
Type | string
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
Slicing | This element introduces a set of slices on `HealthcareService.characteristic.extension.value[x]`. The slices areUnordered and Closed, and can be differentiated using the following discriminators: type @ $this
257. HealthcareService.characteristic:healthcareServiceCharacteristic.extension:plsc-characteristic-group.value[x]:valueString
Slice Name | valueString
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short | Value of extension
Control | 1..1
Type | string
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Fixed Value | `characteristics`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
259. HealthcareService.characteristic:healthcareServiceCharacteristic.coding
Definition | A reference to a code defined by a terminology system.
Short | -
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.
Control | 0..*
Type | Coding
Is Modifier | false
Summary | true
Requirements | Allows for alternative encodings within a code system, and translations to other code systems.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
261. HealthcareService.characteristic:healthcareServiceCharacteristic.text
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
Short | Plain text representation of the concept
Comments | Very often the text is the same as a displayName of one of the codings.
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
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.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
263. HealthcareService.characteristic:referralInformation
Slice Name | referralInformation
Definition | Collection of characteristics (attributes).
Short | Referral Instructions and Information
Comments | These could be such things as is wheelchair accessible.
Control | 0..*
Binding | The codes SHALL be taken from Healthcare Service referral instructions and information (required to `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-referralInformation` ) Referral Instructions and Information
Type | CodeableConcept
Is Modifier | false
Summary | false
265. HealthcareService.characteristic:referralInformation.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
267. HealthcareService.characteristic:referralInformation.extension
Definition | An Extension
Short | Extension
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `HealthcareService.characteristic.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
269. HealthcareService.characteristic:referralInformation.extension:referral-characteristic-group
Slice Name | referral-characteristic-group
Definition | An Extension
Short | -
Control | 1..1
Type | Extension(Characteristic Group) (Extension Type: string)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
271. HealthcareService.characteristic:referralInformation.extension:referral-characteristic-group.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
273. HealthcareService.characteristic:referralInformation.extension:referral-characteristic-group.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.
Short | Additional content defined by implementations
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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `HealthcareService.characteristic.extension.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
275. HealthcareService.characteristic:referralInformation.extension:referral-characteristic-group.url
Definition | Source of the definition for the extension code - a logical name or a URL.
Short | identifies the meaning of the extension
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.
Control | 1..1
Type | uri
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
Fixed Value | `http://fhir.nhsd.com.au/StructureDefinition/characteristic-group`
277. HealthcareService.characteristic:referralInformation.extension:referral-characteristic-group.value[x]
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short | Value of extension
Control | 1..1
Type | string
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
Slicing | This element introduces a set of slices on `HealthcareService.characteristic.extension.value[x]`. The slices areUnordered and Closed, and can be differentiated using the following discriminators: type @ $this
279. HealthcareService.characteristic:referralInformation.extension:referral-characteristic-group.value[x]:valueString
Slice Name | valueString
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short | Value of extension
Control | 1..1
Type | string
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Fixed Value | `referralInformation`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
281. HealthcareService.characteristic:referralInformation.extension:referralInstruction
Slice Name | referralInstruction
Definition | An Extension
Short | Referral Instructions and Information
Control | 0..1
Type | Extension(characteristic-extendedValues) (Extension Type: string)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
283. HealthcareService.characteristic:referralInformation.coding
Definition | A reference to a code defined by a terminology system.
Short | -
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.
Control | 0..*
Type | Coding
Is Modifier | false
Summary | true
Requirements | Allows for alternative encodings within a code system, and translations to other code systems.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
285. HealthcareService.characteristic:referralInformation.text
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
Short | Plain text representation of the concept
Comments | Very often the text is the same as a displayName of one of the codings.
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
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.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
287. HealthcareService.characteristic:offering
Slice Name | offering
Definition | Collection of characteristics (attributes), bound to known CodeSystems for various groups of characteristics.
Short | This contains the list of various offerings that the Healthcare Service has
Comments | These could be such things as is wheelchair accessible.
Control | 0..*
Binding | The codes SHALL be taken from Healthcare Service Offerings (required to `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-offering` ) Supporting services offered at a Healthcare Service
Type | CodeableConcept
Is Modifier | false
Summary | false
289. HealthcareService.characteristic:offering.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
291. HealthcareService.characteristic:offering.extension
Definition | An Extension
Short | Extension
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `HealthcareService.characteristic.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
293. HealthcareService.characteristic:offering.extension:offering-characteristic-group
Slice Name | offering-characteristic-group
Definition | An Extension
Short | -
Control | 1..1
Type | Extension(Characteristic Group) (Extension Type: string)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
295. HealthcareService.characteristic:offering.extension:offering-characteristic-group.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
297. HealthcareService.characteristic:offering.extension:offering-characteristic-group.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.
Short | Additional content defined by implementations
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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `HealthcareService.characteristic.extension.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
299. HealthcareService.characteristic:offering.extension:offering-characteristic-group.url
Definition | Source of the definition for the extension code - a logical name or a URL.
Short | identifies the meaning of the extension
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.
Control | 1..1
Type | uri
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
Fixed Value | `http://fhir.nhsd.com.au/StructureDefinition/characteristic-group`
301. HealthcareService.characteristic:offering.extension:offering-characteristic-group.value[x]
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short | Value of extension
Control | 1..1
Type | string
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
Slicing | This element introduces a set of slices on `HealthcareService.characteristic.extension.value[x]`. The slices areUnordered and Closed, and can be differentiated using the following discriminators: type @ $this
303. HealthcareService.characteristic:offering.extension:offering-characteristic-group.value[x]:valueString
Slice Name | valueString
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short | Value of extension
Control | 1..1
Type | string
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Fixed Value | `offerings`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
305. HealthcareService.characteristic:offering.coding
Definition | A reference to a code defined by a terminology system.
Short | -
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.
Control | 0..*
Type | Coding
Is Modifier | false
Summary | true
Requirements | Allows for alternative encodings within a code system, and translations to other code systems.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
307. HealthcareService.characteristic:offering.text
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
Short | Plain text representation of the concept
Comments | Very often the text is the same as a displayName of one of the codings.
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
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.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
309. 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.
Short | The language that this service is offered in
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.
Control | 0..*
Binding | The codes SHALL be taken from Common Languages in Australia (required to `https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2` )
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | false
311. HealthcareService.referralMethod
Definition | Ways that the service accepts referrals, if this is not provided then it is implied that no referral is required.
Short | Ways that the service accepts referrals
Control | 0..0
Binding | For example codes, see ReferralMethod (example to `http://hl7.org/fhir/ValueSet/service-referral-method` ) The methods of referral can be used when referring to a specific HealthCareService resource.
Type | CodeableConcept
Is Modifier | false
Summary | false
313. 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.
Short | It indicates if an appointment is required for this Healthcare Service
Control | 0..1
Type | boolean
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
315. HealthcareService.availableTime
Definition | A collection of times that the Service Site is available.
Short | Times the Healthcare Service is available
Comments | More detailed availability information may be provided in associated Schedule/Slot resources.
Control | 0..*
Type | BackboneElement
Is Modifier | false
Summary | false
Label | Operational Time
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
317. 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.
Short | Unique id for inter-element referencing
Control | 0..0
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
319. HealthcareService.availableTime.extension
Definition | An Extension
Short | Extension
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Slicing | This element introduces a set of slices on `HealthcareService.availableTime.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
321. HealthcareService.availableTime.extension:nhsd-timezone
Slice Name | nhsd-timezone
Definition | Australian time zone.
Short | Information about time zone for a Healthcare Service. NHSD supports ONLY ONE time zone per service
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(nhsd-timezone) (Extension Type: CodeableConcept)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
323. HealthcareService.availableTime.modifierExtension
Definition | An Extension
Short | Extension
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Slicing | This element introduces a set of slices on `HealthcareService.availableTime.modifierExtension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
325. HealthcareService.availableTime.modifierExtension:nhsd-availability-specificDate
Slice Name | nhsd-availability-specificDate
Definition | Defines the specific date at which a service is available or not available.
Short | The specific date at which a service is available or not available
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(nhsd-availability-specificDate) (Extension Type: string)
Is Modifier | false because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
327. HealthcareService.availableTime.modifierExtension:nhsd-availability-reason
Slice Name | nhsd-availability-reason
Definition | Defines the reason for the availability or unavailability of a Healthcare Service.
Short | Australian Public Holidays
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(nhsd-availability-reason) (Extension Type: CodeableConcept)
Is Modifier | false because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
329. HealthcareService.availableTime.daysOfWeek
Definition | Indicates which days of the week are available between the start and end Times.
Short | mon | tue | wed | thu | fri | sat | sun
Control | 0..*
Binding | The codes SHALL be taken from DaysOfWeek (required to `http://hl7.org/fhir/ValueSet/days-of-week|4.0.0` ) The days of the week.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
331. HealthcareService.availableTime.allDay
Definition | Is this always available? (hence times are irrelevant) e.g. 24 hour service.
Short | Always available? e.g. 24 hour service
Control | 0..1
Type | boolean
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
333. HealthcareService.availableTime.availableStartTime
Definition | The opening time of day. Note: If the AllDay flag is set, then this time is ignored.
Short | Opening time of day (ignored if allDay = true)
Comments | The time zone is expected to be for where this HealthcareService is provided at.
Control | 0..1
Type | time
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
335. HealthcareService.availableTime.availableStartTime.id
Definition | unique id for the element within a resource (for internal references)
Short | xml:id (or equivalent in JSON)
Control | 0..0
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
337. HealthcareService.availableTime.availableStartTime.extension
Definition | An Extension
Short | Extension
Control | 0..0
Type | Extension
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
339. HealthcareService.availableTime.availableStartTime.value
Definition | The actual value
Short | Primitive value for time
Control | 0..0
Type | time
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
341. HealthcareService.availableTime.availableEndTime
Definition | The closing time of day. Note: If the AllDay flag is set, then this time is ignored.
Short | Closing time of day (ignored if allDay = true)
Comments | The time zone is expected to be for where this HealthcareService is provided at.
Control | 0..1
Type | time
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
343. HealthcareService.availableTime.availableEndTime.id
Definition | unique id for the element within a resource (for internal references)
Short | xml:id (or equivalent in JSON)
Control | 0..0
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
345. HealthcareService.availableTime.availableEndTime.extension
Definition | An Extension
Short | Extension
Control | 0..0
Type | Extension
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
347. HealthcareService.availableTime.availableEndTime.value
Definition | The actual value
Short | Primitive value for time
Control | 0..0
Type | time
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
349. HealthcareService.notAvailable
Definition | The HealthcareService is not available during this period of time due to the provided reason.
Short | Not available during this time due to provided reason
Control | 0..*
Type | BackboneElement
Is Modifier | false
Summary | false
Label | Non-Operational Time
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
351. 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.
Short | Unique id for inter-element referencing
Control | 0..0
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
353. HealthcareService.notAvailable.extension
Definition | An Extension
Short | Extension
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Slicing | This element introduces a set of slices on `HealthcareService.notAvailable.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
355. HealthcareService.notAvailable.extension:nhsd-availability-specificDate
Slice Name | nhsd-availability-specificDate
Definition | Defines the specific date at which a service is available or not available.
Short | The specific date at which a service is available or not available
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(nhsd-availability-specificDate) (Extension Type: string)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
357. HealthcareService.notAvailable.extension:nhsd-availability-reason
Slice Name | nhsd-availability-reason
Definition | Defines the reason for the availability or unavailability of a Healthcare Service.
Short | Australian Public Holidays
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(nhsd-availability-reason) (Extension Type: CodeableConcept)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
359. HealthcareService.notAvailable.extension:nhsd-timezone
Slice Name | nhsd-timezone
Definition | Australian time zone.
Short | Information about time zone for a Healthcare Service. NHSD supports ONLY ONE time zone per service
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(nhsd-timezone) (Extension Type: CodeableConcept)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
361. 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).
Short | Extensions that cannot be ignored even if unrecognized
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.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
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 Names | extensions, user content, modifiers
363. HealthcareService.notAvailable.description
Definition | The reason that can be presented to the user as to why this time is not available.
Short | Reason presented to the user explaining why time not available
Control | 1..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
365. HealthcareService.notAvailable.during
Definition | Service is not available (seasonally or for a public holiday) from this date.
Short | Service not available from this date
Control | 0..1
Type | Period
Is Modifier | false
Summary | false
367. 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.
Short | Not supported, refer to availableTime and notAvailable
Control | 0..0
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
369. HealthcareService.endpoint
Definition | Technical endpoints providing access to services operated for the specific healthcare services defined at this resource.
Short | NHSD supports Healthcare Service to refer to maximum of one Endpoint resource (with corresponding SMD Target identifier) per secure messaging vendor product
Control | 0..*
Type | Reference(NHSD Secure Messaging Endpoint)
Is Modifier | false
Must Support | true
Summary | false