Introduction
- Index
- Home
- Business Context
- Implementation Guidance
- FHIR Artifacts
- Terminology
- Downloads and Tools
Logical Model - Healthcare Service
LogicalModelHealthcareRegistryHealthcareService (LogicalModel-HealthcareRegistry-HealthcareService) | Element | There are no (further) constraints on this element Element idLogicalModel-HealthcareRegistry-HealthcareService Base for all elements DefinitionBase definition for all elements in a resource.
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idLogicalModel-HealthcareRegistry-HealthcareService.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idLogicalModel-HealthcareRegistry-HealthcareService.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
active | 1..1 | boolean | Element idLogicalModel-HealthcareRegistry-HealthcareService.active Primitive Type boolean DefinitionValue of "true" or "false"
| |
operationalStatus | 1..1 | Coding | Element idLogicalModel-HealthcareRegistry-HealthcareService.operationalStatus A reference to a code defined by a terminology system DefinitionThe operational status of the service. 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.
| |
organization | I | 0..1 | Reference() | Element idLogicalModel-HealthcareRegistry-HealthcareService.organization A reference from one resource to another DefinitionA reference from one resource to another. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
location | I | 0..1 | Reference() | Element idLogicalModel-HealthcareRegistry-HealthcareService.location A reference from one resource to another DefinitionA reference to the location where the service if provided from. Note that not all services are delivered from physical locations and as such this data element is optional. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
category | 1..* | Coding | Element idLogicalModel-HealthcareRegistry-HealthcareService.category A reference to a code defined by a terminology system DefinitionA code to denote the category of healthcare service 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.
| |
name | 1..1 | string | Element idLogicalModel-HealthcareRegistry-HealthcareService.name Primitive Type string DefinitionThe name of the healthcare service. This data element may be provided in multiple languages. Note that FHIR strings SHALL NOT exceed 1MB in size
| |
serviceDescription | 1..1 | string | Element idLogicalModel-HealthcareRegistry-HealthcareService.serviceDescription A description of the service DefinitionA description of the service. Initially a generic description based on the service category Note that FHIR strings SHALL NOT exceed 1MB in size
| |
bookingMethod | I | 0..* | ContactPoint | Element idLogicalModel-HealthcareRegistry-HealthcareService.bookingMethod Booking method DefinitionThe method by which a citizen can book interaction with the service online | phone | email | in-person .
|
prescriptionBookingMethod | I | 0..* | ContactPoint | Element idLogicalModel-HealthcareRegistry-HealthcareService.prescriptionBookingMethod The link to make a booking DefinitionThe link to enable a booking to be made with the service.
|
referralRequired | 0..1 | boolean | Element idLogicalModel-HealthcareRegistry-HealthcareService.referralRequired Referral Required? DefinitionDenotes whether a referral is required before the service can be used.
| |
telecom | I | 0..* | ContactPoint | Element idLogicalModel-HealthcareRegistry-HealthcareService.telecom Details of a Technology mediated contact point (phone, fax, email, etc.) DefinitionPoints of contact for the healthcare service. These may be phone, email or website URLs.
|
availability | 0..1 | BackboneElement | Element idLogicalModel-HealthcareRegistry-HealthcareService.availability Base for elements defined inside a resource DefinitionBase definition for all elements that are defined inside a resource - but not those in a data type.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idLogicalModel-HealthcareRegistry-HealthcareService.availability.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idLogicalModel-HealthcareRegistry-HealthcareService.availability.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idLogicalModel-HealthcareRegistry-HealthcareService.availability.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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.
|
availableDays | 0..* | BackboneElement | Element idLogicalModel-HealthcareRegistry-HealthcareService.availability.availableDays Base for elements defined inside a resource DefinitionBase definition for all elements that are defined inside a resource - but not those in a data type.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idLogicalModel-HealthcareRegistry-HealthcareService.availability.availableDays.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idLogicalModel-HealthcareRegistry-HealthcareService.availability.availableDays.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idLogicalModel-HealthcareRegistry-HealthcareService.availability.availableDays.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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.
|
dayOfWeek | 1..* | string | Element idLogicalModel-HealthcareRegistry-HealthcareService.availability.availableDays.dayOfWeek Day of the week DefinitionA sequence of Unicode characters Note that FHIR strings SHALL NOT exceed 1MB in size
| |
startTime | 0..1 | time | Element idLogicalModel-HealthcareRegistry-HealthcareService.availability.availableDays.startTime Start time DefinitionThe stat time for a period of opening
| |
endTime | 0..1 | time | Element idLogicalModel-HealthcareRegistry-HealthcareService.availability.availableDays.endTime End time DefinitionThe end time for a period of opening
| |
allDay | 0..1 | boolean | Element idLogicalModel-HealthcareRegistry-HealthcareService.availability.availableDays.allDay Primitive Type boolean DefinitionA flag to denote the service is available for the whole day.
| |
nonAvailability | 0..* | BackboneElement | Element idLogicalModel-HealthcareRegistry-HealthcareService.availability.nonAvailability Periods when there is no availability. DefinitionPeriods when there is no availability.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idLogicalModel-HealthcareRegistry-HealthcareService.availability.nonAvailability.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idLogicalModel-HealthcareRegistry-HealthcareService.availability.nonAvailability.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idLogicalModel-HealthcareRegistry-HealthcareService.availability.nonAvailability.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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.
|
reason | 1..1 | string | Element idLogicalModel-HealthcareRegistry-HealthcareService.availability.nonAvailability.reason Reason DefinitionThe reason for non availability Note that FHIR strings SHALL NOT exceed 1MB in size
| |
periodStart | 0..1 | dateTime | Element idLogicalModel-HealthcareRegistry-HealthcareService.availability.nonAvailability.periodStart Start dateTime of non availability DefinitionStart dateTime of non availability
| |
periodEnd | 0..1 | dateTime | Element idLogicalModel-HealthcareRegistry-HealthcareService.availability.nonAvailability.periodEnd End dateTime of non availability DefinitionEnd dateTime of non availability
| |
availabilityException | 0..1 | string | Element idLogicalModel-HealthcareRegistry-HealthcareService.availability.availabilityException Exceptions to the usual availability DefinitionExceptions to the usual availability schedule (e.g. public holidays) Note that FHIR strings SHALL NOT exceed 1MB in size
|
Logical Model - Location
LogicalModelHealthcareRegistryLocation (LogicalModel-HealthcareRegistry-Location) | Element | There are no (further) constraints on this element Element idLogicalModel-HealthcareRegistry-Location Base for all elements DefinitionBase definition for all elements in a resource.
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idLogicalModel-HealthcareRegistry-Location.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idLogicalModel-HealthcareRegistry-Location.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
status | 1..1 | code | Element idLogicalModel-HealthcareRegistry-Location.status Status DefinitionThe status of the location (note will need to align to Location Resource in due course) active | suspended | inactive Note that FHIR strings SHALL NOT exceed 1MB in size
| |
operationalStatus | 1..1 | CodingBinding | Element idLogicalModel-HealthcareRegistry-Location.operationalStatus The operational status of the location DefinitionA reference to a code defined by a terminology system. This will end up being an extension on the FHIR profile. LocationOperationalStatus (required) Constraints
| |
name | 1..1 | string | Element idLogicalModel-HealthcareRegistry-Location.name Primitive Type string DefinitionA sequence of Unicode characters Note that FHIR strings SHALL NOT exceed 1MB in size
| |
description | 0..1 | string | Element idLogicalModel-HealthcareRegistry-Location.description Primitive Type string DefinitionA sequence of Unicode characters Note that FHIR strings SHALL NOT exceed 1MB in size
| |
type | 1..1 | CodeableConceptBinding | Element idLogicalModel-HealthcareRegistry-Location.type Concept - reference to a terminology or just text DefinitionA concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. LocationFunctionType (required) Constraints
| |
physicalType | 1..1 | CodingBinding | Element idLogicalModel-HealthcareRegistry-Location.physicalType A reference to a code defined by a terminology system DefinitionA reference to a code defined by a terminology system. 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. LocationPhysicalType (required) Constraints
| |
address | 0..1 | Address | Element idLogicalModel-HealthcareRegistry-Location.address An address expressed using postal conventions (as opposed to GPS or other location definition formats) DefinitionAn address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world. Note: address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource).
| |
zone | 1..1 | CodingBinding | Element idLogicalModel-HealthcareRegistry-Location.zone A reference to a code defined by a terminology system DefinitionA reference to a code defined by a terminology system. This will end up being an extension on the FHIR profile. NSHAManagementZone (extensible) Constraints
| |
cluster | 1..1 | CodingBinding | Element idLogicalModel-HealthcareRegistry-Location.cluster A reference to a code defined by a terminology system DefinitionA reference to a code defined by a terminology system. This will end up being an extension on the FHIR profile. NSHAManagementCluster (required) Constraints
| |
position | 0..1 | BackboneElement | Element idLogicalModel-HealthcareRegistry-Location.position The absolute geographic location DefinitionThe absolute geographic location
| |
id | 0..1 | string | There are no (further) constraints on this element Element idLogicalModel-HealthcareRegistry-Location.position.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idLogicalModel-HealthcareRegistry-Location.position.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idLogicalModel-HealthcareRegistry-Location.position.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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.
|
longitude | 1..1 | decimal | Element idLogicalModel-HealthcareRegistry-Location.position.longitude Longitude with WGS84 datum DefinitionA rational number with implicit precision Do not use an IEEE type floating point type, instead use something that works like a true decimal, with inbuilt precision (e.g. Java BigInteger)
| |
latitude | 1..1 | decimal | Element idLogicalModel-HealthcareRegistry-Location.position.latitude Latitude with WGS84 datum DefinitionA rational number with implicit precision Do not use an IEEE type floating point type, instead use something that works like a true decimal, with inbuilt precision (e.g. Java BigInteger)
|
Logical Model - Organization
LogicalModelHealthcareRegistryOrganization (LogicalModel-HealthcareRegistry-Organization) | Element | There are no (further) constraints on this element Element idLogicalModel-HealthcareRegistry-Organization Base for all elements DefinitionBase definition for all elements in a resource.
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idLogicalModel-HealthcareRegistry-Organization.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idLogicalModel-HealthcareRegistry-Organization.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
name | 1..1 | string | Element idLogicalModel-HealthcareRegistry-Organization.name Organization Name DefinitionThe full name of the organization Note that FHIR strings SHALL NOT exceed 1MB in size
| |
alias | 0..* | string | Element idLogicalModel-HealthcareRegistry-Organization.alias Alias names DefinitionOther names by which the organization is known. (e.g. NSH for Nova Scotia Health) .
|