COFE-Provider-Organization-1
Organization | |
Definition |
A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, etc. |
Control | 0..* |
Type | Organization |
Comments | |
Organization.identifier(ODS Site Code) | |
Definition |
Identifier for the organization that is used to identify the organization across multiple disparate systems. |
Control | 0..1 ? |
Type | Identifier |
Requirements |
Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization. |
Comments | |
Organization.identifier.system | |
Definition |
Establishes the namespace in which set of possible id values is unique. |
Control | 1..1 |
Type | Uri |
Requirements |
There are many sequences of identifiers. To perform matching, we need to know what sequence we're dealing with. The system identifies a particular sequence or set of unique identifiers. |
Comments | |
Fixed Value | http://fhir.nhs.net/Id/ods-site-code |
Organization.identifier.value | |
Definition |
The portion of the identifier typically displayed to the user and which is unique within the context of the system. |
Control | 1..1 |
Type | String |
Comments |
If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. |
Example | BCS002 |
Organization.identifier(ODS Organization Code) | |
Definition |
Identifier for the organization that is used to identify the organization across multiple disparate systems. |
Control | 0..1 ? |
Type | Identifier |
Requirements |
Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization. |
Comments | |
Organization.identifier.system | |
Definition |
Establishes the namespace in which set of possible id values is unique. |
Control | 1..1 |
Type | Uri |
Requirements |
There are many sequences of identifiers. To perform matching, we need to know what sequence we're dealing with. The system identifies a particular sequence or set of unique identifiers. |
Comments | |
Fixed Value | http://fhir.nhs.net/Id/ods-site-code |
Organization.identifier.value | |
Definition |
The portion of the identifier typically displayed to the user and which is unique within the context of the system. |
Control | 1..1 |
Type | String |
Comments |
If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. |
Example | BCS002 |
Organization.type(standardindustryClassCode) | |
Definition |
The kind of organization that this is. |
Control | 1..1 |
Binding |
Used to categorize the organization For example codes, see http://fhir.nhs.net/ValueSet/cda-organization-provider-type-1 ; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
Requirements |
Need to be able to track the kind of organization that this is - different organization types have different uses. |
Comments |
Organizations can be corporations, wards, sections, clinical teams, government departments, etc. Note that code is generally a classifier of the type of organization; in many applications, codes are used to identity a particular organization (say, ward) as opposed to another of the same type - these are identifiers, not codes. |
Organization.type.coding | |
Definition |
A reference to a code defined by a terminology system. |
Control | 1..1 |
Binding |
A vocabulary that should be used to define the type of organization provider The codes SHALL be taken from http://fhir.nhs.net/ValueSet/cda-organization-provider-type-1 |
Type | Coding |
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 labelled as UserSelected = true. |
Organization.type.coding.system | |
Definition |
The identification of the code system that defines the meaning of the symbol in the code. |
Control | 1..1 |
Type | Uri |
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. |
Fixed Value | http://fhir.nhs.net/ValueSet/cda-organization-provider-type-1 |
Organization.type.coding.code | |
Definition |
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
Control | 1..1 |
Binding |
A vocabulary that should be used to define the type of organization provider. The codes SHALL be taken from http://fhir.nhs.net/ValueSet/cda-organization-provider-type-1 |
Type | Code |
Requirements |
Need to refer to a particular code in the system. |
Comments | |
Organization.type.coding.display | |
Definition |
A representation of the meaning of the code in the system, following the rules of the system. |
Control | 1..1 |
Type | String |
Requirements |
Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | |
Fixed Value | GP Practice |
Organization.name | |
Definition |
A name associated with the organization. |
Control | 1..1 ? |
Type | String |
Requirements |
Need to use the name as the label of the organization. |
Comments | |
Organization.telecom | |
Definition |
A contact detail for the organization. |
Control | 0..* ? |
Type | ContactPoint |
Requirements |
Human contact for the organization. |
Comments |
The use code home is not to be used. Note that these contacts are not the contact details of people who are employed by or represent the organization, but official contacts for the organization itself. |
Organization.telecom.system | |
Definition |
Telecommunications form for contact point - what communications system is required to make use of the contact. |
Control | 1..1 ? |
Binding |
Telecommunications form for contact point The codes SHALL be taken from http://hl7.org/fhir/ValueSet/contact-point-system |
Type | Code |
Comments | |
Example | phone |
Organization.telecom.value | |
Definition |
The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address). |
Control | 1..1 |
Type | String |
Requirements |
Need to support legacy numbers that are not in a tightly controlled format. |
Comments |
Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value. |
Example | 0191 4028507 |
Organization.telecom.use | |
Definition |
Identifies the purpose for the contact point. |
Control | 0..1 |
Binding |
Use of contact point The codes SHALL be taken from http://hl7.org/fhir/ValueSet/contact-point-use |
Type | Code |
Is Modifier | True |
Requirements |
Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose. |
Comments |
This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one. Applications can assume that a contact is current unless it explicitly says that it is temporary or old. |
Example | work |
Organization.telecom.period | |
Definition |
Time period when the contact point was/is in use. |
Control | 0..1 |
Type | Period |
Comments | |
Organization.telecom.period.start | |
Definition |
The start of the period. The boundary is inclusive. |
Control | 0..1 ? |
Type | DateTime |
Comments |
If the low element is missing, the meaning is that the low boundary is not known. |
Organization.telecom.period.end | |
Definition |
The end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. |
Control | 0..1 ? |
Type | DateTime |
Comments |
The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03. |
Organization.address | |
Definition |
An address for the organization. |
Control | 0..1 ? |
Type | Address |
Requirements |
May need to keep track of the organization's addresses for contacting, billing or reporting requirements. |
Comments |
Organization may have multiple addresses with different uses or applicable periods. The use code home is not to be used. |
Organization.address.use | |
Definition |
The purpose of this address. |
Control | 0..1 |
Binding |
The use of an address The codes SHALL be taken from http://hl7.org/fhir/ValueSet/address-use |
Type | Code |
Is Modifier | 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. |
Example | WP |
Organization.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. |
Control | 0..* |
Type | String |
Requirements |
home | work | temp | old - purpose of this address. |
Comments | |
Example | 1 Whitehall |
Organization.address.city | |
Definition |
The name of the city, town, village or other community or delivery center. |
Control | 0..1 |
Type | String |
Aliases | Municpality |
Comments | |
Example | Leeds |
Organization.address.district | |
Definition |
The name of the administrative area (county). |
Control | 0..1 |
Type | String |
Aliases | County |
Comments |
District is sometimes known as county, but in some regions 'county' in used in place of city (municipality), so county name should be conveyed in city instead. |
Example | West Yorkshire |
Organization.address.postalCode | |
Definition |
A postal code designating a region defined by the postal service. |
Control | 0..1 |
Type | String |
Aliases | Zip |
Comments | |
Example | LS1 1AA |
Organization.address.country | |
Definition |
Country - a nation as commonly understood or generally accepted. |
Control | 0..1 |
Type | String |
Comments |
ISO 3166 3 letter codes can be used in place of a full country name. |
Example | EN |
Organization.address.period | |
Definition |
Time period when address was/is in use. |
Control | 0..1 |
Type | Period |
Requirements |
Allows addresses to be placed in historical context. |
Comments | |
Example | Hl7.Fhir.Model.Period |
Organization.address.period.start | |
Definition |
The start of the period. The boundary is inclusive. |
Control | 0..1 ? |
Type | DateTime |
Comments |
If the low element is missing, the meaning is that the low boundary is not known. |
Organization.address.period.end | |
Definition |
The end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. |
Control | 0..1 ? |
Type | DateTime |
Comments |
The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03. |
Organization.partOf | |
Definition |
The organization of which this organization forms a part. |
Control | 0..1 |
Requirements |
Need to be able to track the hierarchy of organizations within an organization. |
Comments | |
Organization.partOf.reference | |
Definition |
A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
Control | 1..1 ? |
Type | String |
Comments |
Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
Organization.partOf.display | |
Definition |
Plain text narrative that identifies the resource in addition to the resource reference. |
Control | 0..1 |
Type | String |
Comments |
This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. |