Shared Health Specification and Guide Version 5.0

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.

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Conformance Rule: This must be the CPRID

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.

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.

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 as much as possible.

The base language in which the resource is written.

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).

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.

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.

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.

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.

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.

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.

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.

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.

Unique identifier for a healthcare service location

Allows for lookup and retrieval of detailed information about a specific service location. Also ensures unique identification of service location and is therefore mandatory.The identifier is mandatory because it is the principal mechanism for uniquely identifying the facility.

Usage Note: This will convey the Organization ID (Clinic or Pharmacy) as assigned by the Shared Health Provider Registration service. This is known as the CPRID and will be provided to each successfully registered Clinic or Pharmacy and can be stored in the local system.

Conformance Rule: The receiving system must use this field and insert as the"Receiver SERVICELOCATIONENTITY_ID in a response message.

Usage Note: It has a one to one mapping to each SENDINGAPPLICATIONINSTANCEID. This is also used by the Central Service to discover the application instance ID when routing the response message.hl7 MAPPING: SERVICELOCATION_IDENTIFIER

Whether the organization's record is still in active use.

Need a flag to indicate a record is no longer to be used and should generally be hidden for the user in the UI.

Default is true.

Describes the basic type or category of the service delivery location

Useful in providing context. May also be used for grouping and organizing data. Because this is a key element in understanding the location, it is mandatory.

Distinguishes clinics from pharmacies. Binding value set. (PROFF - Provider's Office, OUTPHARM - outpatient pharmacy)

The name assigned to the service location.

Used for human communication, and for cross-checking of location Id and is therefore mandatory

Conformance Rule: This may include the Pharmacy or Clinic name as known to the Vendor. As this is a string data type, reminder to structure for readability and presentation.

Usage Note: This is NOT available from the Provider Registry.

The phone numbers and/or email addresses by which a service location may be contacted.

Human contact for the organization.

Usage Note: When sending the organization data for the clinic or the pharmacy the phone/fax number should be provided if known.

An 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 and which might not be valid for mail delivery. There are a variety of postal address formats defined around the world.

May need to keep track of the organization's addresses for contacting, billing or reporting requirements.

In the context of the Provider Registry query, the address will be returned most of the time; however, this is currently optional in the Provider Query Response. As such, vendors MUST populate the Clinic or Pharmacy address from a local data store when the Provider Registry query does not return an address. For eFax generation, as EMRs do not always have full and accurate address, the solution will query our Registry and provide the address information from that source.

Conformance Rule: In the context of Interactions 101, 201, 305, 401, and 903 only one address is to be provided. (cardinality will be re-visited in a future release of the specification).

​Conformance Rule: In the context of declaring the Organization address as the sender (MessageHeader.source), Address.state must be included. NOTE: code must align with Binding: CanadianJurisdiction (20170626) (required)

​Conformance Rule: In the context of declaring a Patient Canadian address, Address.state must be included, if available. NOTE: code must align with Binding: CanadianJurisdiction (20170626) (required)

The organization of which this organization forms a part.

Need to be able to track the hierarchy of organizations within an organization.

unique id for the element within a resource (for internal references).

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.

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.

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.

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.

Plain text narrative that identifies the resource in addition to the resource reference.

Usage Note: If present in the Provider Registry query response, it may be populated here.

Contact for the organization for a certain purpose.

Need to keep track of assigned contact points within bigger organization.

Where multiple contacts for the same purpose are provided there is a standard extension that can be used to determine which one is the preferred contact to use.

unique id for the element within a resource (for internal references).

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.

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.

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.

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.

Indicates a purpose for which the contact can be reached.

Need to distinguish between multiple contact persons.

A name associated with the contact.

Need to be able to track the person by name.

A contact detail (e.g. a telephone number or an email address) by which the party may be contacted.

People have (primary) ways to contact them in some way such as phone, email.

Visiting or postal addresses for the contact.

May need to keep track of a contact party's address for contacting, billing or reporting requirements.