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-HealthcareServiceShort description Base for all elements DefinitionBase definition for all elements in a resource. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idLogicalModel-HealthcareRegistry-HealthcareService.idShort description 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 | C | 0..* | Extension | There are no (further) constraints on this element Element idLogicalModel-HealthcareRegistry-HealthcareService.extensionShort description 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.activeShort description Primitive Type boolean DefinitionValue of "true" or "false"
| |
operationalStatus | 1..1 | Coding | Element idLogicalModel-HealthcareRegistry-HealthcareService.operationalStatusShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |
organization | C | 0..1 | Reference() | Element idLogicalModel-HealthcareRegistry-HealthcareService.organizationShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
|
location | C | 0..1 | Reference() | Element idLogicalModel-HealthcareRegistry-HealthcareService.locationShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
|
category | 1..* | Coding | Element idLogicalModel-HealthcareRegistry-HealthcareService.categoryShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |
name | 1..1 | string | Element idLogicalModel-HealthcareRegistry-HealthcareService.nameShort description 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.serviceDescriptionShort description 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 | C | 0..* | ContactPoint | Element idLogicalModel-HealthcareRegistry-HealthcareService.bookingMethodShort description Booking method DefinitionThe method by which a citizen can book interaction with the service online | phone | email | in-person . The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
|
prescriptionBookingMethod | C | 0..* | ContactPoint | Element idLogicalModel-HealthcareRegistry-HealthcareService.prescriptionBookingMethodShort description The link to make a booking DefinitionThe link to enable a booking to be made with the service. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
|
referralRequired | 0..1 | boolean | Element idLogicalModel-HealthcareRegistry-HealthcareService.referralRequiredShort description Referral Required? DefinitionDenotes whether a referral is required before the service can be used.
| |
telecom | C | 0..* | ContactPoint | Element idLogicalModel-HealthcareRegistry-HealthcareService.telecomShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
|
availability | 0..1 | BackboneElement | Element idLogicalModel-HealthcareRegistry-HealthcareService.availabilityShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |
id | 0..1 | string | There are no (further) constraints on this element Element idLogicalModel-HealthcareRegistry-HealthcareService.availability.idShort description 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 | C | 0..* | Extension | There are no (further) constraints on this element Element idLogicalModel-HealthcareRegistry-HealthcareService.availability.extensionShort description 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 | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idLogicalModel-HealthcareRegistry-HealthcareService.availability.modifierExtensionShort description 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.availableDaysShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |
id | 0..1 | string | There are no (further) constraints on this element Element idLogicalModel-HealthcareRegistry-HealthcareService.availability.availableDays.idShort description 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 | C | 0..* | Extension | There are no (further) constraints on this element Element idLogicalModel-HealthcareRegistry-HealthcareService.availability.availableDays.extensionShort description 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 | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idLogicalModel-HealthcareRegistry-HealthcareService.availability.availableDays.modifierExtensionShort description 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.dayOfWeekShort description 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.startTimeShort description Start time DefinitionThe stat time for a period of opening
| |
endTime | 0..1 | time | Element idLogicalModel-HealthcareRegistry-HealthcareService.availability.availableDays.endTimeShort description End time DefinitionThe end time for a period of opening
| |
allDay | 0..1 | boolean | Element idLogicalModel-HealthcareRegistry-HealthcareService.availability.availableDays.allDayShort description Primitive Type boolean DefinitionA flag to denote the service is available for the whole day.
| |
nonAvailability | 0..* | BackboneElement | Element idLogicalModel-HealthcareRegistry-HealthcareService.availability.nonAvailabilityShort description Periods when there is no availability. DefinitionPeriods when there is no availability. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |
id | 0..1 | string | There are no (further) constraints on this element Element idLogicalModel-HealthcareRegistry-HealthcareService.availability.nonAvailability.idShort description 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 | C | 0..* | Extension | There are no (further) constraints on this element Element idLogicalModel-HealthcareRegistry-HealthcareService.availability.nonAvailability.extensionShort description 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 | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idLogicalModel-HealthcareRegistry-HealthcareService.availability.nonAvailability.modifierExtensionShort description 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.reasonShort description 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.periodStartShort description Start dateTime of non availability DefinitionStart dateTime of non availability
| |
periodEnd | 0..1 | dateTime | Element idLogicalModel-HealthcareRegistry-HealthcareService.availability.nonAvailability.periodEndShort description End dateTime of non availability DefinitionEnd dateTime of non availability
| |
availabilityException | 0..1 | string | Element idLogicalModel-HealthcareRegistry-HealthcareService.availability.availabilityExceptionShort description 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-LocationShort description Base for all elements DefinitionBase definition for all elements in a resource. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idLogicalModel-HealthcareRegistry-Location.idShort description 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 | C | 0..* | Extension | There are no (further) constraints on this element Element idLogicalModel-HealthcareRegistry-Location.extensionShort description 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.statusShort description Status DefinitionThe status of the location (note will need to align to Location Resource in due course) active | suspended | inactive
| |
operationalStatus | 1..1 | CodingBinding | Element idLogicalModel-HealthcareRegistry-Location.operationalStatusShort description 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) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |
name | 1..1 | string | Element idLogicalModel-HealthcareRegistry-Location.nameShort description 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.descriptionShort 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.typeShort description 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) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |
physicalType | 1..1 | CodingBinding | Element idLogicalModel-HealthcareRegistry-Location.physicalTypeShort description 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) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |
address | 0..1 | Address | Element idLogicalModel-HealthcareRegistry-Location.addressShort description 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). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |
zone | 1..1 | CodingBinding | Element idLogicalModel-HealthcareRegistry-Location.zoneShort description 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) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |
cluster | 1..1 | CodingBinding | Element idLogicalModel-HealthcareRegistry-Location.clusterShort description 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) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |
position | 0..1 | BackboneElement | Element idLogicalModel-HealthcareRegistry-Location.positionShort description The absolute geographic location DefinitionThe absolute geographic location The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |
id | 0..1 | string | There are no (further) constraints on this element Element idLogicalModel-HealthcareRegistry-Location.position.idShort description 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 | C | 0..* | Extension | There are no (further) constraints on this element Element idLogicalModel-HealthcareRegistry-Location.position.extensionShort description 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 | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idLogicalModel-HealthcareRegistry-Location.position.modifierExtensionShort description 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.longitudeShort description 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.latitudeShort description 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-OrganizationShort description Base for all elements DefinitionBase definition for all elements in a resource. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idLogicalModel-HealthcareRegistry-Organization.idShort description 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 | C | 0..* | Extension | There are no (further) constraints on this element Element idLogicalModel-HealthcareRegistry-Organization.extensionShort description 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.nameShort description 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.aliasShort description Alias names DefinitionOther names by which the organization is known. (e.g. NSH for Nova Scotia Health) .
|