Generated Narrative: StructureDefinition nhsd-healthcareservice Last updated: 2023-11-21 22:13:33+1100 Name Flags Card. Type Description & Constraints HealthcareService 0..* AUPDHealthcareService A healthcare service in an Australian healthcare context e.g., a healthcare service provided at a site #xD; id 1..1 id Logical FHIR id for unique identification of the Healthcare Service resource within the FHIR bundle #xD; meta 1..1 Meta Metadata about Healthcare Service resource #xD; id 0..0 #xD; Slices for extension 0..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:proximityDistance 0..1 decimal The distance in meters/kilometers of the service URL: http://fhir.nhsd.com.au/StructureDefinition/proximity-distance #xD; extension:operationalStatus 0..1 (Complex) Operational status of the service URL: http://fhir.nhsd.com.au/StructureDefinition/operationalStatus #xD; versionId 0..0 #xD; lastUpdated 1..1 instant The timestamp when the resource was last updated #xD; source 0..0 #xD; profile 0..0 #xD; security 0..0 #xD; tag 0..0 #xD; implicitRules 0..0 #xD; language 0..0 #xD; text 0..0 #xD; Slices for extension 0..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:bookingProvider 0..* (Complex) Information about Booking Providers for a Healthcare Service URL: http://fhir.nhsd.com.au/StructureDefinition/nhsd-booking-provider #xD; modifierExtension 0..0 #xD; identifier 0..* Identifier Healthcare service identifiers #xD; Slices for identifier Content/Rules for all slices #xD; identifier:hpio 0..0 #xD; identifier:pdvendor 0..0 #xD; identifier:rid S 0..1 NHSDResourceIdentifier Healthcare service identifiers #xD; active 1..1 boolean Reflects the current status of the Healthcare Service resource #xD; providedBy 1..1 Reference(NHSD Organisation) Reference to the Organization resource that provides the service #xD; category 0..0 #xD; type 1..* CodeableConcept Type of service that may be delivered or performed. Each HealthcareService resource must have only 1 preferred service type Binding: Healthcare Service Types SNOMED-CT (preferred) #xD; id 0..0 #xD; coding 1..* Coding Code defined by a terminology system #xD; Slices for specialty Content/Rules for all slices #xD; specialty:snomedRole 0..0 #xD; location 1..1 Reference(NHSD Location) Reference to the Location resource. #xD; name 0..1 string Healthcare Service name, which may include department level information for Hospitals. #xD; comment 0..1 string A short description of the Healthcare Service, which may include additional information not covered elsewhere. #xD; extraDetails 0..0 #xD; photo 0..0 #xD; telecom 0..* ContactPoint Contact information related to the Healthcare Service #xD; id 0..0 #xD; Slices for extension Content/Rules for all slices #xD; extension:contactPurpose S 0..* CodeableConcept The contact purpose for the resource URL: http://fhir.nhsd.com.au/StructureDefinition/au-contact-purpose Binding: Contact Purpose (required) #xD; system 1..1 code phone | fax | email | url Binding: Contact Point System (required): Telecommunications form for contact point. #xD; value 1..1 string The actual contact point details #xD; use 0..0 #xD; rank 0..0 #xD; period 0..0 #xD; coverageArea 0..* Reference(Location) Reference to the list of 'contained' Location resources defining the coverage area of virtual/home visit type of Healthcare Services. #xD; serviceProvisionCode 0..1 CodeableConcept Reflects the billing option type the Healthcare Service supports Binding: Healthcare Service Provision Conditions (required) #xD; eligibility 0..* BackboneElement Specific eligibility requirements required to use the service #xD; code 1..1 CodeableConcept Coded value for the eligibility Binding: Healthcare Service Eligibility criteria (required): Eligibility for service provided by Healthcare provider #xD; program 0..* CodeableConcept Name of program(s) that the Healthcare Service is a part of Binding: Healthcare Service Programs (Funded or Unfunded) (extensible): Name of program(s) that the Healthcare Service is a part of #xD; Slices for characteristic 0..* CodeableConcept Various characteristics of the Healthcare Service like offering etc Slice: Unordered, Open by value:coding.system #xD; characteristic:facility 0..* CodeableConcept Facilities available or provided at a Healthcare Service location Binding: Healthcare Service Facilities (required): Facilities available or provided at a Healthcare Service location #xD; Slices for extension 0..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:facilities-characteristic-group 1..1 (Complex) - URL: http://fhir.nhsd.com.au/StructureDefinition/characteristic-group #xD; Slices for valueString Content/Rules for all slices #xD; valueString:valueString 1..1 string Value of extension Fixed Value: facilities #xD; coding 0..* Coding - #xD; characteristic:fundingsource 0..* CodeableConcept Funding Sources which support this Healthcare Service. Binding: Healthcare Service Funding Sources (required): Funding Sources which support this Healthcare Service. #xD; Slices for extension 0..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:fundingsource-characteristic-group 1..1 (Complex) - URL: http://fhir.nhsd.com.au/StructureDefinition/characteristic-group #xD; Slices for valueString Content/Rules for all slices #xD; valueString:valueString 1..1 string Value of extension Fixed Value: fundingSource #xD; coding 0..* Coding - #xD; characteristic:healthcareServiceCharacteristic 0..* CodeableConcept Miscellaneous characteristics of a Healthcare Service Binding: Healthcare Service miscellaneous characteristics (required): Miscellaneous characteristics of a Healthcare Service #xD; Slices for extension 0..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:plsc-characteristic-group 1..1 (Complex) - URL: http://fhir.nhsd.com.au/StructureDefinition/characteristic-group #xD; Slices for valueString Content/Rules for all slices #xD; valueString:valueString 1..1 string Value of extension Fixed Value: characteristics #xD; coding 0..* Coding - #xD; characteristic:referralInformation 0..* CodeableConcept Referral Instructions and Information Binding: Healthcare Service referral instructions and information (required): Referral Instructions and Information #xD; Slices for extension 0..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:referral-characteristic-group 1..1 (Complex) - URL: http://fhir.nhsd.com.au/StructureDefinition/characteristic-group #xD; Slices for valueString Content/Rules for all slices #xD; valueString:valueString 1..1 string Value of extension Fixed Value: referralInformation #xD; extension:referralInstruction 0..1 string Referral Instructions and Information URL: http://fhir.nhsd.com.au/StructureDefinition/characteristic-extendedValues #xD; coding 0..* Coding - #xD; characteristic:offering 0..* CodeableConcept This contains the list of various offerings that the Healthcare Service has Binding: Healthcare Service Offerings (required): Supporting services offered at a Healthcare Service #xD; Slices for extension 0..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:offering-characteristic-group 1..1 (Complex) - URL: http://fhir.nhsd.com.au/StructureDefinition/characteristic-group #xD; Slices for valueString Content/Rules for all slices #xD; valueString:valueString 1..1 string Value of extension Fixed Value: offerings #xD; coding 0..* Coding - #xD; communication S 0..* CodeableConcept The language that this service is offered in Binding: Common Languages in Australia (required) #xD; referralMethod 0..0 #xD; appointmentRequired 0..1 boolean It indicates if an appointment is required for this Healthcare Service #xD; availableTime 0..* BackboneElement Times the Healthcare Service is available #xD; id 0..0 #xD; Slices for extension 0..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:nhsd-timezone 0..1 CodeableConcept Information about time zone for a Healthcare Service. NHSD supports ONLY ONE time zone per service URL: http://fhir.nhsd.com.au/StructureDefinition/nhsd-timezone Binding: Australian States and Territories timezones (required) #xD; Slices for modifierExtension Content/Rules for all slices #xD; modifierExtension:nhsd-availability-specificDate 0..1 string The specific date at which a service is available or not available URL: http://fhir.nhsd.com.au/StructureDefinition/nhsd-availability-specificDate #xD; modifierExtension:nhsd-availability-reason 0..1 CodeableConcept Australian Public Holidays URL: http://fhir.nhsd.com.au/StructureDefinition/nhsd-availability-reason Binding: Australian Public Holidays 2025 (required) #xD; availableStartTime #xD; id 0..0 #xD; extension 0..0 #xD; value 0..0 #xD; availableEndTime #xD; id 0..0 #xD; extension 0..0 #xD; value 0..0 #xD; notAvailable 0..* BackboneElement Not available during this time due to provided reason #xD; id 0..0 #xD; Slices for extension Content/Rules for all slices #xD; extension:nhsd-availability-specificDate 0..1 string The specific date at which a service is available or not available URL: http://fhir.nhsd.com.au/StructureDefinition/nhsd-availability-specificDate #xD; extension:nhsd-availability-reason 0..1 CodeableConcept Australian Public Holidays URL: http://fhir.nhsd.com.au/StructureDefinition/nhsd-availability-reason Binding: Australian Public Holidays 2025 (required) #xD; extension:nhsd-timezone 0..1 CodeableConcept Information about time zone for a Healthcare Service. NHSD supports ONLY ONE time zone per service URL: http://fhir.nhsd.com.au/StructureDefinition/nhsd-timezone Binding: Australian States and Territories timezones (required) #xD; availabilityExceptions 0..0 #xD; endpoint 0..* Reference(NHSD Secure Messaging Endpoint) NHSD supports Healthcare Service to refer to maximum of one Endpoint resource (with corresponding SMD Target identifier) per secure messaging vendor product #xD; Documentation for this format
A National Health Services Directory (NHSD) Service
An extended resource providing additional information on the HealthcareService not offered by the AU-BASE.
Copyright © 2022 Healthdirect Australia - All rights reserved. This content is licensed under a Creative Commons Attribution 4.0 International License. See https://creativecommons.org/licenses/by/4.0/.
A healthcare service in an Australian healthcare context e.g., a healthcare service provided at a site
The details of a healthcare service for directory use.
If the resource is contained in another resource, it SHALL NOT contain nested Resources
not(parent::f:contained and f:contained)
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()
not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))
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()
not(exists(for $contained in f:contained return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))
When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time.
A resource should have narrative for robust management
If a resource is contained in another resource, it SHALL NOT have a security label
Logical FHIR id for unique identification of the Healthcare Service resource within the FHIR bundle
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
Metadata about Healthcare Service resource
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.
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Extensions are always sliced by (at least) url
The distance in meters/kilometers of the service
Defines the operational status of a service which could be OPEN, CLOSED OR UNKNOWN.
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.
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.
The timestamp when the resource was last updated
When the resource last changed - e.g. when the version changed.
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](http://hl7.org.au/fhir/base/2019Aug/http.html#read) interaction.
Identifies where the resource comes from
A uri that identifies the source system of the resource. This provides a minimal amount of [Provenance](http://hl7.org.au/fhir/base/2019Aug/provenance.html#) 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.
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.
Profiles this resource claims to conform to
A list of profiles (references to [StructureDefinition](http://hl7.org.au/fhir/base/2019Aug/structuredefinition.html#) resources) that this resource claims to conform to. The URL is a reference to [StructureDefinition.url](http://hl7.org.au/fhir/base/2019Aug/structuredefinition-definitions.html#StructureDefinition.url).
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.
Security Labels applied to this resource
Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.
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.
Security Labels from the Healthcare Privacy and Security Classification System.
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.
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.
Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
A set of rules under which this content was created
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.
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.
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
The base language in which the resource is written.
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).
Text summary of the resource, for human interpretation
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.
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.
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.
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.
Information about Booking Providers for a Healthcare Service
Lists booking providers which offer web accessible link in order to book with this service.
Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
National identifier Health Provider Identifier for Organisations for Healthcare Service
HPI-O shall be an exactly 16 digit number
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)
Additional content defined by implementations
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.
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.
Source of the definition for the extension code - a logical name or a URL.
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.
Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R4/extensibility.html) for a list).
Identifier values follwing the universal-id-type defined scheme.
Provides scheme to use to interpret the universal-id value .e.g. GUID, ISO etc. see HL7 V2 Table 0301 - Universal ID type.
usual | official | temp | secondary | old (If known)
Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Identifies the purpose for this identifier, if known .
Element describing the type of identifier
This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
Allows users to make use of identifiers when the identifier system is not known.
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.
Allows for alternative encodings within a code system, and translations to other code systems.
fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
Descriptive text for the identifier type
Very often the text is the same as a displayName of one of the codings.
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.
C*E.9. But note many systems use C*E.2 for this
fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
This namespace is used for qualified identifiers to represent Healthcare Provider Identifier for Organisations (HPI-O) numbers. An example of the syntax of a HPI-O represented as a qualified identifer using this namespace is: http://ns.electronichealth.net.au/id/hi/hpio/1.0/8003620000000000
Identifier.system is always case sensitive.
There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Identifier for the organization that is used to identify the organization across multiple disparate systems.
If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [Rendered Value extension](http://hl7.org/fhir/R4/extension-rendered-value.html). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
Time period when id is/was valid for use
Time period during which identifier is/was valid for use.
Role.effectiveTime or implied by context
Organization that issued id (may be just text)
Organization that issued/manages the identifier.
The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
Secure Messaging Vendor's Healthcare Service Identifier
Vendor allocated directory identifier this can be used for search for specific healtchare service directory entry and/or for routing of messages.
Optional Extension Element - found in all resources.
Type code for vendor directory identifier
The identification of the code system that defines the meaning of the symbol in the code.
The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
Need to be unambiguous about the source of the definition of the symbol.
fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Need to refer to a particular code in the system.
fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
A representation of the meaning of the code in the system, following the rules of the system.
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
C*E.2 - but note this is not well followed
fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
If this coding was chosen directly by the user
Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
Vendor Directory Identifier type descripition
Unique namespace for the assigning vendor's identifier value.
If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [Rendered Value extension](http://hl7.org.au/fhir/base/2019Aug/extension-rendered-value.html). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Literal reference, Relative, internal or absolute URL
A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
Type the reference refers to (e.g. "Patient")
The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.
Aa resource (or, for logical models, the URI of the logical model).
Logical reference, when literal reference is not known
An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
Secure messaging vendor organisation name
Plain text narrative that identifies the resource in addition to the resource reference.
This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
NHSD HealthcareService Resource Identifier
Reflects the current status of the Healthcare Service resource
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.
This element is labeled as a modifier because it may be used to mark that the resource was created in error.
This resource is generally assumed to be active if no value is provided for the active element
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
Reference to the Organization resource that provides the service
The organization that provides this healthcare service.
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.
Identifies the broad category of service being performed or delivered.
Selecting a Service Category then determines the list of relevant service types that can be selected in the primary service type.
A category of the service(s) that could be provided.
Type of service that may be delivered or performed. Each HealthcareService resource must have only 1 preferred service type
The specific type of service that may be delivered or performed.
All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Must have either extensions or value[x], not both
exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
A reference to a code defined by a terminology system.
Plain text representation of the concept
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.
Collection of specialties handled by the service site. This is more of a medical term.
A specialty role that a healthcare service may provide.
The location(s) where this healthcare service may be provided.
Healthcare Service name, which may include department level information for Hospitals.
Further description of the service as it would be presented to a consumer while searching.
A short description of the Healthcare Service, which may include additional information not covered elsewhere.
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.
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.
Extra details about the service that can't be placed in the other fields
Extra details about the service that can't be placed in the other fields.
Facilitates quick identification of the service
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.
Contact information related to the Healthcare Service
List of contacts related to this specific healthcare service.
If this is empty, then refer to the location's contacts.
Defines the contact purpose for the resource. T
Telecommunications form for contact point - what communications system is required to make use of the contact.
Telecommunications form for contact point.
The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).
Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.
Need to support legacy numbers that are not in a tightly controlled format.
home | work | temp | old | mobile - purpose of this contact point
Identifies the purpose for the contact point.
Applications can assume that a contact is current unless it explicitly says that it is temporary or old.
Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.
This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one
Specify preferred order of use (1 = highest)
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.
Note that rank does not necessarily follow the order in which the contacts are represented in the instance.
Time period when the contact point was/is in use
Time period when the contact point was/is in use.
Reference to the list of 'contained' Location resources defining the coverage area of virtual/home visit type of Healthcare Services.
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 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".
Reflects the billing option type the Healthcare Service supports
The code(s) that detail the conditions under which the healthcare service is available/offered.
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.
Specific eligibility requirements required to use the service
Does this service have specific eligibility requirements that need to be met in order to use the service?
Extensions that cannot be ignored even if unrecognized
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).
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](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).
Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Eligibility for service provided by Healthcare provider
Describes the eligibility conditions for the service
Describes the eligibility conditions for the service.
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.
Name of program(s) that the Healthcare Service is a part of
Programs that this service is applicable to.
Programs are often defined externally to an Organization, commonly by governments; e.g. Home and Community Care Programs, Homeless Program, ….
Various characteristics of the Healthcare Service like offering etc
Collection of characteristics (attributes), bound to known CodeSystems for various groups of characteristics.
These could be such things as is wheelchair accessible.
A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy).
Facilities available or provided at a Healthcare Service location
Collection of characteristics (attributes).
Funding Sources which support this Healthcare Service.
Miscellaneous characteristics of a Healthcare Service
This contains the list of various offerings that the Healthcare Service has
Supporting services offered at a Healthcare Service
The language that this service is offered in
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.
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.
Ways that the service accepts referrals, if this is not provided then it is implied that no referral is required.
The methods of referral can be used when referring to a specific HealthCareService resource.
It indicates if an appointment is required for this Healthcare Service
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.
Times the Healthcare Service is available
A collection of times that the Service Site is available.
More detailed availability information may be provided in associated Schedule/Slot resources.
Information about time zone for a Healthcare Service. NHSD supports ONLY ONE time zone per service
exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
The specific date at which a service is available or not available
Defines the specific date at which a service is available or not available.
Defines the reason for the availability or unavailability of a Healthcare Service.
Indicates which days of the week are available between the start and end Times.
Is this always available? (hence times are irrelevant) e.g. 24 hour service.
Opening time of day (ignored if allDay = true)
The opening time of day. Note: If the AllDay flag is set, then this time is ignored.
The time zone is expected to be for where this HealthcareService is provided at.
unique id for the element within a resource (for internal references)
Closing time of day (ignored if allDay = true)
The closing time of day. Note: If the AllDay flag is set, then this time is ignored.
Not available during this time due to provided reason
The HealthcareService is not available during this period of time due to the provided reason.
Reason presented to the user explaining why time not available
The reason that can be presented to the user as to why this time is not available.
Service is not available (seasonally or for a public holiday) from this date.
Not supported, refer to availableTime and notAvailable
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.
NHSD supports Healthcare Service to refer to maximum of one Endpoint resource (with corresponding SMD Target identifier) per secure messaging vendor product
Technical endpoints providing access to services operated for the specific healthcare services defined at this resource.