BC Provider Location Registry FHIR Implementation Guide
1.0.0 - fhirVersion-4.0; BCPLRVersion=1 Canada flag

BC Provider Location Registry FHIR Implementation Guide - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: BCOrganization

Official URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-organization Version: 1.0.0
Active as of 2024-04-28 Computable Name: BCOrganization

General constraints on the Organization resource for use in the BC Provider Registry project.

This profile sets the minimum expectations for an Organization resource that is being used in a transaction to create/update.

Mandatory and Must Support Data Elements

This Organization profile has the following mandatory elements:

Each Organization must have:

  1. a name, with optional:
    1. Period Extension
    2. End Reason Extension
    3. Name Use Extension

Each Organization must support:

  1. an identifier
  2. whether the Organization is active or not
  3. the type of Organization
  4. an Address and Telecom info
  5. the License Status Extension
  6. the PrimaryCareDetails Extension
  7. the ClinicPayeeNumber Extension
  8. the Availability Extension
  9. the Confidentiality Extension
  10. the Notes Extension

Examples

Usage:

Formal Views of Profile Content

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

This structure is derived from OrganizationProfile

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization OrganizationProfile
... status S 0..* (Complex) BC License Status Extension
URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-license-status-extension
... confidentiality S 0..1 (Complex) BC Confidentiality Extension
URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-confidentiality-extension
... note S 0..* (Complex) BC Notes Extension
URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-note-extension
... clinicPayeeNumber S 0..* (Complex) Extension to represent the Clinic Payee number.
URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-organization-clinic-payee-number-extension
... availability S 0..* (Complex) Extension to represent Availability, or hours of operation, for clinic, or other Profiles
URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-availability-extension
... identifier S 0..* BCIdentifier An identifier intended for computation
... active S 0..1 boolean Whether the organization's record is still in active use
Required Pattern: true
... type S 0..* CodeableConcept Kind of organization
Binding: BC Organization Role Code Value Set (required)
... name
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... use S 0..1 code BC Name Use Extension
URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-name-use-extension
Binding: NameUse (required)
.... period S 0..1 Period BC Valid Period Extension
URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-period-extension
.... endReason S 0..1 CodeableConcept BC End Reason Extension
URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-end-reason-extension
Binding: BC End Reason Value Set (required)
.... owner S 0..1 Identifier BC Owner Extension
URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-owner-extension
... telecom S 0..* BCContactPoint Details of a Technology mediated contact point (phone, fax, email, etc.)
... address S 0..* BCAddress An address expressed using postal conventions (as opposed to GPS or other location definition formats)
... contact
.... purpose S 0..1 CodeableConcept The type of contact
.... name S 0..1 HumanName A name associated with the contact
.... telecom S 0..* ContactPoint Contact details (telephone, email, etc.) for a contact
.... address S 0..1 Address Visiting or postal addresses for the contact

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Organization.typerequiredOrganizationRoleVS (a valid code from https://terminology.hlth.gov.bc.ca/ProviderLocationRegistry/CodeSystem/bc-organization-role-code-system)
https://terminology.hlth.gov.bc.ca/ProviderLocationRegistry/ValueSet/bc-organization-role-value-set
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C 0..* OrganizationProfile A grouping of people or organizations with a common purpose
org-1: The organization SHALL at least have a name or an identifier, and possibly more than one
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... communication 0..* CodeableConcept Languages used to provide services
URL: http://hl7.org/fhir/ca/baseline/StructureDefinition/ext-servicelanguage
Binding: CommonLanguages (preferred): Common Languages


... status S 0..* (Complex) BC License Status Extension
URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-license-status-extension
... note S 0..* (Complex) BC Notes Extension
URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-note-extension
... primaryCareDetails S 0..1 (Complex) Extension for BC Organization to add Primary Care Clinic details
URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-organization-primary-care-clinic-extension
... clinicPayeeNumber S 0..* (Complex) Extension to represent the Clinic Payee number.
URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-organization-clinic-payee-number-extension
... availability S 0..* (Complex) Extension to represent Availability, or hours of operation, for clinic, or other Profiles
URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-availability-extension
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier S 0..* BCIdentifier An identifier intended for computation
... active ?!SΣ 0..1 boolean Whether the organization's record is still in active use
Required Pattern: true
... type SΣ 0..* CodeableConcept Kind of organization
Binding: BC Organization Role Code Value Set (required)
... name SΣC 0..1 string Name used for the organization
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... use S 0..1 code BC Name Use Extension
URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-name-use-extension
Binding: NameUse (required)
.... period S 0..1 Period BC Valid Period Extension
URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-period-extension
.... endReason S 0..1 CodeableConcept BC End Reason Extension
URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-end-reason-extension
Binding: BC End Reason Value Set (required)
.... owner S 0..1 Identifier BC Owner Extension
URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-owner-extension
... telecom SC 0..* BCContactPoint Details of a Technology mediated contact point (phone, fax, email, etc.)
cpt-2: A system is required if a value is provided.
org-3: The telecom of an organization can never be of use 'home'
... address SC 0..* BCAddress An address expressed using postal conventions (as opposed to GPS or other location definition formats)
org-2: An address of an organization can never be of use 'home'
.... preferred 0..1 boolean HL7 Preferred Address Flag extension
URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
... contact 0..* BackboneElement Contact for the organization for a certain purpose
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... purpose S 0..1 CodeableConcept The type of contact
Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.

.... name S 0..1 HumanName A name associated with the contact
.... telecom S 0..* ContactPoint Contact details (telephone, email, etc.) for a contact
.... address S 0..1 Address Visiting or postal addresses for the contact

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Organization.typerequiredOrganizationRoleVS (a valid code from https://terminology.hlth.gov.bc.ca/ProviderLocationRegistry/CodeSystem/bc-organization-role-code-system)
https://terminology.hlth.gov.bc.ca/ProviderLocationRegistry/ValueSet/bc-organization-role-value-set
from this IG
Organization.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Organization.contact.purposeextensibleContactEntityType
http://hl7.org/fhir/ValueSet/contactentity-type
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cpt-2errorOrganization.telecomA system is required if a value is provided.
: value.empty() or system.exists()
dom-2errorOrganizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorOrganizationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorOrganizationIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorOrganizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceOrganizationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
org-1errorOrganizationThe organization SHALL at least have a name or an identifier, and possibly more than one
: (identifier.count() + name.count()) > 0
org-2errorOrganization.addressAn address of an organization can never be of use 'home'
: where(use = 'home').empty()
org-3errorOrganization.telecomThe telecom of an organization can never be of use 'home'
: where(use = 'home').empty()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C 0..* OrganizationProfile A grouping of people or organizations with a common purpose
org-1: The organization SHALL at least have a name or an identifier, and possibly more than one
... id Σ 0..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
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
... communication 0..* CodeableConcept Languages used to provide services
URL: http://hl7.org/fhir/ca/baseline/StructureDefinition/ext-servicelanguage
Binding: CommonLanguages (preferred): Common Languages


... status S 0..* (Complex) BC License Status Extension
URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-license-status-extension
... confidentiality S 0..1 (Complex) BC Confidentiality Extension
URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-confidentiality-extension
... note S 0..* (Complex) BC Notes Extension
URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-note-extension
... primaryCareDetails S 0..1 (Complex) Extension for BC Organization to add Primary Care Clinic details
URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-organization-primary-care-clinic-extension
... clinicPayeeNumber S 0..* (Complex) Extension to represent the Clinic Payee number.
URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-organization-clinic-payee-number-extension
... availability S 0..* (Complex) Extension to represent Availability, or hours of operation, for clinic, or other Profiles
URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-availability-extension
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier S 0..* BCIdentifier An identifier intended for computation
... active ?!SΣ 0..1 boolean Whether the organization's record is still in active use
Required Pattern: true
... type SΣ 0..* CodeableConcept Kind of organization
Binding: BC Organization Role Code Value Set (required)
... name SΣC 0..1 string Name used for the organization
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... use S 0..1 code BC Name Use Extension
URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-name-use-extension
Binding: NameUse (required)
.... period S 0..1 Period BC Valid Period Extension
URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-period-extension
.... endReason S 0..1 CodeableConcept BC End Reason Extension
URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-end-reason-extension
Binding: BC End Reason Value Set (required)
.... owner S 0..1 Identifier BC Owner Extension
URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-owner-extension
.... value 0..1 string Primitive value for string
Max Length: 1048576
... alias 0..* string A list of alternate names that the organization is known as, or was known as in the past
... telecom SC 0..* BCContactPoint Details of a Technology mediated contact point (phone, fax, email, etc.)
cpt-2: A system is required if a value is provided.
org-3: The telecom of an organization can never be of use 'home'
... address SC 0..* BCAddress An address expressed using postal conventions (as opposed to GPS or other location definition formats)
org-2: An address of an organization can never be of use 'home'
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... preferred 0..1 boolean HL7 Preferred Address Flag extension
URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... type Σ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
.... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line Σ 0..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city Σ 0..1 string Name of city, town etc.
Example General: Erewhon
.... district Σ 0..1 string District name (aka county)
Example General: Madison
.... state Σ 0..1 string Sub-unit of country (abbreviations ok)
.... postalCode Σ 0..1 string Postal code for area
Example General: 9132
.... country Σ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
.... period Σ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... partOf Σ 0..1 Reference(Organization) The organization of which this organization forms a part
... contact 0..* BackboneElement Contact for the organization for a certain purpose
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... purpose S 0..1 CodeableConcept The type of contact
Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.

.... name S 0..1 HumanName A name associated with the contact
.... telecom S 0..* ContactPoint Contact details (telephone, email, etc.) for a contact
.... address S 0..1 Address Visiting or postal addresses for the contact
... endpoint 0..* Reference(Endpoint) Technical endpoints providing access to services operated for the organization

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Organization.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Organization.typerequiredOrganizationRoleVS (a valid code from https://terminology.hlth.gov.bc.ca/ProviderLocationRegistry/CodeSystem/bc-organization-role-code-system)
https://terminology.hlth.gov.bc.ca/ProviderLocationRegistry/ValueSet/bc-organization-role-value-set
from this IG
Organization.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Organization.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Organization.contact.purposeextensibleContactEntityType
http://hl7.org/fhir/ValueSet/contactentity-type
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cpt-2errorOrganization.telecomA system is required if a value is provided.
: value.empty() or system.exists()
dom-2errorOrganizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorOrganizationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorOrganizationIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorOrganizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceOrganizationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
org-1errorOrganizationThe organization SHALL at least have a name or an identifier, and possibly more than one
: (identifier.count() + name.count()) > 0
org-2errorOrganization.addressAn address of an organization can never be of use 'home'
: where(use = 'home').empty()
org-3errorOrganization.telecomThe telecom of an organization can never be of use 'home'
: where(use = 'home').empty()

This structure is derived from OrganizationProfile

Differential View

This structure is derived from OrganizationProfile

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization OrganizationProfile
... status S 0..* (Complex) BC License Status Extension
URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-license-status-extension
... confidentiality S 0..1 (Complex) BC Confidentiality Extension
URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-confidentiality-extension
... note S 0..* (Complex) BC Notes Extension
URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-note-extension
... clinicPayeeNumber S 0..* (Complex) Extension to represent the Clinic Payee number.
URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-organization-clinic-payee-number-extension
... availability S 0..* (Complex) Extension to represent Availability, or hours of operation, for clinic, or other Profiles
URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-availability-extension
... identifier S 0..* BCIdentifier An identifier intended for computation
... active S 0..1 boolean Whether the organization's record is still in active use
Required Pattern: true
... type S 0..* CodeableConcept Kind of organization
Binding: BC Organization Role Code Value Set (required)
... name
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... use S 0..1 code BC Name Use Extension
URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-name-use-extension
Binding: NameUse (required)
.... period S 0..1 Period BC Valid Period Extension
URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-period-extension
.... endReason S 0..1 CodeableConcept BC End Reason Extension
URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-end-reason-extension
Binding: BC End Reason Value Set (required)
.... owner S 0..1 Identifier BC Owner Extension
URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-owner-extension
... telecom S 0..* BCContactPoint Details of a Technology mediated contact point (phone, fax, email, etc.)
... address S 0..* BCAddress An address expressed using postal conventions (as opposed to GPS or other location definition formats)
... contact
.... purpose S 0..1 CodeableConcept The type of contact
.... name S 0..1 HumanName A name associated with the contact
.... telecom S 0..* ContactPoint Contact details (telephone, email, etc.) for a contact
.... address S 0..1 Address Visiting or postal addresses for the contact

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Organization.typerequiredOrganizationRoleVS (a valid code from https://terminology.hlth.gov.bc.ca/ProviderLocationRegistry/CodeSystem/bc-organization-role-code-system)
https://terminology.hlth.gov.bc.ca/ProviderLocationRegistry/ValueSet/bc-organization-role-value-set
from this IG

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C 0..* OrganizationProfile A grouping of people or organizations with a common purpose
org-1: The organization SHALL at least have a name or an identifier, and possibly more than one
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... communication 0..* CodeableConcept Languages used to provide services
URL: http://hl7.org/fhir/ca/baseline/StructureDefinition/ext-servicelanguage
Binding: CommonLanguages (preferred): Common Languages


... status S 0..* (Complex) BC License Status Extension
URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-license-status-extension
... note S 0..* (Complex) BC Notes Extension
URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-note-extension
... primaryCareDetails S 0..1 (Complex) Extension for BC Organization to add Primary Care Clinic details
URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-organization-primary-care-clinic-extension
... clinicPayeeNumber S 0..* (Complex) Extension to represent the Clinic Payee number.
URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-organization-clinic-payee-number-extension
... availability S 0..* (Complex) Extension to represent Availability, or hours of operation, for clinic, or other Profiles
URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-availability-extension
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier S 0..* BCIdentifier An identifier intended for computation
... active ?!SΣ 0..1 boolean Whether the organization's record is still in active use
Required Pattern: true
... type SΣ 0..* CodeableConcept Kind of organization
Binding: BC Organization Role Code Value Set (required)
... name SΣC 0..1 string Name used for the organization
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... use S 0..1 code BC Name Use Extension
URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-name-use-extension
Binding: NameUse (required)
.... period S 0..1 Period BC Valid Period Extension
URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-period-extension
.... endReason S 0..1 CodeableConcept BC End Reason Extension
URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-end-reason-extension
Binding: BC End Reason Value Set (required)
.... owner S 0..1 Identifier BC Owner Extension
URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-owner-extension
... telecom SC 0..* BCContactPoint Details of a Technology mediated contact point (phone, fax, email, etc.)
cpt-2: A system is required if a value is provided.
org-3: The telecom of an organization can never be of use 'home'
... address SC 0..* BCAddress An address expressed using postal conventions (as opposed to GPS or other location definition formats)
org-2: An address of an organization can never be of use 'home'
.... preferred 0..1 boolean HL7 Preferred Address Flag extension
URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
... contact 0..* BackboneElement Contact for the organization for a certain purpose
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... purpose S 0..1 CodeableConcept The type of contact
Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.

.... name S 0..1 HumanName A name associated with the contact
.... telecom S 0..* ContactPoint Contact details (telephone, email, etc.) for a contact
.... address S 0..1 Address Visiting or postal addresses for the contact

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Organization.typerequiredOrganizationRoleVS (a valid code from https://terminology.hlth.gov.bc.ca/ProviderLocationRegistry/CodeSystem/bc-organization-role-code-system)
https://terminology.hlth.gov.bc.ca/ProviderLocationRegistry/ValueSet/bc-organization-role-value-set
from this IG
Organization.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Organization.contact.purposeextensibleContactEntityType
http://hl7.org/fhir/ValueSet/contactentity-type
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cpt-2errorOrganization.telecomA system is required if a value is provided.
: value.empty() or system.exists()
dom-2errorOrganizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorOrganizationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorOrganizationIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorOrganizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceOrganizationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
org-1errorOrganizationThe organization SHALL at least have a name or an identifier, and possibly more than one
: (identifier.count() + name.count()) > 0
org-2errorOrganization.addressAn address of an organization can never be of use 'home'
: where(use = 'home').empty()
org-3errorOrganization.telecomThe telecom of an organization can never be of use 'home'
: where(use = 'home').empty()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C 0..* OrganizationProfile A grouping of people or organizations with a common purpose
org-1: The organization SHALL at least have a name or an identifier, and possibly more than one
... id Σ 0..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
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
... communication 0..* CodeableConcept Languages used to provide services
URL: http://hl7.org/fhir/ca/baseline/StructureDefinition/ext-servicelanguage
Binding: CommonLanguages (preferred): Common Languages


... status S 0..* (Complex) BC License Status Extension
URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-license-status-extension
... confidentiality S 0..1 (Complex) BC Confidentiality Extension
URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-confidentiality-extension
... note S 0..* (Complex) BC Notes Extension
URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-note-extension
... primaryCareDetails S 0..1 (Complex) Extension for BC Organization to add Primary Care Clinic details
URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-organization-primary-care-clinic-extension
... clinicPayeeNumber S 0..* (Complex) Extension to represent the Clinic Payee number.
URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-organization-clinic-payee-number-extension
... availability S 0..* (Complex) Extension to represent Availability, or hours of operation, for clinic, or other Profiles
URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-availability-extension
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier S 0..* BCIdentifier An identifier intended for computation
... active ?!SΣ 0..1 boolean Whether the organization's record is still in active use
Required Pattern: true
... type SΣ 0..* CodeableConcept Kind of organization
Binding: BC Organization Role Code Value Set (required)
... name SΣC 0..1 string Name used for the organization
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... use S 0..1 code BC Name Use Extension
URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-name-use-extension
Binding: NameUse (required)
.... period S 0..1 Period BC Valid Period Extension
URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-period-extension
.... endReason S 0..1 CodeableConcept BC End Reason Extension
URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-end-reason-extension
Binding: BC End Reason Value Set (required)
.... owner S 0..1 Identifier BC Owner Extension
URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-owner-extension
.... value 0..1 string Primitive value for string
Max Length: 1048576
... alias 0..* string A list of alternate names that the organization is known as, or was known as in the past
... telecom SC 0..* BCContactPoint Details of a Technology mediated contact point (phone, fax, email, etc.)
cpt-2: A system is required if a value is provided.
org-3: The telecom of an organization can never be of use 'home'
... address SC 0..* BCAddress An address expressed using postal conventions (as opposed to GPS or other location definition formats)
org-2: An address of an organization can never be of use 'home'
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... preferred 0..1 boolean HL7 Preferred Address Flag extension
URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... type Σ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
.... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line Σ 0..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city Σ 0..1 string Name of city, town etc.
Example General: Erewhon
.... district Σ 0..1 string District name (aka county)
Example General: Madison
.... state Σ 0..1 string Sub-unit of country (abbreviations ok)
.... postalCode Σ 0..1 string Postal code for area
Example General: 9132
.... country Σ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
.... period Σ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... partOf Σ 0..1 Reference(Organization) The organization of which this organization forms a part
... contact 0..* BackboneElement Contact for the organization for a certain purpose
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... purpose S 0..1 CodeableConcept The type of contact
Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.

.... name S 0..1 HumanName A name associated with the contact
.... telecom S 0..* ContactPoint Contact details (telephone, email, etc.) for a contact
.... address S 0..1 Address Visiting or postal addresses for the contact
... endpoint 0..* Reference(Endpoint) Technical endpoints providing access to services operated for the organization

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Organization.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Organization.typerequiredOrganizationRoleVS (a valid code from https://terminology.hlth.gov.bc.ca/ProviderLocationRegistry/CodeSystem/bc-organization-role-code-system)
https://terminology.hlth.gov.bc.ca/ProviderLocationRegistry/ValueSet/bc-organization-role-value-set
from this IG
Organization.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Organization.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Organization.contact.purposeextensibleContactEntityType
http://hl7.org/fhir/ValueSet/contactentity-type
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cpt-2errorOrganization.telecomA system is required if a value is provided.
: value.empty() or system.exists()
dom-2errorOrganizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorOrganizationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorOrganizationIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorOrganizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceOrganizationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
org-1errorOrganizationThe organization SHALL at least have a name or an identifier, and possibly more than one
: (identifier.count() + name.count()) > 0
org-2errorOrganization.addressAn address of an organization can never be of use 'home'
: where(use = 'home').empty()
org-3errorOrganization.telecomThe telecom of an organization can never be of use 'home'
: where(use = 'home').empty()

This structure is derived from OrganizationProfile

 

Other representations of profile: CSV, Excel, Schematron