Organization
The FHIR resource Organization is for Panorama Organization at Branch level.
Organization | I | Organization | |
id | Σ | 1..1 | string |
meta | Σ | 1..1 | Meta |
id | 0..1 | string | |
extension | I | 0..* | Extension |
versionId | Σ | 0..1 | id |
lastUpdated | Σ | 0..1 | instant |
source | Σ | 0..1 | uri |
profile | Σ | 1..1 | canonical(StructureDefinition)Fixed Value |
security | Σ | 0..1 | CodingBinding |
tag | Σ | 0..1 | Coding |
implicitRules | Σ ?! | 0..1 | uri |
language | 0..1 | codeBinding | |
text | 0..1 | Narrative | |
contained | 0..1 | Resource | |
extension | I | 0..* | Extension |
modifierExtension | ?! I | 0..* | Extension |
identifier | Σ I | 0..1 | Identifier |
id | 0..1 | string | |
extension | I | 0..* | Extension |
use | Σ ?! | 0..0 | codeBinding |
type | Σ | 0..1 | CodeableConceptBinding |
system | Σ | 1..1 | uri |
value | Σ | 1..1 | string |
period | Σ | 0..1 | Period |
assigner | Σ | 0..1 | Reference(Organization) |
active | Σ ?! | 0..1 | boolean |
type | Σ | 0..1 | CodeableConcept |
name | Σ I | 1..1 | string |
alias | 0..1 | string | |
telecom | I | 0..1 | ContactPoint |
address | I | 0..1 | Address |
partOf | Σ | 1..1 | Reference(Organization) |
id | 0..1 | string | |
extension | I | 0..* | Extension |
reference | Σ I | 0..1 | string |
type | Σ | 0..1 | uriBinding |
identifier | Σ | 1..1 | Identifier |
id | 0..1 | string | |
extension | I | 0..* | Extension |
use | Σ ?! | 0..1 | codeBinding |
type | Σ | 0..1 | CodeableConceptBinding |
system | Σ | 0..1 | uri |
value | Σ | 1..1 | string |
period | Σ | 0..1 | Period |
assigner | Σ | 0..1 | Reference(Organization) |
display | Σ | 0..1 | string |
contact | 0..1 | BackboneElement | |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
purpose | 0..1 | CodeableConceptBinding | |
name | 0..1 | HumanName | |
telecom | 0..* | ContactPoint | |
address | 0..1 | Address | |
endpoint | 0..1 | Reference(Endpoint) |
Organization | |
Definition | FHIR resource applies for PIR Organization as Client Health Region or Submitter's Organization |
Cardinality | 0...* |
Invariants |
|
Mappings |
|
Organization.id | |
Definition | PIR Organizational Branch ID under each different Health Authority (HA). |
Cardinality | 1...1 |
Type | string |
Summary | True |
Comments | See Mappings |
Mappings |
|
Organization.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
Cardinality | 1...1 |
Type | Meta |
Summary | True |
Invariants |
|
Organization.meta.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Organization.meta.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Organization.meta.versionId | |
Definition | The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted. |
Cardinality | 0...1 |
Type | id |
Summary | True |
Comments | Apply '2025.01.1' (This indicates FHIR changes on 2025-Jan). |
Invariants |
|
Organization.meta.lastUpdated | |
Definition | When the resource last changed - e.g. when the version changed. |
Cardinality | 0...1 |
Type | instant |
Summary | True |
Comments | Updated: Relax the previously crossed-out elements. |
Invariants |
|
Organization.meta.source | |
Definition | A uri that identifies the source system of the resource. This provides a minimal amount of [Provenance](provenance.html#) information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc. |
Cardinality | 0...1 |
Type | uri |
Summary | True |
Comments | In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL. |
Invariants |
|
Organization.meta.profile | |
Definition | A list of profiles (references to [StructureDefinition](structuredefinition.html#) resources) that this resource claims to conform to. The URL is a reference to [StructureDefinition.url](structuredefinition-definitions.html#StructureDefinition.url). |
Cardinality | 1...1 |
Type | canonical(StructureDefinition) |
Summary | True |
Comments | Use 'http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/Organization' |
Invariants |
|
Fixed Value | http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/Organization |
Organization.meta.security | |
Definition | Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. |
Cardinality | 0...1 |
Type | Coding |
Binding | Security Labels from the Healthcare Privacy and Security Classification System. |
Summary | True |
Comments | The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored. |
Invariants |
|
Organization.meta.tag | |
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. |
Cardinality | 0...1 |
Type | Coding |
Binding | Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". |
Summary | True |
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. |
Invariants |
|
Organization.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
Cardinality | 0...1 |
Type | uri |
Modifier | True |
Summary | True |
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. |
Invariants |
|
Organization.language | |
Definition | The base language in which the resource is written. |
Cardinality | 0...1 |
Type | code |
Binding | A human language. |
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). |
Invariants |
|
Organization.text | |
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
Cardinality | 0...1 |
Type | Narrative |
Alias | narrative, html, xhtml, display |
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. |
Invariants |
|
Mappings |
|
Organization.contained | |
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
Cardinality | 0...1 |
Type | Resource |
Alias | inline resources, anonymous resources, contained resources |
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. |
Mappings |
|
Organization.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Organization.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Alias | extensions, user content |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Organization.identifier | |
Definition | PIR Organizational Branch ID under each different Health Authority (HA). e.g. "159" is hte PIR Organizational Unit ID of Prince George which is under NHA |
Cardinality | 0...1 |
Type | Identifier |
Summary | True |
Requirements | Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization. |
Invariants |
|
Mappings |
|
Organization.identifier.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Organization.identifier.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Organization.identifier.use | |
Definition | The purpose of this identifier. |
Cardinality | 0...0 |
Type | code |
Binding | Identifies the purpose for this identifier, if known . |
Modifier | True |
Summary | True |
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
Invariants |
|
Mappings |
|
Organization.identifier.type | |
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
Summary | True |
Requirements | Allows users to make use of identifiers when the identifier system is not known. |
Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. |
Invariants |
|
Mappings |
|
Organization.identifier.system | |
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. |
Cardinality | 1...1 |
Type | uri |
Summary | True |
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. |
Comments | Use 'https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-panorama-organization-unit-id' |
Invariants |
|
Examples | General http://www.acme.com/identifiers/patient |
Mappings |
|
Organization.identifier.value | |
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
Cardinality | 1...1 |
Type | string |
Summary | True |
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. |
Invariants |
|
Examples | General 123456 |
Mappings |
|
Organization.identifier.period | |
Definition | Time period during which identifier is/was valid for use. |
Cardinality | 0...1 |
Type | Period |
Summary | True |
Invariants |
|
Mappings |
|
Organization.identifier.assigner | |
Definition | Organization that issued/manages the identifier. |
Cardinality | 0...1 |
Type | Reference(Organization) |
Summary | True |
Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. |
Invariants |
|
Mappings |
|
Organization.active | |
Definition | Whether the organization's record is still in active use. |
Cardinality | 0...1 |
Type | boolean |
Modifier | True |
Summary | True |
Requirements | Need a flag to indicate a record is no longer to be used and should generally be hidden for the user in the UI. |
Comments | This active flag is not intended to be used to mark an organization as temporarily closed or under construction. Instead the Location(s) within the Organization should have the suspended status. If further details of the reason for the suspension are required, then an extension on this element should be used. This element is labeled as a modifier because it may be used to mark that the resource was created in error. |
Invariants |
|
Mappings |
|
Organization.type | |
Definition | The kind(s) of organization that this is. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | Used to categorize the organization. |
Summary | True |
Requirements | Need to be able to track the kind of organization that this is - different organization types have different uses. |
Comments | Organizations can be corporations, wards, sections, clinical teams, government departments, etc. Note that code is generally a classifier of the type of organization; in many applications, codes are used to identity a particular organization (say, ward) as opposed to another of the same type - these are identifiers, not codes When considering if multiple types are appropriate, you should evaluate if child organizations would be a more appropriate use of the concept, as different types likely are in different sub-areas of the organization. This is most likely to be used where type values have orthogonal values, such as a religious, academic and medical center. We expect that some jurisdictions will profile this optionality to be a single cardinality. |
Invariants |
|
Mappings |
|
Organization.name | |
Definition | PIR Organizational Branch Name e.g. Prince George |
Cardinality | 1...1 |
Type | string |
Summary | True |
Requirements | Need to use the name as the label of the organization. |
Comments | Derive NAME from <ploephs.organization_unit.name> |
Invariants |
|
Mappings |
|
Organization.alias | |
Definition | A list of alternate names that the organization is known as, or was known as in the past. |
Cardinality | 0...1 |
Type | string |
Requirements | Over time locations and organizations go through many changes and can be known by different names. For searching knowing previous names that the organization was known by can be very useful. |
Comments | There are no dates associated with the alias/historic names, as this is not intended to track when names were used, but to assist in searching so that older names can still result in identifying the organization. |
Invariants |
|
Mappings |
|
Organization.telecom | |
Definition | A contact detail for the organization. |
Cardinality | 0...1 |
Type | ContactPoint |
Requirements | Human contact for the organization. |
Comments | The use code 'home' is not to be used. Note that these contacts are not the contact details of people who are employed by or represent the organization, but official contacts for the organization itself. |
Invariants |
|
Mappings |
|
Organization.address | |
Definition | An address for the organization. |
Cardinality | 0...1 |
Type | Address |
Requirements | May need to keep track of the organization's addresses for contacting, billing or reporting requirements. |
Comments | Organization may have multiple addresses with different uses or applicable periods. The use code 'home' is not to be used. |
Invariants |
|
Mappings |
|
Organization.partOf | |
Definition | The Health Authority (HA) of which this PIR Organizational Branch is under. |
Cardinality | 1...1 |
Type | Reference(Organization) |
Summary | True |
Requirements | Need to be able to track the hierarchy of organizations within an organization. |
Comments | Child of Panorama Organizational Unit |
Invariants |
|
Mappings |
|
Organization.partOf.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Organization.partOf.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Organization.partOf.reference | |
Definition | 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. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | Apply "Organization/OrgParentCHRnnn" where "nnn" = (lookup of PanoBranch) |
Invariants |
|
Mappings |
|
Organization.partOf.type | |
Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). |
Cardinality | 0...1 |
Type | uri |
Binding | Aa resource (or, for logical models, the URI of the logical model). |
Summary | True |
Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. |
Invariants |
|
Mappings |
|
Organization.partOf.identifier | |
Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. |
Cardinality | 1...1 |
Type | Identifier |
Summary | True |
Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). |
Invariants |
|
Mappings |
|
Organization.partOf.identifier.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Organization.partOf.identifier.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Organization.partOf.identifier.use | |
Definition | The purpose of this identifier. |
Cardinality | 0...1 |
Type | code |
Binding | Identifies the purpose for this identifier, if known . |
Modifier | True |
Summary | True |
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
Invariants |
|
Mappings |
|
Organization.partOf.identifier.type | |
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
Summary | True |
Requirements | Allows users to make use of identifiers when the identifier system is not known. |
Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. |
Invariants |
|
Mappings |
|
Organization.partOf.identifier.system | |
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. |
Cardinality | 0...1 |
Type | uri |
Summary | True |
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. |
Comments | Identifier.system is always case sensitive. |
Invariants |
|
Examples | General http://www.acme.com/identifiers/patient |
Mappings |
|
Organization.partOf.identifier.value | |
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
Cardinality | 1...1 |
Type | string |
Summary | True |
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. |
Invariants |
|
Examples | General 123456 |
Mappings |
|
Organization.partOf.identifier.period | |
Definition | Time period during which identifier is/was valid for use. |
Cardinality | 0...1 |
Type | Period |
Summary | True |
Invariants |
|
Mappings |
|
Organization.partOf.identifier.assigner | |
Definition | Organization that issued/manages the identifier. |
Cardinality | 0...1 |
Type | Reference(Organization) |
Summary | True |
Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. |
Invariants |
|
Mappings |
|
Organization.partOf.display | |
Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. |
Invariants |
|
Mappings |
|
Organization.contact | |
Definition | Contact for the organization for a certain purpose. |
Cardinality | 0...1 |
Type | BackboneElement |
Requirements | Need to keep track of assigned contact points within bigger organization. |
Comments | Where multiple contacts for the same purpose are provided there is a standard extension that can be used to determine which one is the preferred contact to use. |
Invariants |
|
Mappings |
|
Organization.contact.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Organization.contact.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Organization.contact.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Organization.contact.purpose | |
Definition | Indicates a purpose for which the contact can be reached. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | The purpose for which you would contact a contact party. |
Requirements | Need to distinguish between multiple contact persons. |
Invariants |
|
Mappings |
|
Organization.contact.name | |
Definition | A name associated with the contact. |
Cardinality | 0...1 |
Type | HumanName |
Requirements | Need to be able to track the person by name. |
Invariants |
|
Mappings |
|
Organization.contact.telecom | |
Definition | A contact detail (e.g. a telephone number or an email address) by which the party may be contacted. |
Cardinality | 0...* |
Type | ContactPoint |
Requirements | People have (primary) ways to contact them in some way such as phone, email. |
Invariants |
|
Mappings |
|
Organization.contact.address | |
Definition | Visiting or postal addresses for the contact. |
Cardinality | 0...1 |
Type | Address |
Requirements | May need to keep track of a contact party's address for contacting, billing or reporting requirements. |
Invariants |
|
Mappings |
|
Organization.endpoint | |
Definition | Technical endpoints providing access to services operated for the organization. |
Cardinality | 0...1 |
Type | Reference(Endpoint) |
Requirements | Organizations have multiple systems that provide various services and need to be able to define the technical connection details for how to connect to them, and for what purpose. |
Invariants |
|
Mappings |
|
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="896ad44b-ddc4-4f30-ace5-61f527066619" /> <meta> <versionId value="1" /> <lastUpdated value="2025-01-24T22:57:51.6295107+00:00" /> </meta> <url value="http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/Organization" /> <name value="Organization" /> <status value="draft" /> <date value="2021-11-26T21:23:26.6251638+00:00" /> <fhirVersion value="4.0.1" /> <mapping> <identity value="v2" /> <uri value="http://hl7.org/v2" /> <name value="HL7 v2 Mapping" /> </mapping> <mapping> <identity value="rim" /> <uri value="http://hl7.org/v3" /> <name value="RIM Mapping" /> </mapping> <mapping> <identity value="servd" /> <uri value="http://www.omg.org/spec/ServD/1.0/" /> <name value="ServD" /> </mapping> <mapping> <identity value="w5" /> <uri value="http://hl7.org/fhir/fivews" /> <name value="FiveWs Pattern Mapping" /> </mapping> <kind value="resource" /> <abstract value="false" /> <type value="Organization" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Organization" /> <derivation value="constraint" /> <differential> <element id="Organization"> <path value="Organization" /> <short value="FHIR resource applies for PIR Organization as Client Health Region or Submitter's Organization" /> <definition value="FHIR resource applies for PIR Organization as Client Health Region or Submitter's Organization" /> </element> <element id="Organization.id"> <path value="Organization.id" /> <short value="PIR Organizational Unit ID" /> <definition value="PIR Organizational Branch ID under each different Health Authority (HA)." /> <comment value="See Mappings" /> <min value="1" /> <mapping> <identity value="CHRorg" /> <map value="PIR CHR Id" /> </mapping> <mapping> <identity value="ImmsOrg" /> <map value="PIR Imms Org Id" /> </mapping> </element> <element id="Organization.meta"> <path value="Organization.meta" /> <min value="1" /> </element> <element id="Organization.meta.versionId"> <path value="Organization.meta.versionId" /> <comment value="Apply '2025.01.1' (This indicates FHIR changes on 2025-Jan)." /> </element> <element id="Organization.meta.lastUpdated"> <path value="Organization.meta.lastUpdated" /> <comment value="Updated: Relax the previously crossed-out elements." /> </element> <element id="Organization.meta.profile"> <path value="Organization.meta.profile" /> <comment value="Use 'http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/Organization'" /> <min value="1" /> <max value="1" /> <fixedCanonical value="http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/Organization" /> </element> <element id="Organization.meta.security"> <path value="Organization.meta.security" /> <max value="1" /> </element> <element id="Organization.meta.tag"> <path value="Organization.meta.tag" /> <max value="1" /> </element> <element id="Organization.contained"> <path value="Organization.contained" /> <max value="1" /> </element> <element id="Organization.identifier"> <path value="Organization.identifier" /> <short value="PIR Organizational Unit ID" /> <definition value="PIR Organizational Branch ID under each different Health Authority (HA). e.g. "159" is hte PIR Organizational Unit ID of Prince George which is under NHA" /> <max value="1" /> </element> <element id="Organization.identifier.use"> <path value="Organization.identifier.use" /> <max value="0" /> </element> <element id="Organization.identifier.system"> <path value="Organization.identifier.system" /> <comment value="Use 'https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-panorama-organization-unit-id'" /> <min value="1" /> </element> <element id="Organization.identifier.value"> <path value="Organization.identifier.value" /> <min value="1" /> </element> <element id="Organization.type"> <path value="Organization.type" /> <max value="1" /> </element> <element id="Organization.name"> <path value="Organization.name" /> <short value="PIR Organizational Unit Name" /> <definition value="PIR Organizational Branch Name e.g. Prince George" /> <comment value="Derive NAME from <ploephs.organization_unit.name>" /> <min value="1" /> </element> <element id="Organization.alias"> <path value="Organization.alias" /> <max value="1" /> </element> <element id="Organization.telecom"> <path value="Organization.telecom" /> <max value="1" /> </element> <element id="Organization.address"> <path value="Organization.address" /> <max value="1" /> </element> <element id="Organization.partOf"> <path value="Organization.partOf" /> <short value="The HA of which this PIR organization is under." /> <definition value="The Health Authority (HA) of which this PIR Organizational Branch is under." /> <comment value="Child of Panorama Organizational Unit" /> <min value="1" /> </element> <element id="Organization.partOf.reference"> <path value="Organization.partOf.reference" /> <comment value="Apply "Organization/OrgParentCHRnnn" where "nnn" = (lookup of PanoBranch)" /> </element> <element id="Organization.partOf.identifier"> <path value="Organization.partOf.identifier" /> <min value="1" /> </element> <element id="Organization.partOf.identifier.value"> <path value="Organization.partOf.identifier.value" /> <min value="1" /> </element> <element id="Organization.contact"> <path value="Organization.contact" /> <max value="1" /> </element> <element id="Organization.endpoint"> <path value="Organization.endpoint" /> <max value="1" /> </element> </differential> </StructureDefinition>
{ "resourceType": "StructureDefinition", "id": "896ad44b-ddc4-4f30-ace5-61f527066619", "meta": { "versionId": "1", "lastUpdated": "01/24/2025 22:57:51" }, "url": "http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/Organization", "name": "Organization", "status": "draft", "date": "11/26/2021 21:23:26", "fhirVersion": "4.0.1", "mapping": [ { "identity": "v2", "uri": "http://hl7.org/v2", "name": "HL7 v2 Mapping" }, { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM Mapping" }, { "identity": "servd", "uri": "http://www.omg.org/spec/ServD/1.0/", "name": "ServD" }, { "identity": "w5", "uri": "http://hl7.org/fhir/fivews", "name": "FiveWs Pattern Mapping" } ], "kind": "resource", "abstract": false, "type": "Organization", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Organization", "derivation": "constraint", "differential": { "element": [ { "id": "Organization", "path": "Organization", "short": "FHIR resource applies for PIR Organization as Client Health Region or Submitter's Organization", "definition": "FHIR resource applies for PIR Organization as Client Health Region or Submitter's Organization" }, { "id": "Organization.id", "path": "Organization.id", "short": "PIR Organizational Unit ID", "definition": "PIR Organizational Branch ID under each different Health Authority (HA).", "comment": "See Mappings", "min": 1, "mapping": [ { "identity": "CHRorg", "map": "PIR CHR Id" }, { "identity": "ImmsOrg", "map": "PIR Imms Org Id" } ] }, { "id": "Organization.meta", "path": "Organization.meta", "min": 1 }, { "id": "Organization.meta.versionId", "path": "Organization.meta.versionId", "comment": "Apply '2025.01.1' (This indicates FHIR changes on 2025-Jan)." }, { "id": "Organization.meta.lastUpdated", "path": "Organization.meta.lastUpdated", "comment": "Updated: Relax the previously crossed-out elements." }, { "id": "Organization.meta.profile", "path": "Organization.meta.profile", "comment": "Use 'http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/Organization'", "min": 1, "max": "1", "fixedCanonical": "http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/Organization" }, { "id": "Organization.meta.security", "path": "Organization.meta.security", "max": "1" }, { "id": "Organization.meta.tag", "path": "Organization.meta.tag", "max": "1" }, { "id": "Organization.contained", "path": "Organization.contained", "max": "1" }, { "id": "Organization.identifier", "path": "Organization.identifier", "short": "PIR Organizational Unit ID", "definition": "PIR Organizational Branch ID under each different Health Authority (HA). e.g. \"159\" is hte PIR Organizational Unit ID of Prince George which is under NHA", "max": "1" }, { "id": "Organization.identifier.use", "path": "Organization.identifier.use", "max": "0" }, { "id": "Organization.identifier.system", "path": "Organization.identifier.system", "comment": "Use 'https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-panorama-organization-unit-id'", "min": 1 }, { "id": "Organization.identifier.value", "path": "Organization.identifier.value", "min": 1 }, { "id": "Organization.type", "path": "Organization.type", "max": "1" }, { "id": "Organization.name", "path": "Organization.name", "short": "PIR Organizational Unit Name", "definition": "PIR Organizational Branch Name e.g. Prince George", "comment": "Derive NAME from <ploephs.organization_unit.name>", "min": 1 }, { "id": "Organization.alias", "path": "Organization.alias", "max": "1" }, { "id": "Organization.telecom", "path": "Organization.telecom", "max": "1" }, { "id": "Organization.address", "path": "Organization.address", "max": "1" }, { "id": "Organization.partOf", "path": "Organization.partOf", "short": "The HA of which this PIR organization is under.", "definition": "The Health Authority (HA) of which this PIR Organizational Branch is under.", "comment": "Child of Panorama Organizational Unit", "min": 1 }, { "id": "Organization.partOf.reference", "path": "Organization.partOf.reference", "comment": "Apply \"Organization/OrgParentCHRnnn\" where \"nnn\" = (lookup of PanoBranch)" }, { "id": "Organization.partOf.identifier", "path": "Organization.partOf.identifier", "min": 1 }, { "id": "Organization.partOf.identifier.value", "path": "Organization.partOf.identifier.value", "min": 1 }, { "id": "Organization.contact", "path": "Organization.contact", "max": "1" }, { "id": "Organization.endpoint", "path": "Organization.endpoint", "max": "1" } ] } }