3.68 StructureDefinition: Shared Health Organization - Base
The official URL for this profile is:
http://sharedhealth.exchange/fhir/StructureDefinition/profile-organization
3.68.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 Organization
| Name | Card. | Type | Constraints and Usage |
|---|---|---|---|
 Organization | 0..* | Organization | 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 must be the CPRID |
| 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 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..1 | Shared Health CodeableConcept Code | Binding: 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..1 | string | Max 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..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 email addresses by which a service location may be contacted. Comments: Usage Note: When sending the organization data for the clinic or the pharmacy the phone/fax number should be provided if known. |
 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: 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) |
This structure is derived from Organization
This structure is derived from Organization
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
 Organization | S | 0..* | Organization | Clinic, Pharmacy or clinic/pharmacy chain |
 id | S | 1..1 | id | Logical id of this artifact |
| identifier | S | 1..1 | Identifier | Identifies this organization across multiple systems |
 type | S | 0..1 | Shared Health CodeableConcept Code | Concept - reference to a terminology or just text Binding: SharedOrganizationType (20190415) (required) |
| name | S | 1..1 | string | Name used for the organization Max Length: 100 |
| telecom | S | 0..3 | Shared Health ContactPoint | Details of a Technology mediated contact point (phone, fax, email, etc.) |
| address | S | 0..20 | Shared Health Address | An address expressed using postal conventions (as opposed to GPS or other location definition formats) |
| partOf | 0..1 | Reference(Organization) | The organization of which this organization forms a part | |
 display | 0..1 | string | Text alternative for the resource | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Organization | SI | 0..* | Organization | Clinic, Pharmacy or clinic/pharmacy chain |
 id | SΣ | 1..1 | id | Logical id of this artifact |
| meta | Σ | 0..1 | Meta | Metadata about the resource |
| 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): A human language. | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | |
 extension | 0..* | Extension | Additional Content defined by implementations | |
 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 (20190415) (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 | Σ | 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 | Σ | 0..1 | string | Text alternative for the resource |
| 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): The purpose for which you would contact a contact party | |
| 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 Organization
| Name | Card. | Type | Constraints and Usage |
|---|---|---|---|
| Organization | 0..* | Organization | 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 must be the CPRID |
| 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 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..1 | Shared Health CodeableConcept Code | Binding: 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..1 | string | Max 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..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 email addresses by which a service location may be contacted. Comments: Usage Note: When sending the organization data for the clinic or the pharmacy the phone/fax number should be provided if known. |
| 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: 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) |
This structure is derived from Organization
Differential View
This structure is derived from Organization
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Organization | S | 0..* | Organization | Clinic, Pharmacy or clinic/pharmacy chain |
| id | S | 1..1 | id | Logical id of this artifact |
| identifier | S | 1..1 | Identifier | Identifies this organization across multiple systems |
| type | S | 0..1 | Shared Health CodeableConcept Code | Concept - reference to a terminology or just text Binding: SharedOrganizationType (20190415) (required) |
| name | S | 1..1 | string | Name used for the organization Max Length: 100 |
| telecom | S | 0..3 | Shared Health ContactPoint | Details of a Technology mediated contact point (phone, fax, email, etc.) |
| address | S | 0..20 | Shared Health Address | An address expressed using postal conventions (as opposed to GPS or other location definition formats) |
| partOf | 0..1 | Reference(Organization) | The organization of which this organization forms a part | |
| display | 0..1 | string | Text alternative for the resource | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Organization | SI | 0..* | Organization | Clinic, Pharmacy or clinic/pharmacy chain |
| id | SΣ | 1..1 | id | Logical id of this artifact |
| meta | Σ | 0..1 | Meta | Metadata about the resource |
| 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): A human language. | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| 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 (20190415) (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 | Σ | 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 | Σ | 0..1 | string | Text alternative for the resource |
| 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): The purpose for which you would contact a contact party | |
| 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.68.3 Terminology Bindings
Terminology Bindings
| Path | Conformance | ValueSet |
| Organization.language | required | http://tools.ietf.org/html/bcp47 |
| Organization.type | required | SharedOrganizationType |
| Organization.contact.purpose | extensible | ContactEntityType |
3.68.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() |