Magentus Practice Management FHIR® Implementation Guide
1.3.2 - Release
Australia
Magentus Practice Management FHIR® Implementation Guide
1.3.2 - Release
Australia
Magentus Practice Management FHIR® Implementation Guide - Downloaded Version 1.3.2 See the Directory of published versions
| Active as of 2026-10-02 |
Definitions for the gs-healthcareservice resource profile
Guidance on how to interpret the contents of this table can be foundhere
| 0. HealthcareService | ||||||||||
| Definition | The details of a healthcare service available at a location. | |||||||||
| Short | A healthcare service in an Australian healthcare contextThe details of a healthcare service available at a location | |||||||||
| 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-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()) dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()) dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (text.`div`.exists()) | |||||||||
| 2. HealthcareService.id | ||||||||||
| Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | |||||||||
| Short | Logical 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 | 0..1 | |||||||||
| Type | idstring | |||||||||
| Is Modifier | false | |||||||||
| Must Support | true | |||||||||
| Summary | true | |||||||||
| 4. 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..1 | |||||||||
| 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())) | |||||||||
| 6. HealthcareService.modifierExtension | ||||||||||
| Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | |||||||||
| Short | Extensions 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..* | |||||||||
| 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()) | |||||||||
| 8. HealthcareService.identifier | ||||||||||
| Definition | Identifier for the organization that is used to identify the healthcare service across multiple disparate systems. External identifiers for this item. | |||||||||
| Short | External identifiers for this item | |||||||||
| Note | This is a business identifier, not a resource identifier (see discussion) | |||||||||
| Control | 0..* | |||||||||
| Type | Identifier(Identifier, AU HPI-O, AU Residential Aged Care Service Identifier) | |||||||||
| Is Modifier | false | |||||||||
| Must Support | true | |||||||||
| Must Support Types | No must-support rules about the choice of types/profiles | |||||||||
| Obligations |
| |||||||||
| 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 Closed, and can be differentiated using the following discriminators: | |||||||||
| 10. HealthcareService.identifier:hospitalcode | ||||||||||
| Slice Name | hospitalcode | |||||||||
| Definition | Identifier for the organization that is used to identify the healthcare service across multiple disparate systems. External identifiers for this item. | |||||||||
| Short | External identifiers for this item | |||||||||
| Note | This is a business identifier, not a resource identifier (see discussion) | |||||||||
| Control | 0..1* | |||||||||
| Type | Identifier(Australian Hospital Provider Number) | |||||||||
| Is Modifier | false | |||||||||
| Must Support | true | |||||||||
| Obligations |
| |||||||||
| Summary | true | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 12. HealthcareService.identifier:hospitalcode.use | ||||||||||
| Definition | The purpose of this identifier. | |||||||||
| Short | usual | official | temp | secondary | old (If known) | |||||||||
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. | |||||||||
| Control | 0..1 | |||||||||
| Binding | The codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)Identifies the purpose for this identifier, if known . | |||||||||
| Type | code | |||||||||
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. | |||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||
| Summary | true | |||||||||
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 14. HealthcareService.identifier:hospitalcode.type | ||||||||||
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. | |||||||||
| Short | Description of identifier | |||||||||
| Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. | |||||||||
| Control | 0..1 | |||||||||
| Binding | Unless not suitable, these codes SHALL be taken from Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type|4.0.1 (extensible to http://hl7.org/fhir/ValueSet/identifier-type|4.0.1)A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | |||||||||
| Type | CodeableConcept | |||||||||
| Is Modifier | false | |||||||||
| Summary | true | |||||||||
| Requirements | Allows users to make use of identifiers when the identifier system is not known. | |||||||||
| Pattern Value | { | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 16. HealthcareService.identifier:hospitalcode.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..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())) | |||||||||
| 18. HealthcareService.identifier:hospitalcode.value | ||||||||||
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | |||||||||
| Short | Hospital Provider NumberThe value that is unique | |||||||||
| Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. | |||||||||
| 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 | |||||||||
| Example | General: 123456 | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 20. 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 | Whether 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())) | |||||||||
| 22. HealthcareService.providedBy | ||||||||||
| Definition | The organization that provides this healthcare service. | |||||||||
| Short | Providing organizationOrganization 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(Genie Organization, 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())) | |||||||||
| 24. HealthcareService.providedBy.display | ||||||||||
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. | |||||||||
| Short | Providing organization nameText alternative for the resource | |||||||||
| Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. | |||||||||
| 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 | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 26. HealthcareService.type | ||||||||||
| Definition | The specific type of service that may be delivered or performed. | |||||||||
| Short | Type of service that may be delivered or performed | |||||||||
| Control | 0..* | |||||||||
| Binding | Unless not suitable, these codes SHALL be taken from For example codes, see Service Type  http://hl7.org/fhir/ValueSet/service-type|4.0.1(extensible to https://healthterminologies.gov.au/fhir/ValueSet/service-type-1) | |||||||||
| Type | CodeableConcept | |||||||||
| Is Modifier | false | |||||||||
| Must Support | true | |||||||||
| Obligations |
| |||||||||
| Summary | true | |||||||||
| Alternate Names | service type | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 28. HealthcareService.location | ||||||||||
| Definition | The location(s) where this healthcare service may be provided. | |||||||||
| Short | Location(s) where service may be provided | |||||||||
| Control | 10..1* | |||||||||
| Type | Reference(Genie Location, Location) | |||||||||
| Is Modifier | false | |||||||||
| Summary | true | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 30. HealthcareService.location.display | ||||||||||
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. | |||||||||
| Short | Location nameText alternative for the resource | |||||||||
| Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. | |||||||||
| 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 | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 32. HealthcareService.name | ||||||||||
| Definition | Further description of the service as it would be presented to a consumer while searching. | |||||||||
| Short | Health service nameDescription of service as presented to a consumer while searching | |||||||||
| Control | 10..1 | |||||||||
| Type | string | |||||||||
| Is Modifier | false | |||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||
| Must Support | true | |||||||||
| Obligations |
| |||||||||
| Summary | true | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 34. HealthcareService.telecom | ||||||||||
| Definition | List of contacts related to this specific healthcare service. | |||||||||
| Short | Contacts 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 | |||||||||
| Obligations |
| |||||||||
| 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 | |
| 2. HealthcareService.id | |
| Must Support | true |
| 4. HealthcareService.identifier | |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Slicing | This element introduces a set of slices on HealthcareService.identifier. The slices areUnordered and Closed, and can be differentiated using the following discriminators: |
| 6. HealthcareService.identifier:hospitalcode | |
| Slice Name | hospitalcode |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..1 |
| Type | Identifier(Australian Hospital Provider Number) |
| Must Support | true |
| 8. HealthcareService.identifier:hospitalcode.type | |
| 10. HealthcareService.identifier:hospitalcode.type.coding | |
| Control | 1..1 |
| 12. HealthcareService.active | |
| Control | 1..? |
| Must Support | true |
| 14. HealthcareService.providedBy | |
| Short | Providing organization |
| Control | 1..? |
| Type | Reference(Genie Organization) |
| Must Support | true |
| 16. HealthcareService.providedBy.display | |
| Short | Providing organization name |
| Control | 1..? |
| 18. HealthcareService.location | |
| Control | 1..1 |
| Type | Reference(Genie Location) |
| 20. HealthcareService.location.display | |
| Short | Location name |
| Control | 1..? |
| 22. HealthcareService.name | |
| Short | Health service name |
Guidance on how to interpret the contents of this table can be foundhere
| 0. HealthcareService | ||||||||||
| Definition | The details of a healthcare service available at a location. | |||||||||
| Short | A healthcare service in an Australian healthcare context | |||||||||
| 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-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource ( contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated ( contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())dom-5: If a resource is contained in another resource, it SHALL NOT have a security label ( contained.meta.security.empty())dom-6: A resource should have narrative for robust management ( text.`div`.exists()) | |||||||||
| 2. HealthcareService.id | ||||||||||
| Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | |||||||||
| Short | Logical 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 | 0..1 | |||||||||
| Type | id | |||||||||
| Is Modifier | false | |||||||||
| Must Support | true | |||||||||
| 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 the resource | |||||||||
| Control | 0..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.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..1 | |||||||||
| 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())) | |||||||||
| 8. 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..1 | |||||||||
| Binding | The codes SHOULD be taken from CommonLanguages (preferred to http://hl7.org/fhir/ValueSet/languages|4.0.1)A human language.
| |||||||||
| 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())) | |||||||||
| 10. 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..1 | |||||||||
| 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())) | |||||||||
| 12. 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 | |||||||||
| 14. HealthcareService.extension | ||||||||||
| Definition | 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 | 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()) | |||||||||
| 16. HealthcareService.modifierExtension | ||||||||||
| Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | |||||||||
| Short | Extensions 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..* | |||||||||
| 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()) | |||||||||
| 18. HealthcareService.identifier | ||||||||||
| Definition | Identifier for the organization that is used to identify the healthcare service across multiple disparate systems. | |||||||||
| Short | External identifiers for this item | |||||||||
| Note | This is a business identifier, not a resource identifier (see discussion) | |||||||||
| Control | 0..* | |||||||||
| Type | Identifier(Identifier, AU HPI-O, AU Residential Aged Care Service Identifier) | |||||||||
| Is Modifier | false | |||||||||
| Must Support | true | |||||||||
| Must Support Types | No must-support rules about the choice of types/profiles | |||||||||
| Obligations |
| |||||||||
| 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 Closed, and can be differentiated using the following discriminators: | |||||||||
| 20. HealthcareService.identifier:hospitalcode | ||||||||||
| Slice Name | hospitalcode | |||||||||
| Definition | Identifier for the organization that is used to identify the healthcare service across multiple disparate systems. | |||||||||
| Short | External identifiers for this item | |||||||||
| Note | This is a business identifier, not a resource identifier (see discussion) | |||||||||
| Control | 0..1 | |||||||||
| Type | Identifier(Australian Hospital Provider Number) | |||||||||
| Is Modifier | false | |||||||||
| Must Support | true | |||||||||
| Obligations |
| |||||||||
| Summary | true | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 22. HealthcareService.identifier:hospitalcode.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 | |||||||||
| 24. HealthcareService.identifier:hospitalcode.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.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | |||||||||
| 26. HealthcareService.identifier:hospitalcode.use | ||||||||||
| Definition | The purpose of this identifier. | |||||||||
| Short | usual | official | temp | secondary | old (If known) | |||||||||
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. | |||||||||
| Control | 0..1 | |||||||||
| Binding | The codes SHALL be taken from IdentifierUse (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)Identifies the purpose for this identifier, if known . | |||||||||
| Type | code | |||||||||
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. | |||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||
| Summary | true | |||||||||
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 28. HealthcareService.identifier:hospitalcode.type | ||||||||||
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. | |||||||||
| Short | Description of identifier | |||||||||
| Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. | |||||||||
| Control | 0..1 | |||||||||
| Binding | Unless not suitable, these codes SHALL be taken from Identifier Type Codes (extensible to http://hl7.org/fhir/ValueSet/identifier-type|4.0.1)A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | |||||||||
| Type | CodeableConcept | |||||||||
| Is Modifier | false | |||||||||
| Summary | true | |||||||||
| Requirements | Allows users to make use of identifiers when the identifier system is not known. | |||||||||
| Pattern Value | { | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 30. HealthcareService.identifier:hospitalcode.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..1 | |||||||||
| Type | string | |||||||||
| Is Modifier | false | |||||||||
| XML Format | In the XML format, this property is represented as an attribute. | |||||||||
| Summary | false | |||||||||
| 32. HealthcareService.identifier:hospitalcode.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.identifier.type.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | |||||||||
| 34. HealthcareService.identifier:hospitalcode.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..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())) | |||||||||
| 36. HealthcareService.identifier:hospitalcode.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())) | |||||||||
| 38. HealthcareService.identifier:hospitalcode.system | ||||||||||
| Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | |||||||||
| Short | The namespace for the identifier value | |||||||||
| Comments | Identifier.system is always case sensitive. | |||||||||
| Control | 0..1 | |||||||||
| Type | uri | |||||||||
| Is Modifier | false | |||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||
| Summary | true | |||||||||
| Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. | |||||||||
| Example | General: http://www.acme.com/identifiers/patient | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 40. HealthcareService.identifier:hospitalcode.value | ||||||||||
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | |||||||||
| Short | Hospital Provider Number | |||||||||
| Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. | |||||||||
| 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 | |||||||||
| Example | General: 123456 | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 42. HealthcareService.identifier:hospitalcode.period | ||||||||||
| Definition | Time period during which identifier is/was valid for use. | |||||||||
| Short | Time period when id is/was valid for use | |||||||||
| Control | 0..1 | |||||||||
| 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())) | |||||||||
| 44. HealthcareService.identifier:hospitalcode.assigner | ||||||||||
| Definition | Organization that issued/manages the identifier. | |||||||||
| Short | Organization that issued id (may be just text) | |||||||||
| Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. | |||||||||
| Control | 0..1 | |||||||||
| Type | Reference(Organization) | |||||||||
| Is Modifier | false | |||||||||
| Summary | true | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 46. 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 | Whether 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 | 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 | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 48. HealthcareService.providedBy | ||||||||||
| Definition | The organization that provides this healthcare service. | |||||||||
| Short | Providing organization | |||||||||
| 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(Genie 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())) | |||||||||
| 50. HealthcareService.providedBy.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 | |||||||||
| 52. HealthcareService.providedBy.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.providedBy.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | |||||||||
| 54. HealthcareService.providedBy.reference | ||||||||||
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. | |||||||||
| Short | Literal reference, Relative, internal or absolute URL | |||||||||
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. | |||||||||
| Control | 0..1 This element is affected by the following invariants: ref-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())) | |||||||||
| 56. HealthcareService.providedBy.type | ||||||||||
| Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). | |||||||||
| Short | Type the reference refers to (e.g. "Patient") | |||||||||
| Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. | |||||||||
| Control | 0..1 | |||||||||
| Binding | Unless not suitable, these codes SHALL be taken from ResourceType (extensible to http://hl7.org/fhir/ValueSet/resource-types|4.0.1)Aa resource (or, for logical models, the URI of the logical model). | |||||||||
| Type | uri | |||||||||
| 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())) | |||||||||
| 58. HealthcareService.providedBy.identifier | ||||||||||
| Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. | |||||||||
| Short | Logical reference, when literal reference is not known | |||||||||
| Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). | |||||||||
| Note | This is a business identifier, not a resource identifier (see discussion) | |||||||||
| Control | 0..1 | |||||||||
| Type | Identifier | |||||||||
| Is Modifier | false | |||||||||
| Summary | true | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 60. HealthcareService.providedBy.display | ||||||||||
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. | |||||||||
| Short | Providing organization name | |||||||||
| Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. | |||||||||
| 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 | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 62. HealthcareService.category | ||||||||||
| Definition | Identifies the broad category of service being performed or delivered. | |||||||||
| Short | Broad 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..* | |||||||||
| Binding | For example codes, see ServiceCategory (example to http://hl7.org/fhir/ValueSet/service-category|4.0.1)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())) | |||||||||
| 64. HealthcareService.type | ||||||||||
| Definition | The specific type of service that may be delivered or performed. | |||||||||
| Short | Type of service that may be delivered or performed | |||||||||
| Control | 0..* | |||||||||
| Binding | Unless not suitable, these codes SHALL be taken from Service Type (extensible to https://healthterminologies.gov.au/fhir/ValueSet/service-type-1) | |||||||||
| Type | CodeableConcept | |||||||||
| Is Modifier | false | |||||||||
| Must Support | true | |||||||||
| Obligations |
| |||||||||
| Summary | true | |||||||||
| Alternate Names | service type | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 66. HealthcareService.specialty | ||||||||||
| Definition | Collection of specialties handled by the service site. This is more of a medical term. | |||||||||
| Short | Specialties handled by the HealthcareService | |||||||||
| Control | 0..* | |||||||||
| Binding | The codes SHOULD be taken from Clinical Specialty (preferred to https://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1) | |||||||||
| Type | CodeableConcept | |||||||||
| Is Modifier | false | |||||||||
| Summary | true | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 68. HealthcareService.location | ||||||||||
| Definition | The location(s) where this healthcare service may be provided. | |||||||||
| Short | Location(s) where service may be provided | |||||||||
| Control | 1..1 | |||||||||
| Type | Reference(Genie Location) | |||||||||
| Is Modifier | false | |||||||||
| Summary | true | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 70. HealthcareService.location.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 | |||||||||
| 72. HealthcareService.location.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.location.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | |||||||||
| 74. HealthcareService.location.reference | ||||||||||
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. | |||||||||
| Short | Literal reference, Relative, internal or absolute URL | |||||||||
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. | |||||||||
| Control | 0..1 This element is affected by the following invariants: ref-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())) | |||||||||
| 76. HealthcareService.location.type | ||||||||||
| Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). | |||||||||
| Short | Type the reference refers to (e.g. "Patient") | |||||||||
| Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. | |||||||||
| Control | 0..1 | |||||||||
| Binding | Unless not suitable, these codes SHALL be taken from ResourceType (extensible to http://hl7.org/fhir/ValueSet/resource-types|4.0.1)Aa resource (or, for logical models, the URI of the logical model). | |||||||||
| Type | uri | |||||||||
| 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())) | |||||||||
| 78. HealthcareService.location.identifier | ||||||||||
| Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. | |||||||||
| Short | Logical reference, when literal reference is not known | |||||||||
| Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). | |||||||||
| Note | This is a business identifier, not a resource identifier (see discussion) | |||||||||
| Control | 0..1 | |||||||||
| Type | Identifier | |||||||||
| Is Modifier | false | |||||||||
| Summary | true | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 80. HealthcareService.location.display | ||||||||||
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. | |||||||||
| Short | Location name | |||||||||
| Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. | |||||||||
| 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 | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 82. HealthcareService.name | ||||||||||
| Definition | Further description of the service as it would be presented to a consumer while searching. | |||||||||
| Short | Health service name | |||||||||
| Control | 1..1 | |||||||||
| Type | string | |||||||||
| Is Modifier | false | |||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||
| Must Support | true | |||||||||
| Obligations |
| |||||||||
| Summary | true | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 84. 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 | 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())) | |||||||||
| 86. 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..1 | |||||||||
| 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())) | |||||||||
| 88. 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..1 | |||||||||
| 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())) | |||||||||
| 90. HealthcareService.telecom | ||||||||||
| Definition | List of contacts related to this specific healthcare service. | |||||||||
| Short | Contacts 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 | |||||||||
| Obligations |
| |||||||||
| Summary | false | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 92. HealthcareService.coverageArea | ||||||||||
| Definition | The location(s) that this service is available to (not where the service is provided). | |||||||||
| Short | 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())) | |||||||||
| 94. HealthcareService.serviceProvisionCode | ||||||||||
| Definition | The code(s) that detail the conditions under which the healthcare service is available/offered. | |||||||||
| Short | Conditions 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..* | |||||||||
| Binding | The codes SHOULD be taken from Service Provision Conditions Australian Concepts (preferred to http://terminology.hl7.org.au/ValueSet/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())) | |||||||||
| 96. 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())) | |||||||||
| 98. 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 | |||||||||
| XML Format | In the XML format, this property is represented as an attribute. | |||||||||
| Summary | false | |||||||||
| 100. 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 | |||||||||
| 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()) | |||||||||
| 102. 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()) | |||||||||
| 104. HealthcareService.eligibility.code | ||||||||||
| Definition | Coded value for the eligibility. | |||||||||
| Short | Coded value for the eligibility | |||||||||
| Control | 0..1 | |||||||||
| Binding | 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())) | |||||||||
| 106. 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 | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 108. HealthcareService.program | ||||||||||
| Definition | Programs that this service is applicable to. | |||||||||
| Short | Programs 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 | For example codes, see Program (example to http://hl7.org/fhir/ValueSet/program|4.0.1)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())) | |||||||||
| 110. HealthcareService.characteristic | ||||||||||
| Definition | Collection of characteristics (attributes). | |||||||||
| Short | Collection 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())) | |||||||||
| 112. 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 | Unless not suitable, these codes SHALL be taken from Common Languages in Australia (extensible to https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2) | |||||||||
| 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())) | |||||||||
| 114. 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..* | |||||||||
| Binding | For example codes, see ReferralMethod (example to http://hl7.org/fhir/ValueSet/service-referral-method|4.0.1)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())) | |||||||||
| 116. 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 | If 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())) | |||||||||
| 118. HealthcareService.availableTime | ||||||||||
| Definition | A collection of times that the Service Site is available. | |||||||||
| Short | Times 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 | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 120. 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..1 | |||||||||
| Type | string | |||||||||
| Is Modifier | false | |||||||||
| XML Format | In the XML format, this property is represented as an attribute. | |||||||||
| Summary | false | |||||||||
| 122. HealthcareService.availableTime.extension | ||||||||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | |||||||||
| 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()) | |||||||||
| 124. HealthcareService.availableTime.modifierExtension | ||||||||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | |||||||||
| 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()) | |||||||||
| 126. 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.1)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 | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 128. 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 | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 130. 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 | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 132. 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..1 | |||||||||
| Type | string | |||||||||
| Is Modifier | false | |||||||||
| XML Format | In the XML format, this property is represented as an attribute. | |||||||||
| Summary | false | |||||||||
| 134. HealthcareService.availableTime.availableStartTime.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.availableTime.availableStartTime.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | |||||||||
| 136. HealthcareService.availableTime.availableStartTime.extension:timeZone | ||||||||||
| Slice Name | timeZone | |||||||||
| Definition | An IANA timezone code for the timezone offset per BCP 175. For data types allowing the offset (all except date and time), this extension SHALL agree with the offset if provided and cannot be used in place of the offset if the precision expressed requires an offset. Where an offset is provided, this extension provides a more legible display of the zone associated with the offset. Where an offset is not present, this extension can be used to provide zone information not otherwise available. | |||||||||
| Short | IANA Timezone Code per BCP 175 | |||||||||
| Comments | Use Australian Time Zone Usage for Australian state and territory time zone offsets. | |||||||||
| Control | 0..1 | |||||||||
| Type | Extension(Timezone Code) (Extension Type: code) | |||||||||
| 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()) | |||||||||
| 138. HealthcareService.availableTime.availableStartTime.value | ||||||||||
| Definition | The actual value | |||||||||
| Short | Primitive value for time | |||||||||
| Control | 0..1 | |||||||||
| Type | time | |||||||||
| Is Modifier | false | |||||||||
| XML Format | In the XML format, this property is represented as an attribute. | |||||||||
| Summary | false | |||||||||
| 140. 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 | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 142. 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..1 | |||||||||
| Type | string | |||||||||
| Is Modifier | false | |||||||||
| XML Format | In the XML format, this property is represented as an attribute. | |||||||||
| Summary | false | |||||||||
| 144. HealthcareService.availableTime.availableEndTime.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.availableTime.availableEndTime.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | |||||||||
| 146. HealthcareService.availableTime.availableEndTime.extension:timeZone | ||||||||||
| Slice Name | timeZone | |||||||||
| Definition | An IANA timezone code for the timezone offset per BCP 175. For data types allowing the offset (all except date and time), this extension SHALL agree with the offset if provided and cannot be used in place of the offset if the precision expressed requires an offset. Where an offset is provided, this extension provides a more legible display of the zone associated with the offset. Where an offset is not present, this extension can be used to provide zone information not otherwise available. | |||||||||
| Short | IANA Timezone Code per BCP 175 | |||||||||
| Comments | Use Australian Time Zone Usage for Australian state and territory time zone offsets. | |||||||||
| Control | 0..1 | |||||||||
| Type | Extension(Timezone Code) (Extension Type: code) | |||||||||
| 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()) | |||||||||
| 148. HealthcareService.availableTime.availableEndTime.value | ||||||||||
| Definition | The actual value | |||||||||
| Short | Primitive value for time | |||||||||
| Control | 0..1 | |||||||||
| Type | time | |||||||||
| Is Modifier | false | |||||||||
| XML Format | In the XML format, this property is represented as an attribute. | |||||||||
| Summary | false | |||||||||
| 150. 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 | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 152. 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..1 | |||||||||
| Type | string | |||||||||
| Is Modifier | false | |||||||||
| XML Format | In the XML format, this property is represented as an attribute. | |||||||||
| Summary | false | |||||||||
| 154. HealthcareService.notAvailable.extension | ||||||||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | |||||||||
| 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()) | |||||||||
| 156. 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()) | |||||||||
| 158. 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())) | |||||||||
| 160. 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 | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||
| 162. 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 | Description of availability exceptions | |||||||||
| Control | 0..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())) | |||||||||
| 164. HealthcareService.endpoint | ||||||||||
| Definition | Technical endpoints providing access to services operated for the specific healthcare services defined at this resource. | |||||||||
| Short | Technical endpoints providing access to electronic services operated for the healthcare service | |||||||||
| Control | 0..* | |||||||||
| Type | Reference(Endpoint) | |||||||||
| Is Modifier | false | |||||||||
| Summary | false | |||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||