Shared Health Specification and Guide Version 5.0

 

The official URL for this profile is:

http://sharedhealth.exchange/fhir/StructureDefinition/profile-organization-service-location

Download Excel representation

Description of Profiles, Differentials, Snapshots and how the different presentations work.

>

This structure is derived from Shared Health Organization - Base

NameCard.TypeConstraints and Usage
.  Organization 0..*Shared Health Organization - Baseorg-1: The organization SHALL at least have a name or an id, and possibly more than one
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.

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


Comments:
Conformance Rule: This must be the CPRID

..  identifier 1..1IdentifierDefinition:
Unique identifier for a healthcare service location


Comments:
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 SERVICE_LOCATION_ENTITY_ID in a response message.



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

..  type 0..1Shared Health CodeableConcept CodeBinding: SharedOrganizationType (20190415) (required)
Definition:
Describes the basic type or category of the service delivery location


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

..  name 1..1stringMax Length: 100
Definition:
The name assigned to the service location.


Comments:
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.

..  telecom 0..3Shared Health ContactPointcpt-2: A system is required if a value is provided.
org-3: The telecom of an organization can never be of use 'home'
Definition:
The phone numbers and/or email addresses by which a service location may be contacted.


Comments:
Conformance Rule: This is mandatory because the phone number is part of the written presciption.



Usage Note: This is used to specify the public Clinic or Pharmacy telephone number and/or a number of a private office number.

..  address 1..20Shared Health Addressorg-2: An address of an organization can never be of use 'home'
Definition:
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.


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

This structure is derived from Shared Health Organization - Base

Summary

Mandatory: 1 element
Must-Support: 1 element

This structure is derived from Shared Health Organization - Base

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization S0..*Shared Health Organization - BaseClinic, Pharmacy or clinic/pharmacy chain
... address S1..20Shared Health AddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization SI0..*Shared Health Organization - BaseClinic, Pharmacy or clinic/pharmacy chain
... id SΣ1..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: http://tools.ietf.org/html/bcp47 (required): A human language.


... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣI1..1IdentifierIdentifies this organization across multiple systems
... active ?!Σ0..1booleanWhether the organization's record is still in active use
... type S0..1Shared Health CodeableConcept CodeConcept - reference to a terminology or just text
Binding: SharedOrganizationType (20190415) (required)
... name SΣI1..1stringName used for the organization
Max Length: 100
... telecom SI0..3Shared Health ContactPointDetails of a Technology mediated contact point (phone, fax, email, etc.)
... address SI1..20Shared Health AddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... partOf Σ0..1Reference(Organization)The organization of which this organization forms a part
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... reference ΣI0..1stringRelative, internal or absolute URL reference
.... display Σ0..1stringText alternative for the resource
... contact 0..*BackboneElementContact for the organization for a certain purpose
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... purpose 0..1CodeableConceptThe type of contact
Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party

.... name 0..1HumanNameA name associated with the contact
.... telecom 0..*ContactPointContact details (telephone, email, etc.) for a contact
.... address 0..1AddressVisiting or postal addresses for the contact

doco Documentation for this format

Grid View

This structure is derived from Shared Health Organization - Base

NameCard.TypeConstraints and Usage
.  Organization 0..*Shared Health Organization - Baseorg-1: The organization SHALL at least have a name or an id, and possibly more than one
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.

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


Comments:
Conformance Rule: This must be the CPRID

..  identifier 1..1IdentifierDefinition:
Unique identifier for a healthcare service location


Comments:
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 SERVICE_LOCATION_ENTITY_ID in a response message.



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

..  type 0..1Shared Health CodeableConcept CodeBinding: SharedOrganizationType (20190415) (required)
Definition:
Describes the basic type or category of the service delivery location


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

..  name 1..1stringMax Length: 100
Definition:
The name assigned to the service location.


Comments:
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.

..  telecom 0..3Shared Health ContactPointcpt-2: A system is required if a value is provided.
org-3: The telecom of an organization can never be of use 'home'
Definition:
The phone numbers and/or email addresses by which a service location may be contacted.


Comments:
Conformance Rule: This is mandatory because the phone number is part of the written presciption.



Usage Note: This is used to specify the public Clinic or Pharmacy telephone number and/or a number of a private office number.

..  address 1..20Shared Health Addressorg-2: An address of an organization can never be of use 'home'
Definition:
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.


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

This structure is derived from Shared Health Organization - Base

Summary

Mandatory: 1 element
Must-Support: 1 element

Differential View

This structure is derived from Shared Health Organization - Base

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization S0..*Shared Health Organization - BaseClinic, Pharmacy or clinic/pharmacy chain
... address S1..20Shared Health AddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization SI0..*Shared Health Organization - BaseClinic, Pharmacy or clinic/pharmacy chain
... id SΣ1..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: http://tools.ietf.org/html/bcp47 (required): A human language.


... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣI1..1IdentifierIdentifies this organization across multiple systems
... active ?!Σ0..1booleanWhether the organization's record is still in active use
... type S0..1Shared Health CodeableConcept CodeConcept - reference to a terminology or just text
Binding: SharedOrganizationType (20190415) (required)
... name SΣI1..1stringName used for the organization
Max Length: 100
... telecom SI0..3Shared Health ContactPointDetails of a Technology mediated contact point (phone, fax, email, etc.)
... address SI1..20Shared Health AddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... partOf Σ0..1Reference(Organization)The organization of which this organization forms a part
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... reference ΣI0..1stringRelative, internal or absolute URL reference
.... display Σ0..1stringText alternative for the resource
... contact 0..*BackboneElementContact for the organization for a certain purpose
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... purpose 0..1CodeableConceptThe type of contact
Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party

.... name 0..1HumanNameA name associated with the contact
.... telecom 0..*ContactPointContact details (telephone, email, etc.) for a contact
.... address 0..1AddressVisiting or postal addresses for the contact

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

PathConformanceValueSet
Organization.languagerequiredhttp://tools.ietf.org/html/bcp47
Organization.typerequiredSharedOrganizationType
Organization.contact.purposeextensibleContactEntityType

Constraints

IdPathDetailsRequirements
org-1OrganizationThe organization SHALL at least have a name or an id, and possibly more than one
: identifier.exists() or name.exists()
cpt-2Organization.telecomA system is required if a value is provided.
: value.empty() or system.exists()
org-3Organization.telecomThe telecom of an organization can never be of use 'home'
: where(use = 'home').empty()
org-2Organization.addressAn address of an organization can never be of use 'home'
: where(use = 'home').empty()