Shared Health Specification and Guide Version 5.0

 

The official URL for this profile is:

http://sharedhealth.exchange/fhir/StructureDefinition/profile-organization-tpr

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

..  meta 1..1MetaDefinition:
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.

...  lastUpdated 0..1instantDefinition:
When the resource last changed - e.g. when the version changed.


Comments:
This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant.

...  tag 1..*CodingSlice: Unordered, Open by value:system
Binding: (unbound) (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


Definition:
Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.


Comments:
The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

...  tag
       (version)
1..1CodingBinding: SharedSpecificationVersion (20210501) (required)
Definition:
Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.


Comments:
The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

....  system 1..1uriFixed Value: https://fhir.infoway-inforoute.ca/CodeSystem/sharedspecificationversion
Definition:
The identification of the code system that defines the meaning of the symbol in the code.


Comments:
Fixed value: https://fhir.infoway-inforoute.ca/CodeSystem/sharedspecificationversion

....  code 1..1codeDefinition:
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).

..  extension 0..*ExtensionSlice: Unordered, Open by value:url
Definition:
An Extension

..  extension
     (service)
0..*Entity ServiceDefinition:
Identifies a electronic communication service offered by a service location or practitioner


Comments:
Entity Service is used at this level, when the service registration requires participation at both the Organization level and the Practitioner level. Both levels must be validated to confirm the outcome.



This is returned in the response when the service is determined to be active. It will be absent from the response when the service is no longer active.

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


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

..  partOf 0..1Reference(Organization)Definition:
The organization of which this organization forms a part.

...  reference 0..1stringDefinition:
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.


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.

...  display 0..1stringDefinition:
Plain text narrative that identifies the resource in addition to the resource reference.


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

This structure is derived from Shared Health Organization - Base

Summary

Mandatory: 5 elements
Must-Support: 12 elements
Fixed Value: 1 element

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Organization.meta.tag is sliced based on the value of value:system

This structure is derived from Shared Health Organization - Base

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization S0..*Shared Health Organization - BaseClinic, Pharmacy or clinic/pharmacy chain
... meta S1..1MetaMetadata about the resource
.... lastUpdated S0..1instantWhen the resource version last changed
.... tag S1..*(Slice Definition)Tags applied to this resource
Slice: Unordered, Open by value:system
..... tag:version S1..1CodingTags applied to this resource
Binding: SharedSpecificationVersion (20210501) (required)
...... system S1..1uriIdentity of the terminology system
Fixed Value: https://fhir.infoway-inforoute.ca/CodeSystem/sharedspecificationversion
...... code S1..1codeSymbol in syntax defined by the system
... extension S0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ext-entity-service S0..*(Complex)Entity Service
URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-entity-service
... name S1..1stringName used for the organization
... partOf S0..1Reference(Organization)The organization of which this organization forms a part
.... reference S0..1stringRelative, internal or absolute URL reference
.... display S0..1stringParent Organization name

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 SΣ1..1MetaMetadata about the resource
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated SΣ0..1instantWhen the resource version last changed
.... profile Σ0..*uriProfiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag SΣ1..*(Slice Definition)Tags applied to this resource
Slice: Unordered, Open by value:system
Binding: (unbound) (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


..... tag:version SΣ1..1CodingTags applied to this resource
Binding: SharedSpecificationVersion (20210501) (required)
...... id 0..1idxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
...... system SΣ1..1uriIdentity of the terminology system
Fixed Value: https://fhir.infoway-inforoute.ca/CodeSystem/sharedspecificationversion
...... version Σ0..1stringVersion of the system - if relevant
...... code SΣ1..1codeSymbol in syntax defined by the system
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
... 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 S0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ext-entity-service S0..*(Complex)Entity Service
URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-entity-service
... 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 SI0..20Shared Health AddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... partOf SΣ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 SΣI0..1stringRelative, internal or absolute URL reference
.... display SΣ0..1stringParent Organization name
... 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

..  meta 1..1MetaDefinition:
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.

...  lastUpdated 0..1instantDefinition:
When the resource last changed - e.g. when the version changed.


Comments:
This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant.

...  tag 1..*CodingSlice: Unordered, Open by value:system
Binding: (unbound) (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


Definition:
Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.


Comments:
The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

...  tag
       (version)
1..1CodingBinding: SharedSpecificationVersion (20210501) (required)
Definition:
Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.


Comments:
The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

....  system 1..1uriFixed Value: https://fhir.infoway-inforoute.ca/CodeSystem/sharedspecificationversion
Definition:
The identification of the code system that defines the meaning of the symbol in the code.


Comments:
Fixed value: https://fhir.infoway-inforoute.ca/CodeSystem/sharedspecificationversion

....  code 1..1codeDefinition:
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).

..  extension 0..*ExtensionSlice: Unordered, Open by value:url
Definition:
An Extension

..  extension
     (service)
0..*Entity ServiceDefinition:
Identifies a electronic communication service offered by a service location or practitioner


Comments:
Entity Service is used at this level, when the service registration requires participation at both the Organization level and the Practitioner level. Both levels must be validated to confirm the outcome.



This is returned in the response when the service is determined to be active. It will be absent from the response when the service is no longer active.

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


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

..  partOf 0..1Reference(Organization)Definition:
The organization of which this organization forms a part.

...  reference 0..1stringDefinition:
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.


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.

...  display 0..1stringDefinition:
Plain text narrative that identifies the resource in addition to the resource reference.


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

This structure is derived from Shared Health Organization - Base

Summary

Mandatory: 5 elements
Must-Support: 12 elements
Fixed Value: 1 element

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Organization.meta.tag is sliced based on the value of value:system

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
... meta S1..1MetaMetadata about the resource
.... lastUpdated S0..1instantWhen the resource version last changed
.... tag S1..*(Slice Definition)Tags applied to this resource
Slice: Unordered, Open by value:system
..... tag:version S1..1CodingTags applied to this resource
Binding: SharedSpecificationVersion (20210501) (required)
...... system S1..1uriIdentity of the terminology system
Fixed Value: https://fhir.infoway-inforoute.ca/CodeSystem/sharedspecificationversion
...... code S1..1codeSymbol in syntax defined by the system
... extension S0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ext-entity-service S0..*(Complex)Entity Service
URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-entity-service
... name S1..1stringName used for the organization
... partOf S0..1Reference(Organization)The organization of which this organization forms a part
.... reference S0..1stringRelative, internal or absolute URL reference
.... display S0..1stringParent Organization name

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 SΣ1..1MetaMetadata about the resource
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated SΣ0..1instantWhen the resource version last changed
.... profile Σ0..*uriProfiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag SΣ1..*(Slice Definition)Tags applied to this resource
Slice: Unordered, Open by value:system
Binding: (unbound) (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


..... tag:version SΣ1..1CodingTags applied to this resource
Binding: SharedSpecificationVersion (20210501) (required)
...... id 0..1idxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
...... system SΣ1..1uriIdentity of the terminology system
Fixed Value: https://fhir.infoway-inforoute.ca/CodeSystem/sharedspecificationversion
...... version Σ0..1stringVersion of the system - if relevant
...... code SΣ1..1codeSymbol in syntax defined by the system
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
... 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 S0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ext-entity-service S0..*(Complex)Entity Service
URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-entity-service
... 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 SI0..20Shared Health AddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... partOf SΣ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 SΣI0..1stringRelative, internal or absolute URL reference
.... display SΣ0..1stringParent Organization name
... 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.meta.securityextensibleAll Security Labels
Organization.meta.tagexample
Organization.meta.tag:versionrequiredSharedSpecificationVersion
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()