ERA FHIR specification
1.0.0 - draft
ERA FHIR specification - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Draft as of 2026-03-24 |
Definitions for the EraAppointmentHealthcareService resource profile.
See the documentation on how to interpret the contents of this table
| 0. HealthcareService | |||||
| Definition | Healthcare service that is the subject of the appointment The details of a healthcare service available at a location. | ||||
| Short | Healthcare service that is the subject of the appointmentThe 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 | 10..1 | ||||
| Type | id | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| 4. HealthcareService.meta | |||||
| Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. | ||||
| Short | Metadata about 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.meta.profile | |||||
| Definition | A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. | ||||
| Short | Profiles this resource claims to conform to | ||||
| Comments | It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set. | ||||
| Control | 10..1* | ||||
| Type | canonical(StructureDefinition) | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Fixed Value | | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 8. 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())) | ||||
| 10. HealthcareService.extension:AppointmentType | |||||
| Slice Name | AppointmentType | ||||
| Definition | The extension indicates information about the mode of interaction between the professional and the customer. | ||||
| Short | Mode of transaction | ||||
| Comments | Populate when the mode of interaction is available. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(AppointmentType) (Extension Type: Coding) | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||
| 12. HealthcareService.extension:RequestedService | |||||
| Slice Name | RequestedService | ||||
| Definition | The extension indicates the service provider's requested service to which the appointment applies. | ||||
| Short | Requested service | ||||
| Comments | Populate when the requested service identifier is available. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(RequestedService) (Complex Extension) | ||||
| Is Modifier | 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()) | ||||
| 14. HealthcareService.extension:ResourceCalendar | |||||
| Slice Name | ResourceCalendar | ||||
| Definition | The extension indicates the calendar identifier, name, and profession of the resource being booked. Resource means, for example, a room used to provide the service or a professional providing the service. | ||||
| Short | Resource to be booked | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(ResourceCalendar) (Complex Extension) | ||||
| Is Modifier | 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()) | ||||
| 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 | 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..0* | ||||
| 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())) | ||||
| 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 | 0..01 | ||||
| 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 | ||||
| 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 | Identifier of the unit providing the service where the service booked in the appointment is provided. The organization that provides this healthcare service. | ||||
| Short | Service-providing unitOrganization 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(AppointmentOrganization, Organization)referenced | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 24. HealthcareService.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 | Reference to the resource to be usedLiteral 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 | 10..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())) | ||||
| 26. 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..01 | ||||
| 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())) | ||||
| 28. HealthcareService.providedBy.display | |||||
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. | ||||
| Short | Text 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 | 0..01 | ||||
| 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())) | ||||
| 30. HealthcareService.category | |||||
| Definition | Information expressed by code about the service category to which the appointment applies. The service category is expressed using codes from the THL Classification of Social and Healthcare Services (THL - Sosiaali- ja terveyspalvelujen luokitus). Identifies the broad category of service being performed or delivered. | ||||
| Short | Service categoryBroad 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 | 10..1* | ||||
| Binding | The codes SHALL be taken from For example codes, see fipta-vs-servicecategoryhttp://hl7.org/fhir/ValueSet/service-category|4.0.1 (required to https://pta.kanta.fi/fhir/ValueSet/fipta-vs-servicecategory) | ||||
| 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())) | ||||
| 32. HealthcareService.category.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())) | ||||
| 34. HealthcareService.category.coding.system | |||||
| Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||||
| Short | Identity of the terminology system | ||||
| Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. | ||||
| Control | 10..1 | ||||
| Type | uri | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 36. HealthcareService.category.coding.version | |||||
| Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. | ||||
| Short | Version of the system - if relevant | ||||
| Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. | ||||
| Note | This is a business version Id, not a resource version Id (see discussion) | ||||
| Control | 0..01 | ||||
| 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())) | ||||
| 38. HealthcareService.category.coding.code | |||||
| Definition | Code value according to the fipta-vs-servicecategory value set. A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). | ||||
| Short | Code value of the service categorySymbol in syntax defined by the system | ||||
| Control | 10..1 | ||||
| Type | code | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Need to refer to a particular code in the system. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 40. HealthcareService.category.coding.display | |||||
| Definition | Value according to the fipta-vs-servicecategory value set. The value name must correspond to the given code value. A representation of the meaning of the code in the system, following the rules of the system. | ||||
| Short | Service category nameRepresentation defined by the system | ||||
| Control | 10..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 42. HealthcareService.category.coding.userSelected | |||||
| Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). | ||||
| Short | If this coding was chosen directly by the user | ||||
| Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. | ||||
| Control | 0..01 | ||||
| Type | boolean | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 44. HealthcareService.category.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..01 | ||||
| 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())) | ||||
| 46. HealthcareService.type | |||||
| Definition | The detailed content of the booking is indicated using values from the Association of Finnish Local and Regional Authorities Laboratory Test Nomenclature (1.2.246.537.6.3.2006) and the THL Procedure Classification (1.2.246.537.6.2.2007). The specific type of service that may be delivered or performed. | ||||
| Short | Detailed content of the bookingType of service that may be delivered or performed | ||||
| Control | 0..* | ||||
| Binding | The codes SHALL be taken from For example codes, see fipta-vs-detailedcontenthttp://hl7.org/fhir/ValueSet/service-type|4.0.1 (required to https://pta.kanta.fi/fhir/ValueSet/fipta-vs-detailedcontent) | ||||
| Type | CodeableConcept | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Alternate Names | service type | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 48. HealthcareService.type.coding | |||||
| Definition | A reference to a code defined by a terminology system. | ||||
| Short | Code defined by a terminology system | ||||
| Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. | ||||
| Control | 10..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())) | ||||
| 50. HealthcareService.type.coding.system | |||||
| Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||||
| Short | Identity of the terminology system | ||||
| Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. | ||||
| Control | 10..1 | ||||
| Type | uri | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 52. HealthcareService.type.coding.version | |||||
| Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. | ||||
| Short | Version of the system - if relevant | ||||
| Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. | ||||
| Note | This is a business version Id, not a resource version Id (see discussion) | ||||
| Control | 0..01 | ||||
| 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())) | ||||
| 54. HealthcareService.type.coding.code | |||||
| Definition | Code value according to the fipta-vs-detailedcontent value set. A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). | ||||
| Short | Code value of the detailed content of the bookingSymbol in syntax defined by the system | ||||
| Control | 10..1 | ||||
| Type | code | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Need to refer to a particular code in the system. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 56. HealthcareService.type.coding.display | |||||
| Definition | Value according to the fipta-vs-detailedcontent value set. The value name must correspond to the given code value. A representation of the meaning of the code in the system, following the rules of the system. | ||||
| Short | Detailed content of the bookingRepresentation defined by the system | ||||
| Control | 10..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 58. HealthcareService.type.coding.userSelected | |||||
| Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). | ||||
| Short | If this coding was chosen directly by the user | ||||
| Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. | ||||
| Control | 0..01 | ||||
| Type | boolean | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 60. HealthcareService.type.text | |||||
| Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. | ||||
| Short | Plain text representation of the concept | ||||
| Comments | Very often the text is the same as a displayName of one of the codings. | ||||
| Control | 0..01 | ||||
| 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())) | ||||
| 62. HealthcareService.specialty | |||||
| Definition | Information expressed by code about the specialty to which the appointment applies. The specialty is expressed using the Hilmo Healthcare Specialties code system (1.2.246.537.6.24.2003). Collection of specialties handled by the service site. This is more of a medical term. | ||||
| Short | Appointment specialtySpecialties handled by the HealthcareService | ||||
| Control | 0..1* | ||||
| Binding | The codes SHALL be taken from The codes SHOULD be taken from fipta-vs-specialtyhttp://hl7.org/fhir/ValueSet/c80-practice-codes|4.0.1 (required to https://pta.kanta.fi/fhir/ValueSet/fipta-vs-specialty) | ||||
| 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())) | ||||
| 64. HealthcareService.specialty.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())) | ||||
| 66. HealthcareService.specialty.coding.system | |||||
| Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||||
| Short | Identity of the terminology system | ||||
| Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. | ||||
| Control | 10..1 | ||||
| Type | uri | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 68. HealthcareService.specialty.coding.version | |||||
| Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. | ||||
| Short | Version of the system - if relevant | ||||
| Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. | ||||
| Note | This is a business version Id, not a resource version Id (see discussion) | ||||
| Control | 0..01 | ||||
| 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())) | ||||
| 70. HealthcareService.specialty.coding.code | |||||
| Definition | Code value according to the fipta-vs-specialty value set. A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). | ||||
| Short | Specialty code valueSymbol in syntax defined by the system | ||||
| Control | 10..1 | ||||
| Type | code | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Need to refer to a particular code in the system. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 72. HealthcareService.specialty.coding.display | |||||
| Definition | Value according to the fipta-vs-specialty value set. The value name must correspond to the given code value. A representation of the meaning of the code in the system, following the rules of the system. | ||||
| Short | Specialty nameRepresentation defined by the system | ||||
| Control | 10..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 74. HealthcareService.specialty.coding.userSelected | |||||
| Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). | ||||
| Short | If this coding was chosen directly by the user | ||||
| Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. | ||||
| Control | 0..01 | ||||
| Type | boolean | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 76. HealthcareService.specialty.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..01 | ||||
| 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())) | ||||
| 78. HealthcareService.location | |||||
| Definition | The location(s) where this healthcare service may be provided. | ||||
| Short | Location(s) where service may be provided | ||||
| Control | 0..0* | ||||
| Type | Reference(Location) | ||||
| 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.name | |||||
| Definition | Clear title visible to the citizen. Further description of the service as it would be presented to a consumer while searching. | ||||
| Short | Service titleDescription 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 | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 82. 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..01 | ||||
| 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())) | ||||
| 84. HealthcareService.extraDetails | |||||
| Definition | Extra details about the service that can't be placed in the other fields. | ||||
| Short | Extra details about the service that can't be placed in the other fields | ||||
| Control | 0..01 | ||||
| Type | markdown | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 86. HealthcareService.photo | |||||
| Definition | If there is a photo/symbol associated with this HealthcareService, it may be included here to facilitate quick identification of the service in a list. | ||||
| Short | Facilitates quick identification of the service | ||||
| Control | 0..01 | ||||
| Type | Attachment | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 88. 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..0* | ||||
| Type | ContactPoint | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 90. 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..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())) | ||||
| 92. 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..0* | ||||
| Binding | For example codes, see ServiceProvisionConditionshttp://hl7.org/fhir/ValueSet/service-provision-conditions|4.0.1 (example to http://hl7.org/fhir/ValueSet/service-provision-conditions|4.0.1)The code(s) that detail the conditions under which the healthcare service is available/offered. | ||||
| 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())) | ||||
| 94. 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..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())) | ||||
| 97. 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..0* | ||||
| Binding | For example codes, see Programhttp://hl7.org/fhir/ValueSet/program|4.0.1 (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())) | ||||
| 99. HealthcareService.characteristic | |||||
| Definition | Collection of characteristics (attributes). | ||||
| Short | Collection of characteristics (attributes) | ||||
| Comments | These could be such things as is wheelchair accessible. | ||||
| Control | 0..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())) | ||||
| 101. HealthcareService.communication | |||||
| Definition | This field contains, using a language code system, the language in which the organization provides the service to the customer, for example when assessing the need for care or service or when giving instructions to the customer. The language is indicated using a two- or three-letter identifier and in accordance with the ISO 639 international standard and the BCP 47 standard, corresponding to values in the SFS Language Code System (1.2.246.537.5.40175.2008) or the THL Three-Letter Language Code System (1.2.246.537.5.40275.202301). 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 | Service languageThe 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..1* | ||||
| Binding | The codes SHOULD be taken from CommonLanguageshttp://hl7.org/fhir/ValueSet/languages|4.0.1 (preferred to http://hl7.org/fhir/ValueSet/languages|4.0.1)A human language.
| ||||
| 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())) | ||||
| 103. HealthcareService.communication.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..01 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 105. HealthcareService.communication.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())) | ||||
| 107. HealthcareService.communication.coding.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..01 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 109. HealthcareService.communication.coding.system | |||||
| Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||||
| Short | Identity of the terminology system | ||||
| Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. | ||||
| Control | 10..1 | ||||
| Type | uri | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 111. HealthcareService.communication.coding.version | |||||
| Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. | ||||
| Short | Version of the system - if relevant | ||||
| Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. | ||||
| Note | This is a business version Id, not a resource version Id (see discussion) | ||||
| Control | 0..01 | ||||
| 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())) | ||||
| 113. HealthcareService.communication.coding.code | |||||
| Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). | ||||
| Short | Symbol in syntax defined by the system | ||||
| Control | 10..1 | ||||
| Type | code | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Need to refer to a particular code in the system. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 115. HealthcareService.communication.coding.display | |||||
| Definition | A representation of the meaning of the code in the system, following the rules of the system. | ||||
| Short | Representation defined by the system | ||||
| Control | 10..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 117. HealthcareService.communication.coding.userSelected | |||||
| Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). | ||||
| Short | If this coding was chosen directly by the user | ||||
| Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. | ||||
| Control | 0..01 | ||||
| Type | boolean | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 119. HealthcareService.communication.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..01 | ||||
| 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())) | ||||
| 121. HealthcareService.referralMethod | |||||
| Definition | Ways that the service accepts referrals, if this is not provided then it is implied that no referral is required. | ||||
| Short | Ways that the service accepts referrals | ||||
| Control | 0..0* | ||||
| Binding | For example codes, see ReferralMethodhttp://hl7.org/fhir/ValueSet/service-referral-method|4.0.1 (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())) | ||||
| 123. 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..01 | ||||
| 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())) | ||||
| 125. 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..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())) | ||||
| 128. 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..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())) | ||||
| 132. 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..01 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 134. 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..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())) | ||||
See the documentation on how to interpret the contents of this table
| 0. HealthcareService | |
| Definition | Healthcare service that is the subject of the appointment |
| Short | Healthcare service that is the subject of the appointment |
| 2. HealthcareService.id | |
| Control | 1..? |
| 4. HealthcareService.meta | |
| 6. HealthcareService.meta.profile | |
| Control | 1..1 |
| Fixed Value | |
| 8. HealthcareService.extension:AppointmentType | |
| Slice Name | AppointmentType |
| Type | Extension(AppointmentType) (Extension Type: Coding) |
| Is Modifier | false |
| 10. HealthcareService.extension:RequestedService | |
| Slice Name | RequestedService |
| Type | Extension(RequestedService) (Complex Extension) |
| Is Modifier | false |
| 12. HealthcareService.extension:ResourceCalendar | |
| Slice Name | ResourceCalendar |
| Type | Extension(ResourceCalendar) (Complex Extension) |
| Is Modifier | false |
| 14. HealthcareService.identifier | |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..0 |
| 16. HealthcareService.active | |
| Control | 0..0 |
| 18. HealthcareService.providedBy | |
| Definition | Identifier of the unit providing the service where the service booked in the appointment is provided. |
| Short | Service-providing unit |
| Control | 1..? |
| Type | Reference(AppointmentOrganization)referenced |
| 20. HealthcareService.providedBy.reference | |
| Short | Reference to the resource to be used |
| Control | 1..? |
| 22. HealthcareService.providedBy.identifier | |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..0 |
| 24. HealthcareService.providedBy.display | |
| Control | 0..0 |
| 26. HealthcareService.category | |
| Definition | Information expressed by code about the service category to which the appointment applies. The service category is expressed using codes from the THL Classification of Social and Healthcare Services (THL - Sosiaali- ja terveyspalvelujen luokitus). |
| Short | Service category |
| Control | 1..1 |
| Binding | The codes SHALL be taken from fipta-vs-servicecategory (required to https://pta.kanta.fi/fhir/ValueSet/fipta-vs-servicecategory) |
| 28. HealthcareService.category.coding | |
| Control | 1..1 |
| 30. HealthcareService.category.coding.system | |
| Control | 1..? |
| 32. HealthcareService.category.coding.version | |
| Note | This is a business version Id, not a resource version Id (see discussion) |
| Control | 0..0 |
| 34. HealthcareService.category.coding.code | |
| Definition | Code value according to the fipta-vs-servicecategory value set. |
| Short | Code value of the service category |
| Control | 1..? |
| 36. HealthcareService.category.coding.display | |
| Definition | Value according to the fipta-vs-servicecategory value set. The value name must correspond to the given code value. |
| Short | Service category name |
| Control | 1..? |
| 38. HealthcareService.category.coding.userSelected | |
| Control | 0..0 |
| 40. HealthcareService.category.text | |
| Control | 0..0 |
| 42. HealthcareService.type | |
| Definition | The detailed content of the booking is indicated using values from the Association of Finnish Local and Regional Authorities Laboratory Test Nomenclature (1.2.246.537.6.3.2006) and the THL Procedure Classification (1.2.246.537.6.2.2007). |
| Short | Detailed content of the booking |
| Binding | The codes SHALL be taken from fipta-vs-detailedcontent (required to https://pta.kanta.fi/fhir/ValueSet/fipta-vs-detailedcontent) |
| 44. HealthcareService.type.coding | |
| Control | 1..1 |
| 46. HealthcareService.type.coding.system | |
| Control | 1..? |
| 48. HealthcareService.type.coding.version | |
| Note | This is a business version Id, not a resource version Id (see discussion) |
| Control | 0..0 |
| 50. HealthcareService.type.coding.code | |
| Definition | Code value according to the fipta-vs-detailedcontent value set. |
| Short | Code value of the detailed content of the booking |
| Control | 1..? |
| 52. HealthcareService.type.coding.display | |
| Definition | Value according to the fipta-vs-detailedcontent value set. The value name must correspond to the given code value. |
| Short | Detailed content of the booking |
| Control | 1..? |
| 54. HealthcareService.type.coding.userSelected | |
| Control | 0..0 |
| 56. HealthcareService.type.text | |
| Control | 0..0 |
| 58. HealthcareService.specialty | |
| Definition | Information expressed by code about the specialty to which the appointment applies. The specialty is expressed using the Hilmo Healthcare Specialties code system (1.2.246.537.6.24.2003). |
| Short | Appointment specialty |
| Control | 0..1 |
| Binding | The codes SHALL be taken from fipta-vs-specialty (required to https://pta.kanta.fi/fhir/ValueSet/fipta-vs-specialty) |
| 60. HealthcareService.specialty.coding | |
| Control | 1..1 |
| 62. HealthcareService.specialty.coding.system | |
| Control | 1..? |
| 64. HealthcareService.specialty.coding.version | |
| Note | This is a business version Id, not a resource version Id (see discussion) |
| Control | 0..0 |
| 66. HealthcareService.specialty.coding.code | |
| Definition | Code value according to the fipta-vs-specialty value set. |
| Short | Specialty code value |
| Control | 1..? |
| 68. HealthcareService.specialty.coding.display | |
| Definition | Value according to the fipta-vs-specialty value set. The value name must correspond to the given code value. |
| Short | Specialty name |
| Control | 1..? |
| 70. HealthcareService.specialty.coding.userSelected | |
| Control | 0..0 |
| 72. HealthcareService.specialty.text | |
| Control | 0..0 |
| 74. HealthcareService.location | |
| Control | 0..0 |
| 76. HealthcareService.name | |
| Definition | Clear title visible to the citizen. |
| Short | Service title |
| Control | 1..? |
| 78. HealthcareService.comment | |
| Control | 0..0 |
| 80. HealthcareService.extraDetails | |
| Control | 0..0 |
| 82. HealthcareService.photo | |
| Control | 0..0 |
| 84. HealthcareService.telecom | |
| Control | 0..0 |
| 86. HealthcareService.coverageArea | |
| Control | 0..0 |
| 88. HealthcareService.serviceProvisionCode | |
| Control | 0..0 |
| 90. HealthcareService.eligibility | |
| Control | 0..0 |
| 92. HealthcareService.program | |
| Control | 0..0 |
| 94. HealthcareService.characteristic | |
| Control | 0..0 |
| 96. HealthcareService.communication | |
| Definition | This field contains, using a language code system, the language in which the organization provides the service to the customer, for example when assessing the need for care or service or when giving instructions to the customer. The language is indicated using a two- or three-letter identifier and in accordance with the ISO 639 international standard and the BCP 47 standard, corresponding to values in the SFS Language Code System (1.2.246.537.5.40175.2008) or the THL Three-Letter Language Code System (1.2.246.537.5.40275.202301). |
| Short | Service language |
| Control | 0..1 |
| 98. HealthcareService.communication.id | |
| Control | 0..0 |
| 100. HealthcareService.communication.coding | |
| Control | 1..1 |
| 102. HealthcareService.communication.coding.id | |
| Control | 0..0 |
| 104. HealthcareService.communication.coding.system | |
| Control | 1..? |
| 106. HealthcareService.communication.coding.version | |
| Note | This is a business version Id, not a resource version Id (see discussion) |
| Control | 0..0 |
| 108. HealthcareService.communication.coding.code | |
| Control | 1..? |
| 110. HealthcareService.communication.coding.display | |
| Control | 1..? |
| 112. HealthcareService.communication.coding.userSelected | |
| Control | 0..0 |
| 114. HealthcareService.communication.text | |
| Control | 0..0 |
| 116. HealthcareService.referralMethod | |
| Control | 0..0 |
| 118. HealthcareService.appointmentRequired | |
| Control | 0..0 |
| 120. HealthcareService.availableTime | |
| Control | 0..0 |
| 122. HealthcareService.notAvailable | |
| Control | 0..0 |
| 124. HealthcareService.availabilityExceptions | |
| Control | 0..0 |
| 126. HealthcareService.endpoint | |
| Control | 0..0 |
See the documentation on how to interpret the contents of this table
| 0. HealthcareService | |||||
| Definition | Healthcare service that is the subject of the appointment | ||||
| Short | Healthcare service that is the subject of the appointment | ||||
| 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 | 1..1 | ||||
| Type | id | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| 4. HealthcareService.meta | |||||
| Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. | ||||
| Short | Metadata about 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.meta.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 8. HealthcareService.meta.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| 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.meta.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 10. HealthcareService.meta.versionId | |||||
| Definition | The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted. | ||||
| Short | Version specific identifier | ||||
| Comments | The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes. | ||||
| Control | 0..1 | ||||
| Type | id | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 12. HealthcareService.meta.lastUpdated | |||||
| Definition | When the resource last changed - e.g. when the version changed. | ||||
| Short | When the resource version last changed | ||||
| Comments | This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction. | ||||
| Control | 0..1 | ||||
| Type | instant | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 14. HealthcareService.meta.source | |||||
| Definition | A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc. | ||||
| Short | Identifies where the resource comes from | ||||
| Comments | In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL. | ||||
| Control | 0..1 | ||||
| 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())) | ||||
| 16. HealthcareService.meta.profile | |||||
| Definition | A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. | ||||
| Short | Profiles this resource claims to conform to | ||||
| Comments | It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set. | ||||
| Control | 1..1 | ||||
| Type | canonical(StructureDefinition) | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Fixed Value | | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 18. HealthcareService.meta.security | |||||
| Definition | Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. | ||||
| Short | Security Labels applied to this resource | ||||
| Comments | The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored. | ||||
| Control | 0..* | ||||
| Binding | Unless not suitable, these codes SHALL be taken from All Security Labels (extensible to http://hl7.org/fhir/ValueSet/security-labels|4.0.1)Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| Type | Coding | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 20. HealthcareService.meta.tag | |||||
| Definition | Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. | ||||
| Short | Tags applied to this resource | ||||
| Comments | The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored. | ||||
| Control | 0..* | ||||
| Binding | For example codes, see CommonTags (example to http://hl7.org/fhir/ValueSet/common-tags|4.0.1)Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
| Type | Coding | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 22. 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())) | ||||
| 24. 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())) | ||||
| 26. 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())) | ||||
| 28. 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 | ||||
| 30. HealthcareService.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.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 32. HealthcareService.extension:AppointmentType | |||||
| Slice Name | AppointmentType | ||||
| Definition | The extension indicates information about the mode of interaction between the professional and the customer. | ||||
| Short | Mode of transaction | ||||
| Comments | Populate when the mode of interaction is available. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(AppointmentType) (Extension Type: Coding) | ||||
| 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()) | ||||
| 34. HealthcareService.extension:RequestedService | |||||
| Slice Name | RequestedService | ||||
| Definition | The extension indicates the service provider's requested service to which the appointment applies. | ||||
| Short | Requested service | ||||
| Comments | Populate when the requested service identifier is available. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(RequestedService) (Complex Extension) | ||||
| Is Modifier | 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()) | ||||
| 36. HealthcareService.extension:ResourceCalendar | |||||
| Slice Name | ResourceCalendar | ||||
| Definition | The extension indicates the calendar identifier, name, and profession of the resource being booked. Resource means, for example, a room used to provide the service or a professional providing the service. | ||||
| Short | Resource to be booked | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(ResourceCalendar) (Complex Extension) | ||||
| Is Modifier | 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()) | ||||
| 38. 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()) | ||||
| 40. HealthcareService.identifier | |||||
| Definition | 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..0 | ||||
| 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())) | ||||
| 42. 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 | 0..0 | ||||
| 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 | ||||
| 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())) | ||||
| 44. HealthcareService.providedBy | |||||
| Definition | Identifier of the unit providing the service where the service booked in the appointment is provided. | ||||
| Short | Service-providing unit | ||||
| 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(AppointmentOrganization)referenced | ||||
| 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.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 | ||||
| 48. 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: | ||||
| 50. 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 | Reference to the resource to be used | ||||
| 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 | 1..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())) | ||||
| 52. 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())) | ||||
| 54. 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..0 | ||||
| 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())) | ||||
| 56. HealthcareService.providedBy.display | |||||
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. | ||||
| Short | Text 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 | 0..0 | ||||
| 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())) | ||||
| 58. HealthcareService.category | |||||
| Definition | Information expressed by code about the service category to which the appointment applies. The service category is expressed using codes from the THL Classification of Social and Healthcare Services (THL - Sosiaali- ja terveyspalvelujen luokitus). | ||||
| Short | Service category | ||||
| Comments | Selecting a Service Category then determines the list of relevant service types that can be selected in the primary service type. | ||||
| Control | 1..1 | ||||
| Binding | The codes SHALL be taken from fipta-vs-servicecategory (required to https://pta.kanta.fi/fhir/ValueSet/fipta-vs-servicecategory) | ||||
| 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())) | ||||
| 60. HealthcareService.category.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 | ||||
| 62. HealthcareService.category.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.category.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 64. HealthcareService.category.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())) | ||||
| 66. HealthcareService.category.coding.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| 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 | ||||
| 68. HealthcareService.category.coding.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| 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.category.coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 70. HealthcareService.category.coding.system | |||||
| Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||||
| Short | Identity of the terminology system | ||||
| Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. | ||||
| Control | 1..1 | ||||
| Type | uri | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 72. HealthcareService.category.coding.version | |||||
| Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. | ||||
| Short | Version of the system - if relevant | ||||
| Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. | ||||
| Note | This is a business version Id, not a resource version Id (see discussion) | ||||
| Control | 0..0 | ||||
| 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())) | ||||
| 74. HealthcareService.category.coding.code | |||||
| Definition | Code value according to the fipta-vs-servicecategory value set. | ||||
| Short | Code value of the service category | ||||
| Control | 1..1 | ||||
| Type | code | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Need to refer to a particular code in the system. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 76. HealthcareService.category.coding.display | |||||
| Definition | Value according to the fipta-vs-servicecategory value set. The value name must correspond to the given code value. | ||||
| Short | Service category name | ||||
| Control | 1..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 78. HealthcareService.category.coding.userSelected | |||||
| Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). | ||||
| Short | If this coding was chosen directly by the user | ||||
| Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. | ||||
| Control | 0..0 | ||||
| Type | boolean | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 80. HealthcareService.category.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..0 | ||||
| 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())) | ||||
| 82. HealthcareService.type | |||||
| Definition | The detailed content of the booking is indicated using values from the Association of Finnish Local and Regional Authorities Laboratory Test Nomenclature (1.2.246.537.6.3.2006) and the THL Procedure Classification (1.2.246.537.6.2.2007). | ||||
| Short | Detailed content of the booking | ||||
| Control | 0..* | ||||
| Binding | The codes SHALL be taken from fipta-vs-detailedcontent (required to https://pta.kanta.fi/fhir/ValueSet/fipta-vs-detailedcontent) | ||||
| Type | CodeableConcept | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Alternate Names | service type | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 84. HealthcareService.type.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 86. HealthcareService.type.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| Slicing | This element introduces a set of slices on HealthcareService.type.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 88. HealthcareService.type.coding | |||||
| Definition | A reference to a code defined by a terminology system. | ||||
| Short | Code defined by a terminology system | ||||
| Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. | ||||
| Control | 1..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())) | ||||
| 90. HealthcareService.type.coding.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| 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 | ||||
| 92. HealthcareService.type.coding.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| Slicing | This element introduces a set of slices on HealthcareService.type.coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 94. HealthcareService.type.coding.system | |||||
| Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||||
| Short | Identity of the terminology system | ||||
| Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. | ||||
| Control | 1..1 | ||||
| Type | uri | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 96. HealthcareService.type.coding.version | |||||
| Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. | ||||
| Short | Version of the system - if relevant | ||||
| Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. | ||||
| Note | This is a business version Id, not a resource version Id (see discussion) | ||||
| Control | 0..0 | ||||
| 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())) | ||||
| 98. HealthcareService.type.coding.code | |||||
| Definition | Code value according to the fipta-vs-detailedcontent value set. | ||||
| Short | Code value of the detailed content of the booking | ||||
| Control | 1..1 | ||||
| Type | code | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Need to refer to a particular code in the system. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 100. HealthcareService.type.coding.display | |||||
| Definition | Value according to the fipta-vs-detailedcontent value set. The value name must correspond to the given code value. | ||||
| Short | Detailed content of the booking | ||||
| Control | 1..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 102. HealthcareService.type.coding.userSelected | |||||
| Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). | ||||
| Short | If this coding was chosen directly by the user | ||||
| Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. | ||||
| Control | 0..0 | ||||
| Type | boolean | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 104. HealthcareService.type.text | |||||
| Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. | ||||
| Short | Plain text representation of the concept | ||||
| Comments | Very often the text is the same as a displayName of one of the codings. | ||||
| Control | 0..0 | ||||
| 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())) | ||||
| 106. HealthcareService.specialty | |||||
| Definition | Information expressed by code about the specialty to which the appointment applies. The specialty is expressed using the Hilmo Healthcare Specialties code system (1.2.246.537.6.24.2003). | ||||
| Short | Appointment specialty | ||||
| Control | 0..1 | ||||
| Binding | The codes SHALL be taken from fipta-vs-specialty (required to https://pta.kanta.fi/fhir/ValueSet/fipta-vs-specialty) | ||||
| 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())) | ||||
| 108. HealthcareService.specialty.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 | ||||
| 110. HealthcareService.specialty.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.specialty.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 112. HealthcareService.specialty.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())) | ||||
| 114. HealthcareService.specialty.coding.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| 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 | ||||
| 116. HealthcareService.specialty.coding.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| 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.specialty.coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 118. HealthcareService.specialty.coding.system | |||||
| Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||||
| Short | Identity of the terminology system | ||||
| Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. | ||||
| Control | 1..1 | ||||
| Type | uri | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 120. HealthcareService.specialty.coding.version | |||||
| Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. | ||||
| Short | Version of the system - if relevant | ||||
| Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. | ||||
| Note | This is a business version Id, not a resource version Id (see discussion) | ||||
| Control | 0..0 | ||||
| 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())) | ||||
| 122. HealthcareService.specialty.coding.code | |||||
| Definition | Code value according to the fipta-vs-specialty value set. | ||||
| Short | Specialty code value | ||||
| Control | 1..1 | ||||
| Type | code | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Need to refer to a particular code in the system. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 124. HealthcareService.specialty.coding.display | |||||
| Definition | Value according to the fipta-vs-specialty value set. The value name must correspond to the given code value. | ||||
| Short | Specialty name | ||||
| Control | 1..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 126. HealthcareService.specialty.coding.userSelected | |||||
| Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). | ||||
| Short | If this coding was chosen directly by the user | ||||
| Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. | ||||
| Control | 0..0 | ||||
| Type | boolean | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 128. HealthcareService.specialty.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..0 | ||||
| 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())) | ||||
| 130. HealthcareService.location | |||||
| Definition | The location(s) where this healthcare service may be provided. | ||||
| Short | Location(s) where service may be provided | ||||
| Control | 0..0 | ||||
| Type | Reference(Location) | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 132. HealthcareService.name | |||||
| Definition | Clear title visible to the citizen. | ||||
| Short | Service title | ||||
| 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())) | ||||
| 134. 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..0 | ||||
| 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())) | ||||
| 136. HealthcareService.extraDetails | |||||
| Definition | Extra details about the service that can't be placed in the other fields. | ||||
| Short | Extra details about the service that can't be placed in the other fields | ||||
| Control | 0..0 | ||||
| Type | markdown | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 138. HealthcareService.photo | |||||
| Definition | If there is a photo/symbol associated with this HealthcareService, it may be included here to facilitate quick identification of the service in a list. | ||||
| Short | Facilitates quick identification of the service | ||||
| Control | 0..0 | ||||
| Type | Attachment | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 140. 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..0 | ||||
| Type | ContactPoint | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 142. HealthcareService.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..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())) | ||||
| 144. 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..0 | ||||
| Binding | For example codes, see ServiceProvisionConditions (example to http://hl7.org/fhir/ValueSet/service-provision-conditions|4.0.1)The code(s) that detail the conditions under which the healthcare service is available/offered. | ||||
| 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())) | ||||
| 146. 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..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())) | ||||
| 153. 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..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())) | ||||
| 155. HealthcareService.characteristic | |||||
| Definition | Collection of characteristics (attributes). | ||||
| Short | Collection of characteristics (attributes) | ||||
| Comments | These could be such things as is wheelchair accessible. | ||||
| Control | 0..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())) | ||||
| 157. HealthcareService.communication | |||||
| Definition | This field contains, using a language code system, the language in which the organization provides the service to the customer, for example when assessing the need for care or service or when giving instructions to the customer. The language is indicated using a two- or three-letter identifier and in accordance with the ISO 639 international standard and the BCP 47 standard, corresponding to values in the SFS Language Code System (1.2.246.537.5.40175.2008) or the THL Three-Letter Language Code System (1.2.246.537.5.40275.202301). | ||||
| Short | Service language | ||||
| 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..1 | ||||
| Binding | The codes SHOULD be taken from CommonLanguages (preferred to http://hl7.org/fhir/ValueSet/languages|4.0.1)A human language.
| ||||
| 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())) | ||||
| 159. HealthcareService.communication.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..0 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 161. HealthcareService.communication.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.communication.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 163. HealthcareService.communication.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())) | ||||
| 165. HealthcareService.communication.coding.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..0 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 167. HealthcareService.communication.coding.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| 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.communication.coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 169. HealthcareService.communication.coding.system | |||||
| Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||||
| Short | Identity of the terminology system | ||||
| Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. | ||||
| Control | 1..1 | ||||
| Type | uri | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 171. HealthcareService.communication.coding.version | |||||
| Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. | ||||
| Short | Version of the system - if relevant | ||||
| Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. | ||||
| Note | This is a business version Id, not a resource version Id (see discussion) | ||||
| Control | 0..0 | ||||
| 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())) | ||||
| 173. HealthcareService.communication.coding.code | |||||
| Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). | ||||
| Short | Symbol in syntax defined by the system | ||||
| Control | 1..1 | ||||
| Type | code | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Need to refer to a particular code in the system. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 175. HealthcareService.communication.coding.display | |||||
| Definition | A representation of the meaning of the code in the system, following the rules of the system. | ||||
| Short | Representation defined by the system | ||||
| Control | 1..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 177. HealthcareService.communication.coding.userSelected | |||||
| Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). | ||||
| Short | If this coding was chosen directly by the user | ||||
| Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. | ||||
| Control | 0..0 | ||||
| Type | boolean | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 179. HealthcareService.communication.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..0 | ||||
| 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())) | ||||
| 181. HealthcareService.referralMethod | |||||
| Definition | Ways that the service accepts referrals, if this is not provided then it is implied that no referral is required. | ||||
| Short | Ways that the service accepts referrals | ||||
| Control | 0..0 | ||||
| Binding | For example codes, see ReferralMethod (example to http://hl7.org/fhir/ValueSet/service-referral-method|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())) | ||||
| 183. 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..0 | ||||
| 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())) | ||||
| 185. 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..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())) | ||||
| 194. 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..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())) | ||||
| 201. 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..0 | ||||
| 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())) | ||||
| 203. 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..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())) | ||||