3.47 StructureDefinition: Shared Health Organization - Provider Registry
The official URL for this profile is:
http://sharedhealth.exchange/fhir/StructureDefinition/profile-organization-tpr
3.47.2 Formal Views of Profile Content
Download Excel representation
Description of Profiles, Differentials, Snapshots and how the different presentations work.
>
This structure is derived from Shared Health Organization - Base
| Name | Card. | Type | Constraints and Usage |
|---|---|---|---|
 Organization | 0..* | org-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..1 | id | Definition: The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Comments: Conformance Rule: This is the full url returned in the Provider Registry Query response. Example: https://EnvironmentSpecificHost/EnvironmentAndContextSpecificPathRegistry/Organization/somepharmacy1CPRID Value = somepharmacy1CPRID |
| meta | 1..1 | 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. |
 tag | 1..* | Coding | Slice: Unordered, Open by value:system Binding: (unbound) (example) 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..1 | Coding | Binding: SharedSpecificationVersion (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..1 | uri | Fixed 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..1 | 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). |
| extension | 0..* | Extension | Slice: Unordered, Open by value:url Definition: An Extension |
| extension (service) | 0..* | Entity Service | Definition: 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..1 | Identifier | Definition: 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 CPR ID 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..1 | Shared Health CodeableConcept Code | Binding: SharedOrganizationType (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..1 | string | Max Length: 100 Definition: The name assigned to the service location. Comments: |
| telecom | 0..3 | Shared Health ContactPoint | cpt-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 electronic mail 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. Conformance Rule: This is mandatory because the phone number is part of the written prescription. System (binding value set) + value + use (binding value set) must be provided. Conformance Rule: Telecom structure is defined by Shared Health ContactPoint data type. There is a defined format to follow. Please refer to Shared Health Contact Point data type. |
| address | 0..20 | Shared Health Address | org-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: Conformance Rule: Address structure is defined by Shared Health Address data type. There are specific formats defined for string values as well as specific province and country codes to be used. Please refer to Shared Health Address data type profile. Conformance Rule: Though the cardinality is 1..20, EMR and PMS must only include a single instance of address. Note: in future releases this may change to 1..1 formally. |
| partOf | 0..1 | Reference(Organization) | Definition: The organization of which this organization forms a part. |
| display | 0..1 | string | Definition: 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: 10 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
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
 Organization | S | 0..* | ||
| meta | S | 1..1 | Meta | |
 tag | S | Coding | Slice: Unordered, Open by value:system | |
| tag | S | 1..1 | Coding | Binding: SharedSpecificationVersion (required) |
| system | S | 1..1 | uri | Fixed Value: https://fhir.infoway-inforoute.ca/CodeSystem/sharedspecificationversion |
| code | S | 1..1 | code | |
 extension | S | 0..* | Extension | Slice: Unordered, Open by value:url |
 ext-entity-service | S | 0..* | (Complex) | Entity Service URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-entity-service |
| name | S | 1..1 | string | |
| partOf | S | 0..1 | Reference(Organization) | |
| display | S | 0..1 | string | Parent Organization name |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Organization | SI | 0..* | Clinic, Pharmacy or clinic/pharmacy chain | |
 id | SΣ | 1..1 | id | Logical id of this artifact |
 meta | SΣ | 1..1 | Meta | Metadata about the resource |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| versionId | Σ | 0..1 | id | Version specific identifier |
| lastUpdated | Σ | 0..1 | instant | When the resource version last changed |
| profile | Σ | 0..* | uri | Profiles this resource claims to conform to |
| security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible) |
| tag | SΣ | Coding | Tags applied to this resource Slice: Unordered, Open by value:system Binding: (unbound) (example) | |
| tag | SΣ | 1..1 | Coding | Tags applied to this resource Binding: SharedSpecificationVersion (required) |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| system | SΣ | 1..1 | uri | Identity of the terminology system Fixed Value: https://fhir.infoway-inforoute.ca/CodeSystem/sharedspecificationversion |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | SΣ | 1..1 | code | Symbol in syntax defined by the system |
| display | Σ | 0..1 | string | Representation defined by the system |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: http://tools.ietf.org/html/bcp47 (required) | |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
 contained | 0..* | Resource | Contained, inline Resources | |
| extension | S | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
| ext-entity-service | S | 0..* | (Complex) | Entity Service URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-entity-service |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | SΣI | 1..1 | Identifier | Identifies this organization across multiple systems |
| active | ?!Σ | 0..1 | boolean | Whether the organization's record is still in active use |
| type | S | 0..1 | Shared Health CodeableConcept Code | Concept - reference to a terminology or just text Binding: SharedOrganizationType (required) |
| name | SΣI | 1..1 | string | Name used for the organization Max Length: 100 |
| telecom | SI | 0..3 | Shared Health ContactPoint | Details of a Technology mediated contact point (phone, fax, email, etc.) |
| address | SI | 0..20 | Shared Health Address | An address expressed using postal conventions (as opposed to GPS or other location definition formats) |
 partOf | SΣ | 0..1 | Reference(Organization) | The organization of which this organization forms a part |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| reference | ΣI | 0..1 | string | Relative, internal or absolute URL reference |
| display | SΣ | 0..1 | string | Parent Organization name |
| contact | 0..* | BackboneElement | Contact for the organization for a certain purpose | |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| purpose | 0..1 | CodeableConcept | The type of contact Binding: ContactEntityType (extensible) | |
| name | 0..1 | HumanName | A name associated with the contact | |
| telecom | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact | |
| address | 0..1 | Address | Visiting or postal addresses for the contact | |
| Documentation for this format | ||||
Grid View
This structure is derived from Shared Health Organization - Base
| Name | Card. | Type | Constraints and Usage |
|---|---|---|---|
| Organization | 0..* | org-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..1 | id | Definition: The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Comments: Conformance Rule: This is the full url returned in the Provider Registry Query response. Example: https://EnvironmentSpecificHost/EnvironmentAndContextSpecificPathRegistry/Organization/somepharmacy1CPRID Value = somepharmacy1CPRID |
| meta | 1..1 | 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. |
| tag | 1..* | Coding | Slice: Unordered, Open by value:system Binding: (unbound) (example) 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..1 | Coding | Binding: SharedSpecificationVersion (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..1 | uri | Fixed 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..1 | 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). |
| extension | 0..* | Extension | Slice: Unordered, Open by value:url Definition: An Extension |
| extension (service) | 0..* | Entity Service | Definition: 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..1 | Identifier | Definition: 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 CPR ID 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..1 | Shared Health CodeableConcept Code | Binding: SharedOrganizationType (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..1 | string | Max Length: 100 Definition: The name assigned to the service location. Comments: |
| telecom | 0..3 | Shared Health ContactPoint | cpt-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 electronic mail 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. Conformance Rule: This is mandatory because the phone number is part of the written prescription. System (binding value set) + value + use (binding value set) must be provided. Conformance Rule: Telecom structure is defined by Shared Health ContactPoint data type. There is a defined format to follow. Please refer to Shared Health Contact Point data type. |
| address | 0..20 | Shared Health Address | org-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: Conformance Rule: Address structure is defined by Shared Health Address data type. There are specific formats defined for string values as well as specific province and country codes to be used. Please refer to Shared Health Address data type profile. Conformance Rule: Though the cardinality is 1..20, EMR and PMS must only include a single instance of address. Note: in future releases this may change to 1..1 formally. |
| partOf | 0..1 | Reference(Organization) | Definition: The organization of which this organization forms a part. |
| display | 0..1 | string | Definition: 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: 10 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
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Organization | S | 0..* | ||
| meta | S | 1..1 | Meta | |
| tag | S | Coding | Slice: Unordered, Open by value:system | |
| tag | S | 1..1 | Coding | Binding: SharedSpecificationVersion (required) |
| system | S | 1..1 | uri | Fixed Value: https://fhir.infoway-inforoute.ca/CodeSystem/sharedspecificationversion |
| code | S | 1..1 | code | |
| extension | S | 0..* | Extension | Slice: Unordered, Open by value:url |
| ext-entity-service | S | 0..* | (Complex) | Entity Service URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-entity-service |
| name | S | 1..1 | string | |
| partOf | S | 0..1 | Reference(Organization) | |
| display | S | 0..1 | string | Parent Organization name |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Organization | SI | 0..* | Clinic, Pharmacy or clinic/pharmacy chain | |
| id | SΣ | 1..1 | id | Logical id of this artifact |
| meta | SΣ | 1..1 | Meta | Metadata about the resource |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| versionId | Σ | 0..1 | id | Version specific identifier |
| lastUpdated | Σ | 0..1 | instant | When the resource version last changed |
| profile | Σ | 0..* | uri | Profiles this resource claims to conform to |
| security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible) |
| tag | SΣ | Coding | Tags applied to this resource Slice: Unordered, Open by value:system Binding: (unbound) (example) | |
| tag | SΣ | 1..1 | Coding | Tags applied to this resource Binding: SharedSpecificationVersion (required) |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| system | SΣ | 1..1 | uri | Identity of the terminology system Fixed Value: https://fhir.infoway-inforoute.ca/CodeSystem/sharedspecificationversion |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | SΣ | 1..1 | code | Symbol in syntax defined by the system |
| display | Σ | 0..1 | string | Representation defined by the system |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: http://tools.ietf.org/html/bcp47 (required) | |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | S | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
| ext-entity-service | S | 0..* | (Complex) | Entity Service URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-entity-service |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | SΣI | 1..1 | Identifier | Identifies this organization across multiple systems |
| active | ?!Σ | 0..1 | boolean | Whether the organization's record is still in active use |
| type | S | 0..1 | Shared Health CodeableConcept Code | Concept - reference to a terminology or just text Binding: SharedOrganizationType (required) |
| name | SΣI | 1..1 | string | Name used for the organization Max Length: 100 |
| telecom | SI | 0..3 | Shared Health ContactPoint | Details of a Technology mediated contact point (phone, fax, email, etc.) |
| address | SI | 0..20 | Shared Health Address | An address expressed using postal conventions (as opposed to GPS or other location definition formats) |
| partOf | SΣ | 0..1 | Reference(Organization) | The organization of which this organization forms a part |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| reference | ΣI | 0..1 | string | Relative, internal or absolute URL reference |
| display | SΣ | 0..1 | string | Parent Organization name |
| contact | 0..* | BackboneElement | Contact for the organization for a certain purpose | |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| purpose | 0..1 | CodeableConcept | The type of contact Binding: ContactEntityType (extensible) | |
| name | 0..1 | HumanName | A name associated with the contact | |
| telecom | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact | |
| address | 0..1 | Address | Visiting or postal addresses for the contact | |
| Documentation for this format | ||||
Other representations of profile: Schematron
3.47.3 Terminology Bindings
Terminology Bindings
| Path | Name | Conformance | ValueSet |
| Organization.meta.security | All Security Labels | extensible | All Security Labels |
| Organization.meta.tag | SharedSpecificationVersion | required | SharedSpecificationVersion |
| Organization.meta.tag | SharedSpecificationVersion | required | SharedSpecificationVersion |
| Organization.language | ?ext | required | http://tools.ietf.org/html/bcp47 |
| Organization.type | SharedOrganizationType | required | SharedOrganizationType |
| Organization.contact.purpose | ContactEntityType | extensible | ContactEntityType |
3.47.4 Constraints
Constraints
| Id | Path | Details | Requirements |
| org-1 | Organization | The organization SHALL at least have a name or an id, and possibly more than one : identifier.exists() or name.exists() | |
| cpt-2 | Organization.telecom | A system is required if a value is provided. : value.empty() or system.exists() | |
| org-3 | Organization.telecom | The telecom of an organization can never be of use 'home' : where(use = 'home').empty() | |
| org-2 | Organization.address | An address of an organization can never be of use 'home' : where(use = 'home').empty() |