Profile: CareConnect-GPC-Location-1
Location | I | Location | |
identifier | Σ | 0..* | Identifier |
odsSiteCode | Σ | 0..1 | Identifier |
use | Σ ?! | 0..0 | codeBinding |
type | Σ | 0..0 | CodeableConceptBinding |
system | Σ | 1..1 | uriFixed Value |
value | Σ | 1..1 | string |
period | Σ I | 0..0 | Period |
assigner | Σ I | 0..0 | Reference(Organization) |
status | Σ ?! | 0..1 | codeBinding |
operationalStatus | Σ | 0..1 | CodingBinding |
name | S Σ | 0..1 | string |
alias | 0..* | string | |
description | Σ | 0..1 | string |
mode | Σ ?! | 0..0 | codeBinding |
type | Σ | 0..1 | CodeableConceptBinding |
telecom | S I | 0..* | ContactPoint |
address | S | 0..1 | Address |
use | Σ ?! | 0..1 | codeBinding |
type | Σ | 0..1 | codeBinding |
text | Σ | 0..1 | string |
line | Σ | 0..* | string |
city | Σ | 0..1 | string |
district | Σ | 0..1 | string |
state | Σ | 0..0 | string |
postalCode | Σ | 0..1 | string |
country | Σ | 0..1 | string |
period | Σ I | 0..1 | Period |
physicalType | Σ | 0..1 | CodeableConcept |
coding | Σ | 0..* | Coding |
snomedCT | Σ | 0..* | Coding |
system | Σ | 1..1 | uriFixed Value |
version | Σ | 0..0 | string |
code | Σ | 1..1 | code |
display | Σ | 1..1 | string |
userSelected | Σ | 0..0 | boolean |
readV2 | Σ | 0..* | Coding |
system | Σ | 1..1 | uriFixed Value |
version | Σ | 0..0 | string |
code | Σ | 1..1 | code |
display | Σ | 1..1 | string |
userSelected | Σ | 0..0 | boolean |
readCTV3 | Σ | 0..* | Coding |
system | Σ | 1..1 | uriFixed Value |
version | Σ | 0..0 | string |
code | Σ | 1..1 | code |
display | Σ | 1..1 | string |
userSelected | Σ | 0..0 | boolean |
text | Σ | 0..1 | string |
position | 0..1 | BackboneElement | |
longitude | 1..1 | decimal | |
latitude | 1..1 | decimal | |
altitude | 0..1 | decimal | |
managingOrganization | S Σ I | 0..1 | Reference(CareConnect-GPC-Organization-1) |
partOf | I | 0..1 | Reference(CareConnect-GPC-Location-1) |
endpoint | I | 0..* | Reference(Endpoint) |
Location | |
Definition | Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained or accommodated. |
Cardinality | 0...* |
Invariants |
|
Mappings |
|
Location.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Cardinality | 0...1 |
Type | id |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Location.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. |
Cardinality | 0...1 |
Type | Meta |
Summary | True |
Invariants |
|
Mappings |
|
Location.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. |
Cardinality | 0...1 |
Type | uri |
Modifier | True |
Summary | True |
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. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation. |
Invariants |
|
Mappings |
|
Location.language | |
Definition | The base language in which the resource is written. |
Cardinality | 0...1 |
Type | code |
Binding | A human language. Common Languages (extensible) |
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). |
Invariants |
|
Mappings |
|
Location.text | |
Definition | A human-readable narrative that contains a summary of the resource, and may 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. |
Cardinality | 0...1 |
Type | Narrative |
Alias | narrative, html, xhtml, display |
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 in formation is added later. |
Invariants |
|
Mappings |
|
Location.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. |
Cardinality | 0...* |
Type | Resource |
Alias | inline resources, anonymous resources, contained 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. |
Mappings |
|
Location.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource. In order 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Location.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. Usually modifier elements provide negation or qualification. In order 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. |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Location.identifier | |
Definition | Unique code or number identifying the location to its users. |
Cardinality | 0...* |
Type | Identifier |
Summary | True |
Requirements | Organization label locations in registries, need to keep track of those. |
Slicing | Unordered, Open At End, by system(Value) |
Invariants |
|
Mappings |
|
Location.identifier:odsSiteCode | |
Definition | ODS Site code to identify the organisation at site level. |
Cardinality | 0...1 |
Type | Identifier |
Summary | True |
Requirements | Organization label locations in registries, need to keep track of those. |
Invariants |
|
Mappings |
|
Location.identifier:odsSiteCode.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Comments | Note that FHIR strings may not exceed 1MB in size |
Invariants |
|
Mappings |
|
Location.identifier:odsSiteCode.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Location.identifier:odsSiteCode.use | |
Definition | The purpose of this identifier. |
Cardinality | 0...0 |
Type | code |
Binding | Identifies the purpose for this identifier, if known . IdentifierUse (required) |
Modifier | True |
Summary | True |
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
Comments | This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
Invariants |
|
Mappings |
|
Location.identifier:odsSiteCode.type | |
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
Cardinality | 0...0 |
Type | CodeableConcept |
Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible) |
Summary | True |
Requirements | Allows users to make use of identifiers when the identifier system is not known. |
Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. |
Invariants |
|
Mappings |
|
Location.identifier:odsSiteCode.system | |
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. |
Cardinality | 1...1 |
Type | uri |
Summary | True |
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. |
Comments | see http://en.wikipedia.org/wiki/Uniform_resource_identifier |
Invariants |
|
Fixed Value | https://fhir.nhs.uk/Id/ods-site-code |
Mappings |
|
Location.identifier:odsSiteCode.value | |
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
Cardinality | 1...1 |
Type | string |
Summary | True |
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. |
Invariants |
|
Examples | General 123456 |
Mappings |
|
Location.identifier:odsSiteCode.period | |
Definition | Time period during which identifier is/was valid for use. |
Cardinality | 0...0 |
Type | Period |
Summary | True |
Comments | This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). If duration is required, specify the type as Interval|Duration. |
Invariants |
|
Mappings |
|
Location.identifier:odsSiteCode.assigner | |
Definition | Organization that issued/manages the identifier. |
Cardinality | 0...0 |
Type | Reference(Organization) |
Summary | True |
Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. |
Invariants |
|
Mappings |
|
Location.status | |
Definition | The status property covers the general availability of the resource, not the current value which may be covered by the operationStatus, or by a schedule/slots if they are configured for the location. |
Cardinality | 0...1 |
Type | code |
Binding | Indicates whether the location is still in use. LocationStatus (required) |
Modifier | True |
Summary | True |
Comments | This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. |
Invariants |
|
Mappings |
|
Location.operationalStatus | |
Definition | The Operational status covers operation values most relevant to beds (but can also apply to rooms/units/chair/etc such as an isolation unit/dialisys chair). This typically covers concepts such as contamination, housekeeping and other activities like maintenance. |
Cardinality | 0...1 |
Type | Coding |
Binding | The operational status if the location (where typically a bed/room) v2 Bed Status (preferred) |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Location.name | |
Definition | Name of the location as used by humans. Does not need to be unique. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Comments | If the name of an location changes, consider putting the old name in the alias column so that it can still be located through searches. |
Invariants |
|
Mappings |
|
Location.alias | |
Definition | A list of alternate names that the location is known as, or was known as in the past. |
Cardinality | 0...* |
Type | string |
Requirements | Over time locations and organizations go through many changes and can be known by different names. For searching knowing previous names that the location was known by can be very useful. |
Comments | There are no dates associated with the alias/historic names, as this is not intended to track when names were used, but to assist in searching so that older names can still result in identifying the location. |
Invariants |
|
Mappings |
|
Location.description | |
Definition | Description of the Location, which helps in finding or referencing the place. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | Humans need additional information to verify a correct location has been identified. |
Comments | Note that FHIR strings may not exceed 1MB in size |
Invariants |
|
Mappings |
|
Location.mode | |
Definition | Indicates whether a resource instance represents a specific location or a class of locations. |
Cardinality | 0...0 |
Type | code |
Binding | Indicates whether a resource instance represents a specific location or a class of locations. LocationMode (required) |
Modifier | True |
Summary | True |
Requirements | When using a Location resource for scheduling or orders, we need to be able to refer to a class of Locations instead of a specific Location. |
Comments | This is labeled as a modifer because whether or not the location is a class of locations changes how it can be used and understood. |
Invariants |
|
Mappings |
|
Location.type | |
Definition | Indicates the type of function performed at the location. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | Indicates the type of function performed at the location. ServiceDeliveryLocationRoleType (extensible) |
Summary | True |
Comments | 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. |
Invariants |
|
Mappings |
|
Location.telecom | |
Definition | The contact details of communication devices available at the location. This can include phone numbers, fax numbers, mobile numbers, email addresses and web sites. |
Cardinality | 0...* |
Type | ContactPoint |
Must Support | True |
Invariants |
|
Mappings |
|
Location.address | |
Definition | Physical location. |
Cardinality | 0...1 |
Type | Address |
Must Support | True |
Requirements | If locations can be visited, we need to keep track of their address. |
Comments | This was kept as 0..1 as there is no use property on the address, so wouldn't be able to identify different address types. |
Invariants |
|
Mappings |
|
Location.address.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Comments | Note that FHIR strings may not exceed 1MB in size |
Invariants |
|
Mappings |
|
Location.address.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Location.address.use | |
Definition | The purpose of this address. |
Cardinality | 0...1 |
Type | code |
Binding | The use of an address AddressUse (required) |
Modifier | True |
Summary | True |
Requirements | Allows an appropriate address to be chosen from a list of many. |
Comments | This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one. Applications can assume that an address is current unless it explicitly says that it is temporary or old. |
Invariants |
|
Examples | General home |
Mappings |
|
Location.address.type | |
Definition | Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both. |
Cardinality | 0...1 |
Type | code |
Binding | The type of an address (physical / postal) AddressType (required) |
Summary | True |
Comments | Note that FHIR strings may not exceed 1MB in size |
Invariants |
|
Examples | General both |
Mappings |
|
Location.address.text | |
Definition | A full text representation of the address. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | A renderable, unencoded form. |
Comments | Can provide both a text representation and parts. |
Invariants |
|
Examples | General 137 Nowhere Street, Erewhon 9132 |
Mappings |
|
Location.address.line | |
Definition | This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information. |
Cardinality | 0...* |
Type | string |
Summary | True |
Requirements | home | work | temp | old - purpose of this address. |
Comments | Note that FHIR strings may not exceed 1MB in size |
Invariants |
|
Examples | General 137 Nowhere Street |
Mappings |
|
Location.address.city | |
Definition | The name of the city, town, village or other community or delivery center. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Alias | Municpality |
Comments | Note that FHIR strings may not exceed 1MB in size |
Invariants |
|
Examples | General Erewhon |
Mappings |
|
Location.address.district | |
Definition | The name of the administrative area (county). |
Cardinality | 0...1 |
Type | string |
Summary | True |
Alias | County |
Comments | District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead. |
Invariants |
|
Examples | General Madison |
Mappings |
|
Location.address.state | |
Definition | Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (i.e. US 2 letter state codes). |
Cardinality | 0...0 |
Type | string |
Summary | True |
Alias | Province, Territory |
Comments | Note that FHIR strings may not exceed 1MB in size |
Invariants |
|
Mappings |
|
Location.address.postalCode | |
Definition | A postal code designating a region defined by the postal service. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Alias | Zip |
Comments | Note that FHIR strings may not exceed 1MB in size |
Invariants |
|
Examples | General 9132 |
Mappings |
|
Location.address.country | |
Definition | Country - a nation as commonly understood or generally accepted. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | ISO 3166 3 letter codes can be used in place of a full country name. |
Invariants |
|
Mappings |
|
Location.address.period | |
Definition | Time period when address was/is in use. |
Cardinality | 0...1 |
Type | Period |
Summary | True |
Requirements | Allows addresses to be placed in historical context. |
Comments | This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). If duration is required, specify the type as Interval|Duration. |
Invariants |
|
Examples | General { "start": "2010-03-23", "end": "2010-07-01" } |
Mappings |
|
Location.physicalType | |
Definition | Physical form of the location, e.g. building, room, vehicle, road. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | Physical form of the location LocationType (example) |
Summary | True |
Requirements | For purposes of showing relevant locations in queries, we need to categorize locations. |
Comments | 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. |
Invariants |
|
Mappings |
|
Location.physicalType.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Comments | Note that FHIR strings may not exceed 1MB in size |
Invariants |
|
Mappings |
|
Location.physicalType.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Location.physicalType.coding | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...* |
Type | Coding |
Summary | True |
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. |
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. |
Slicing | Ordered, Closed, by system(Value) |
Invariants |
|
Mappings |
|
Location.physicalType.coding:snomedCT | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...* |
Type | Coding |
Summary | True |
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. |
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. |
Invariants |
|
Mappings |
|
Location.physicalType.coding:snomedCT.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Comments | Note that FHIR strings may not exceed 1MB in size |
Invariants |
|
Mappings |
|
Location.physicalType.coding:snomedCT.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Location.physicalType.coding:snomedCT.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
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 de-reference to some definition that establish the system clearly and unambiguously. |
Invariants |
|
Fixed Value | http://snomed.info/sct |
Mappings |
|
Location.physicalType.coding:snomedCT.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. |
Cardinality | 0...0 |
Type | string |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Location.physicalType.coding:snomedCT.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). |
Cardinality | 1...1 |
Type | code |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings may not exceed 1MB in size |
Invariants |
|
Mappings |
|
Location.physicalType.coding:snomedCT.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 1...1 |
Type | string |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | Note that FHIR strings may not exceed 1MB in size |
Invariants |
|
Mappings |
|
Location.physicalType.coding:snomedCT.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). |
Cardinality | 0...0 |
Type | boolean |
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. |
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. |
Invariants |
|
Mappings |
|
Location.physicalType.coding:readV2 | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...* |
Type | Coding |
Summary | True |
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. |
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. |
Invariants |
|
Mappings |
|
Location.physicalType.coding:readV2.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Comments | Note that FHIR strings may not exceed 1MB in size |
Invariants |
|
Mappings |
|
Location.physicalType.coding:readV2.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Location.physicalType.coding:readV2.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
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 de-reference to some definition that establish the system clearly and unambiguously. |
Invariants |
|
Fixed Value | http://read.info/readv2 |
Mappings |
|
Location.physicalType.coding:readV2.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. |
Cardinality | 0...0 |
Type | string |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Location.physicalType.coding:readV2.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). |
Cardinality | 1...1 |
Type | code |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings may not exceed 1MB in size |
Invariants |
|
Mappings |
|
Location.physicalType.coding:readV2.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 1...1 |
Type | string |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | Note that FHIR strings may not exceed 1MB in size |
Invariants |
|
Mappings |
|
Location.physicalType.coding:readV2.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). |
Cardinality | 0...0 |
Type | boolean |
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. |
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. |
Invariants |
|
Mappings |
|
Location.physicalType.coding:readCTV3 | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...* |
Type | Coding |
Summary | True |
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. |
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. |
Invariants |
|
Mappings |
|
Location.physicalType.coding:readCTV3.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Comments | Note that FHIR strings may not exceed 1MB in size |
Invariants |
|
Mappings |
|
Location.physicalType.coding:readCTV3.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Location.physicalType.coding:readCTV3.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
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 de-reference to some definition that establish the system clearly and unambiguously. |
Invariants |
|
Fixed Value | http://read.info/ctv3 |
Mappings |
|
Location.physicalType.coding:readCTV3.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. |
Cardinality | 0...0 |
Type | string |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Location.physicalType.coding:readCTV3.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). |
Cardinality | 1...1 |
Type | code |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings may not exceed 1MB in size |
Invariants |
|
Mappings |
|
Location.physicalType.coding:readCTV3.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 1...1 |
Type | string |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | Note that FHIR strings may not exceed 1MB in size |
Invariants |
|
Mappings |
|
Location.physicalType.coding:readCTV3.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). |
Cardinality | 0...0 |
Type | boolean |
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. |
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. |
Invariants |
|
Mappings |
|
Location.physicalType.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. |
Cardinality | 0...1 |
Type | string |
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. |
Comments | Very often the text is the same as a displayName of one of the codings. |
Invariants |
|
Mappings |
|
Location.position | |
Definition | The absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML). |
Cardinality | 0...1 |
Type | BackboneElement |
Requirements | For mobile applications and automated route-finding knowing the exact location of the Location is required. |
Invariants |
|
Mappings |
|
Location.position.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Comments | Note that FHIR strings may not exceed 1MB in size |
Invariants |
|
Mappings |
|
Location.position.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Location.position.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order 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. |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
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. |
Invariants |
|
Mappings |
|
Location.position.longitude | |
Definition | Longitude. The value domain and the interpretation are the same as for the text of the longitude element in KML (see notes below). |
Cardinality | 1...1 |
Type | decimal |
Comments | Do not use a IEEE type floating point type, instead use something that works like a true decimal, with inbuilt precision (e.g. Java BigInteger) |
Invariants |
|
Mappings |
|
Location.position.latitude | |
Definition | Latitude. The value domain and the interpretation are the same as for the text of the latitude element in KML (see notes below). |
Cardinality | 1...1 |
Type | decimal |
Comments | Do not use a IEEE type floating point type, instead use something that works like a true decimal, with inbuilt precision (e.g. Java BigInteger) |
Invariants |
|
Mappings |
|
Location.position.altitude | |
Definition | Altitude. The value domain and the interpretation are the same as for the text of the altitude element in KML (see notes below). |
Cardinality | 0...1 |
Type | decimal |
Comments | Do not use a IEEE type floating point type, instead use something that works like a true decimal, with inbuilt precision (e.g. Java BigInteger) |
Invariants |
|
Mappings |
|
Location.managingOrganization | |
Definition | The organization responsible for the provisioning and upkeep of the location. |
Cardinality | 0...1 |
Type | Reference(CareConnect-GPC-Organization-1) |
Must Support | True |
Summary | True |
Requirements | Need to know who manages the location. |
Comments | This can also be used as the part of the organization hierarchy where this location provides services. These services can be defined through the HealthcareService resource. |
Invariants |
|
Mappings |
|
Location.partOf | |
Definition | Another Location which this Location is physically part of. |
Cardinality | 0...1 |
Type | Reference(CareConnect-GPC-Location-1) |
Requirements | For purposes of location, display and identification, knowing which locations are located within other locations is important. |
Comments | 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. |
Invariants |
|
Mappings |
|
Location.endpoint | |
Definition | Technical endpoints providing access to services operated for the location. |
Cardinality | 0...* |
Type | Reference(Endpoint) |
Requirements | Organizations may have different systems at different locations that provide various services and need to be able to define the technical connection details for how to connect to them, and for what purpose. |
Comments | 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. |
Invariants |
|
Mappings |
|