Visit the HL7 website
Visit the FHIR website

Pan-Canadian Care Service Directory

DFT-pre-ballot-1.1.1   Canada flag
  • Index
  • Home
  • Business Context
    • Guidance
    • Usage Highlights
    • Use Cases
    • Guide Considerations
  • Technical Context
    • Overview
    • Background
    • Roles Description
    • Model Diagrams
    • Queries
    • Bulk Export
  • FHIR Artifacts
    • Endpoint
    • Extension - AcceptingNewPatients
    • Extension - CurrentWaitTime
    • Extension - DeliveryMethod
    • Extension - UsageLicense
    • FacilityLocation
    • FacilityOrganization
    • HealthcareService
    • JurisdictionLocation
    • JurisdictionOrganization
    • Location
    • LocationDistance
    • Organization
    • OrganizationAffiliation
    • Practitioner
    • PractitionerRole
    • Capability Statements
    • Operations
    • Example - Queries
    • Example - Resources
  • Change Log
    1. Index
    2. FHIR Artifacts
    3. Organization

DFT-preBallot - The specification is currently in pre-ballot review and subject to change. For a full list of available versions, see the Directory of published versions

Organization

Links

Profile

CA-CSD-Organization

Derived from

https://profiles.ihe.net/ITI/mCSD/StructureDefinition/IHE.mCSD.Organization

Examples

ca-csd-example-organization, ca-csd-example-organization-2

Description

An organization is an “umbrella” entity that may be considered an administrative body under whose auspices care services are provided. These may include a Health Region, Non-Government Organization, a healthcare partner with multiple locations, or eve a one-physician family practice. An organization has a unique identifier and may have additional administrative attributes such as contact person, mailing address, etc. Departments of an institution, or other administrative units, may be represented as child Organizations of a parent Organization.

References to this resource

Endpoint, HealthcareService, Organization, FacilityOrganization, JurisdictionOrganization, OrganizationAffiliation, PractitionerRole

Resource Content

  • Tree view
  • Overview
  • XML
  • JSON
OrganizationCMCSDOrganization
There are no (further) constraints on this element
Element id
Organization
Short description

A grouping of people or organizations with a common purpose

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, payer/insurer, etc.

Data type

MCSDOrganization

Constraints
  • dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
    contained.contained.empty()
  • dom-3: If 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-4: If 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-5: If a resource is contained in another resource, it SHALL NOT have a security label
    contained.meta.security.empty()
  • dom-6: A resource should have narrative for robust management
    text.`div`.exists()
  • org-1: The organization SHALL at least have a name or an identifier, and possibly more than one
    (identifier.count() + name.count()) > 0
Mappings
  • rim: Entity. Role, or Act
  • v2: (also see master files messages)
  • rim: Organization(classCode=ORG, determinerCode=INST)
  • servd: Organization
idΣ0..1id
There are no (further) constraints on this element
Element id
Organization.id
Short description

Logical id of this artifact

Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Data type

id

metaΣ0..1Meta
There are no (further) constraints on this element
Element id
Organization.meta
Short description

Metadata about the resource

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.

Data type

Meta

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
implicitRulesΣ ?!0..0uri
There are no (further) constraints on this element
Element id
Organization.implicitRules
Short description

A set of rules under which this content was created

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.

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.

Data type

uri

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
language0..1codeBinding
There are no (further) constraints on this element
Element id
Organization.language
Short description

Language of the resource content

Definition

The base language in which the resource is written.

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

Data type

code

Binding

A human language.

CommonLanguages (preferred)

Binding extensions
maxValueSetAllLanguages
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
text0..1Narrative
There are no (further) constraints on this element
Element id
Organization.text
Short description

Text summary of the resource, for human interpretation

Alternate names

narrative, html, xhtml, display

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.

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.

Data type

Narrative

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: Act.text?
contained0..*Resource
There are no (further) constraints on this element
Element id
Organization.contained
Short description

Contained, inline Resources

Alternate names

inline resources, anonymous resources, contained resources

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.

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.

Data type

Resource

Mappings
  • rim: N/A
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Organization.extension
Short description

Extension

Definition

An Extension

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
purposeOfUseC0..*Extension(CodeableConcept)
There are no (further) constraints on this element
Element id
Organization.extension:purposeOfUse
Short description

Purpose of Use Extension

Definition

Set a purpose of use for an mCSD Endpoint or mCSD Organization.

Data type

Extension(CodeableConcept)

Extension URL

https://profiles.ihe.net/ITI/mCSD/StructureDefinition/IHE.mCSD.PurposeOfUse

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
modifierExtension?! C0..0Extension
There are no (further) constraints on this element
Element id
Organization.modifierExtension
Short description

Extension

Definition

An Extension

Data type

Extension

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
identifierSO Σ C0..*IdentifierElement id
Organization.identifier
Short description

Identifies this organization across multiple systems

Definition

Identifier for the organization that is used to identify the organization across multiple disparate systems.

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.

Comments

Identified as a query requirement through mCSD CapabilityStatement.

Data type

Identifier

Conditions

The cardinality or value of this element may be affected by these constraints: org-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.identifier
  • v2: XON.10 / XON.3
  • rim: .scopes[Role](classCode=IDENT)
  • servd: ./Identifiers
Obligations
CodeActor
SHALL:able-to-populate
SHOULD:populate
http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/server
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/client
id0..1string
There are no (further) constraints on this element
Element id
Organization.identifier.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Organization.identifier.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

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.

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
useΣ ?!0..1codeBinding
There are no (further) constraints on this element
Element id
Organization.identifier.use
Short description

usual | official | temp | secondary | old (If known)

Definition

The purpose of this identifier.

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.

Data type

code

Binding

Identifies the purpose for this identifier, if known .

IdentifierUse (required)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: N/A
  • rim: Role.code or implied by context
typeΣ0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Organization.identifier.type
Short description

Description of identifier

Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

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.

Data type

CodeableConcept

Binding

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

Identifier Type Codes (extensible)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: CX.5
  • rim: Role.code or implied by context
systemSO Σ1..1uriElement id
Organization.identifier.system
Short description

The namespace for the identifier value

Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

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

mustSupport element identified within the CA Core profile.

Data type

uri

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General
http://www.acme.com/identifiers/patient
Mappings
  • v2: CX.4 / EI-2-4
  • rim: II.root or Role.id.root
  • servd: ./IdentifierType
Obligations
CodeActor
SHALL:able-to-populate
SHOULD:populate
http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/server
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/client
valueSO Σ1..1stringElement id
Organization.identifier.value
Short description

The value that is unique

Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Comments

mustSupport element identified within the CA Core profile.

Data type

string

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General
123456
Mappings
  • v2: CX.1 / EI.1
  • rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
  • servd: ./Value
Obligations
CodeActor
SHALL:able-to-populate
SHOULD:populate
http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/server
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/client
periodΣ0..1Period
There are no (further) constraints on this element
Element id
Organization.identifier.period
Short description

Time period when id is/was valid for use

Definition

Time period during which identifier is/was valid for use.

Data type

Period

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: CX.7 + CX.8
  • rim: Role.effectiveTime or implied by context
  • servd: ./StartDate and ./EndDate
assignerΣ0..1Reference(Organization)
There are no (further) constraints on this element
Element id
Organization.identifier.assigner
Short description

Organization that issued id (may be just text)

Definition

Organization that issued/manages the identifier.

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.

Data type

Reference(Organization)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: CX.4 / (CX.4,CX.9,CX.10)
  • rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
  • servd: ./IdentifierIssuingAuthority
activeSO Σ ?!0..1booleanElement id
Organization.active
Short description

Whether the organization's record is still in active use

Definition

Whether the organization's record is still in active use.

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

Identified as a query requirement through mCSD CapabilityStatement.

Meaning when missing

This resource is generally assumed to be active if no value is provided for the active element

Data type

boolean

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.status
  • v2: No equivalent in HL7 v2
  • rim: .status
  • servd: ./Status (however this concept in ServD more covers why the organization is active or not, could be delisted, deregistered, not operational yet) this could alternatively be derived from ./StartDate and ./EndDate and given a context date.
Obligations
CodeActor
SHALL:able-to-populate
SHOULD:populate
http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/server
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/client
typeSO Σ1..*CodeableConceptElement id
Organization.type
Short description

A code that describes the type of Organization.

Definition

A code that describes the type of Organization.

Requirements

Need to be able to track the kind of organization that this is - different organization types have different uses.

Comments

Identified as a query requirement through mCSD CapabilityStatement.

Data type

CodeableConcept

Binding

Used to categorize the organization.

OrganizationType (example)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.class
  • v2: No equivalent in v2
  • rim: .code
  • servd: n/a
Obligations
CodeActor
SHALL:able-to-populate
SHOULD:populate
http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/server
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/client
nameSO Σ C1..1stringElement id
Organization.name
Short description

The name of the Organization.

Definition

The name of the Organization.

Requirements

Need to use the name as the label of the organization.

Comments

Identified as a query requirement through mCSD CapabilityStatement, and mustSupport element in the CA Baseline. Elements with a modified minimum cardinality of 1 will have a mustSupport element to ensure that it is populated.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: org-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: XON.1
  • rim: .name
  • servd: .PreferredName/Name
Obligations
CodeActor
SHALL:able-to-populate
SHOULD:populate
http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/server
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/client
alias0..*string
There are no (further) constraints on this element
Element id
Organization.alias
Short description

A list of alternate names that the organization is known as, or was known as in the past

Definition

A list of alternate names that the organization is known as, or was known as in the past.

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.

Data type

string

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .name
telecomSO C0..*ContactPointElement id
Organization.telecom
Short description

A contact detail for the organization

Definition

A contact detail for the organization.

Requirements

Human contact for the organization.

Comments

Identified as a requirement and mustSupport element from the CA Core.

Data type

ContactPoint

Conditions

The cardinality or value of this element may be affected by these constraints: org-3

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • org-3: The telecom of an organization can never be of use 'home'
    where(use = 'home').empty()
Mappings
  • v2: ORC-22?
  • rim: .telecom
  • servd: ./ContactPoints
Obligations
CodeActor
SHALL:able-to-populate
SHOULD:populate
http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/server
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/client
id0..1string
There are no (further) constraints on this element
Element id
Organization.telecom.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Organization.telecom.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

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.

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
systemSO Σ C0..1codeBindingElement id
Organization.telecom.system
Short description

phone | fax | email | pager | url | sms | other

Definition

Telecommunications form for contact point - what communications system is required to make use of the contact.

Comments

Identified as a requirement and mustSupport element from the CA Core.

Data type

code

Binding

Telecommunications form for contact point.

ContactPointSystem (required)

Conditions

The cardinality or value of this element may be affected by these constraints: cpt-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: XTN.3
  • rim: ./scheme
  • servd: ./ContactPointType
Obligations
CodeActor
SHALL:able-to-populate
SHOULD:populate
http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/server
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/client
valueSO Σ1..1stringElement id
Organization.telecom.value
Short description

The actual contact point details

Definition

The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).

Requirements

Need to support legacy numbers that are not in a tightly controlled format.

Comments

Identified as a requirement and mustSupport element from the CA Core.

Data type

string

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: XTN.1 (or XTN.12)
  • rim: ./url
  • servd: ./Value
Obligations
CodeActor
SHALL:able-to-populate
SHOULD:populate
http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/server
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/client
useΣ ?!0..1codeBinding
There are no (further) constraints on this element
Element id
Organization.telecom.use
Short description

home | work | temp | old | mobile - purpose of this contact point

Definition

Identifies the purpose for the contact point.

Requirements

Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.

Comments

Applications can assume that a contact is current unless it explicitly says that it is temporary or old.

Data type

code

Binding

Use of contact point.

ContactPointUse (required)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: XTN.2 - but often indicated by field
  • rim: unique(./use)
  • servd: ./ContactPointPurpose
rankΣ0..1positiveInt
There are no (further) constraints on this element
Element id
Organization.telecom.rank
Short description

Specify preferred order of use (1 = highest)

Definition

Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.

Comments

Note that rank does not necessarily follow the order in which the contacts are represented in the instance.

Data type

positiveInt

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: n/a
  • rim: n/a
periodΣ0..1Period
There are no (further) constraints on this element
Element id
Organization.telecom.period
Short description

Time period when the contact point was/is in use

Definition

Time period when the contact point was/is in use.

Data type

Period

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: N/A
  • rim: ./usablePeriod[type="IVL<TS>"]
  • servd: ./StartDate and ./EndDate
addressSO C0..*AddressElement id
Organization.address
Short description

An address for the organization

Definition

An address for the organization.

Requirements

May need to keep track of the organization's addresses for contacting, billing or reporting requirements.

Comments

Identified as a query requirement for searching for providers by role and all associated relationships in a specific city. Requires need to identify the organization address of the organization that the provider is a part of.

Data type

Address

Conditions

The cardinality or value of this element may be affected by these constraints: org-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • org-2: An address of an organization can never be of use 'home'
    where(use = 'home').empty()
Mappings
  • v2: ORC-23?
  • rim: .address
  • servd: ./PrimaryAddress and ./OtherAddresses
Obligations
CodeActor
SHALL:able-to-populate
SHOULD:populate
http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/server
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/client
partOfSO Σ0..1Reference(Organization)Element id
Organization.partOf
Short description

If the Organization belongs to a single hierarchy, the partOf element shall be used.

Definition

If the Organization belongs to a single hierarchy, the partOf element shall be used.

Requirements

Need to be able to track the hierarchy of organizations within an organization.

Comments

Identified as a query requirement through mCSD CapabilityStatement. Allows the search to return the location without having to go through the practitionerRole resource.

Data type

Reference(Organization)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: No equivalent in HL7 v2
  • rim: .playedBy[classCode=Part].scoper
  • servd: n/a
Obligations
CodeActor
SHALL:able-to-populate
SHOULD:populate
http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/server
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/client
contact0..*BackboneElement
There are no (further) constraints on this element
Element id
Organization.contact
Short description

Contact for the organization for a certain purpose

Definition

Contact for the organization for a certain purpose.

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.

Data type

BackboneElement

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .contactParty
id0..1string
There are no (further) constraints on this element
Element id
Organization.contact.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Organization.contact.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

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.

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.

Data type

Extension

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Organization.contact.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

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

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.

Data type

Extension

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
purpose0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Organization.contact.purpose
Short description

The type of contact

Definition

Indicates a purpose for which the contact can be reached.

Requirements

Need to distinguish between multiple contact persons.

Data type

CodeableConcept

Binding

The purpose for which you would contact a contact party.

ContactEntityType (extensible)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: ./type
name0..1HumanName
There are no (further) constraints on this element
Element id
Organization.contact.name
Short description

A name associated with the contact

Definition

A name associated with the contact.

Requirements

Need to be able to track the person by name.

Data type

HumanName

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: PID-5, PID-9
  • rim: ./name
telecom0..*ContactPoint
There are no (further) constraints on this element
Element id
Organization.contact.telecom
Short description

Contact details (telephone, email, etc.) for a contact

Definition

A contact detail (e.g. a telephone number or an email address) by which the party may be contacted.

Requirements

People have (primary) ways to contact them in some way such as phone, email.

Data type

ContactPoint

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: PID-13, PID-14
  • rim: ./telecom
address0..1Address
There are no (further) constraints on this element
Element id
Organization.contact.address
Short description

Visiting or postal addresses for the contact

Definition

Visiting or postal addresses for the contact.

Requirements

May need to keep track of a contact party's address for contacting, billing or reporting requirements.

Data type

Address

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: PID-11
  • rim: ./addr
id0..1string
There are no (further) constraints on this element
Element id
Organization.contact.address.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Organization.contact.address.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

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.

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
useΣ ?!0..1codeBinding
There are no (further) constraints on this element
Element id
Organization.contact.address.use
Short description

home | work | temp | old | billing - purpose of this address

Definition

The purpose of this address.

Requirements

Allows an appropriate address to be chosen from a list of many.

Comments

Applications can assume that an address is current unless it explicitly says that it is temporary or old.

Data type

code

Binding

The use of an address.

AddressUse (required)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General
home
Mappings
  • v2: XAD.7
  • rim: unique(./use)
  • servd: ./AddressPurpose
typeΣ0..1codeBinding
There are no (further) constraints on this element
Element id
Organization.contact.address.type
Short description

postal | physical | both

Definition

Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.

Comments

The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource).

Data type

code

Binding

The type of an address (physical / postal).

AddressType (required)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General
both
Mappings
  • v2: XAD.18
  • rim: unique(./use)
  • vcard: address type parameter
textΣ0..1string
There are no (further) constraints on this element
Element id
Organization.contact.address.text
Short description

Text representation of the address

Definition

Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.

Requirements

A renderable, unencoded form.

Comments

Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.

Data type

string

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General
137 Nowhere Street, Erewhon 9132
Mappings
  • v2: XAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6
  • rim: ./formatted
  • vcard: address label parameter
lineΣ0..*string
There are no (further) constraints on this element
Element id
Organization.contact.address.line
Short description

Street name, number, direction & P.O. Box etc.

Definition

This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.

Data type

string

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General
137 Nowhere Street
Mappings
  • v2: XAD.1 + XAD.2 (note: XAD.1 and XAD.2 have different meanings for a company address than for a person address)
  • rim: AD.part[parttype = AL]
  • vcard: street
  • servd: ./StreetAddress (newline delimitted)
citySO Σ0..1stringElement id
Organization.contact.address.city
Short description

Name of city, town etc.

Alternate names

Municpality

Definition

The name of the city, town, suburb, village or other community or delivery center.

Comments

Identified as a query requirement for searching for providers by role and all associated relationships in a specific city. Requires need to identify the organization address of the organization that the provider is a part of.

Data type

string

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General
Erewhon
Mappings
  • v2: XAD.3
  • rim: AD.part[parttype = CTY]
  • vcard: locality
  • servd: ./Jurisdiction
Obligations
CodeActor
SHALL:able-to-populate
SHOULD:populate
http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/server
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/client
districtΣ0..1string
There are no (further) constraints on this element
Element id
Organization.contact.address.district
Short description

District name (aka county)

Alternate names

County

Definition

The name of the administrative area (county).

Comments

District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead.

Data type

string

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General
Madison
Mappings
  • v2: XAD.9
  • rim: AD.part[parttype = CNT | CPA]
stateΣ0..1string
There are no (further) constraints on this element
Element id
Organization.contact.address.state
Short description

Sub-unit of country (abbreviations ok)

Alternate names

Province, Territory

Definition

Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes).

Data type

string

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: XAD.4
  • rim: AD.part[parttype = STA]
  • vcard: region
  • servd: ./Region
postalCodeΣ0..1string
There are no (further) constraints on this element
Element id
Organization.contact.address.postalCode
Short description

Postal code for area

Alternate names

Zip

Definition

A postal code designating a region defined by the postal service.

Data type

string

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General
9132
Mappings
  • v2: XAD.5
  • rim: AD.part[parttype = ZIP]
  • vcard: code
  • servd: ./PostalIdentificationCode
countryΣ0..1string
There are no (further) constraints on this element
Element id
Organization.contact.address.country
Short description

Country (e.g. can be ISO 3166 2 or 3 letter code)

Definition

Country - a nation as commonly understood or generally accepted.

Comments

ISO 3166 3 letter codes can be used in place of a human readable country name.

Data type

string

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: XAD.6
  • rim: AD.part[parttype = CNT]
  • vcard: country
  • servd: ./Country
periodΣ0..1Period
There are no (further) constraints on this element
Element id
Organization.contact.address.period
Short description

Time period when address was/is in use

Definition

Time period when address was/is in use.

Requirements

Allows addresses to be placed in historical context.

Data type

Period

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General
{
  "start": "2010-03-23",
  "end": "2010-07-01"
}
Mappings
  • v2: XAD.12 / XAD.13 + XAD.14
  • rim: ./usablePeriod[type="IVL<TS>"]
  • servd: ./StartDate and ./EndDate
endpoint0..*Reference(Endpoint)
There are no (further) constraints on this element
Element id
Organization.endpoint
Short description

Technical endpoints providing access to services operated for the organization

Definition

Technical endpoints providing access to services operated for the organization.

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.

Data type

Reference(Endpoint)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
OrganizationMCSDOrganization
There are no (further) constraints on this element
Data type

MCSDOrganization

identifierSOElement id
Organization.identifier
Comments

Identified as a query requirement through mCSD CapabilityStatement.

Obligations
CodeActor
SHALL:able-to-populate
SHOULD:populate
http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/server
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/client
systemSO1..1Element id
Organization.identifier.system
Comments

mustSupport element identified within the CA Core profile.

Obligations
CodeActor
SHALL:able-to-populate
SHOULD:populate
http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/server
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/client
valueSO1..1Element id
Organization.identifier.value
Comments

mustSupport element identified within the CA Core profile.

Obligations
CodeActor
SHALL:able-to-populate
SHOULD:populate
http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/server
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/client
activeSOElement id
Organization.active
Comments

Identified as a query requirement through mCSD CapabilityStatement.

Obligations
CodeActor
SHALL:able-to-populate
SHOULD:populate
http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/server
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/client
typeSOElement id
Organization.type
Comments

Identified as a query requirement through mCSD CapabilityStatement.

Obligations
CodeActor
SHALL:able-to-populate
SHOULD:populate
http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/server
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/client
nameSOElement id
Organization.name
Comments

Identified as a query requirement through mCSD CapabilityStatement, and mustSupport element in the CA Baseline. Elements with a modified minimum cardinality of 1 will have a mustSupport element to ensure that it is populated.

Obligations
CodeActor
SHALL:able-to-populate
SHOULD:populate
http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/server
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/client
telecomSOElement id
Organization.telecom
Comments

Identified as a requirement and mustSupport element from the CA Core.

Obligations
CodeActor
SHALL:able-to-populate
SHOULD:populate
http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/server
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/client
systemSOElement id
Organization.telecom.system
Comments

Identified as a requirement and mustSupport element from the CA Core.

Obligations
CodeActor
SHALL:able-to-populate
SHOULD:populate
http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/server
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/client
valueSO1..Element id
Organization.telecom.value
Comments

Identified as a requirement and mustSupport element from the CA Core.

Obligations
CodeActor
SHALL:able-to-populate
SHOULD:populate
http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/server
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/client
addressSOElement id
Organization.address
Comments

Identified as a query requirement for searching for providers by role and all associated relationships in a specific city. Requires need to identify the organization address of the organization that the provider is a part of.

Obligations
CodeActor
SHALL:able-to-populate
SHOULD:populate
http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/server
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/client
partOfSOReference(Organization)Element id
Organization.partOf
Comments

Identified as a query requirement through mCSD CapabilityStatement. Allows the search to return the location without having to go through the practitionerRole resource.

Data type

Reference(Organization)

Obligations
CodeActor
SHALL:able-to-populate
SHOULD:populate
http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/server
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/client
contact
There are no (further) constraints on this element
address
There are no (further) constraints on this element
citySOElement id
Organization.contact.address.city
Comments

Identified as a query requirement for searching for providers by role and all associated relationships in a specific city. Requires need to identify the organization address of the organization that the provider is a part of.

Obligations
CodeActor
SHALL:able-to-populate
SHOULD:populate
http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/server
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/client
<StructureDefinition xmlns="http://hl7.org/fhir">
<id value="CA-CSD-Organization" />
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="SHALL:able-to-populate" />
</extension>
<extension url="code">
<valueCode value="SHOULD:populate" />
</extension>
<extension url="elementId">
<valueString value="Organization.identifier" />
</extension>
<extension url="elementId">
<valueString value="Organization.identifier.system" />
</extension>
<extension url="elementId">
<valueString value="Organization.identifier.value" />
</extension>
<extension url="elementId">
<valueString value="Organization.active" />
</extension>
<extension url="elementId">
<valueString value="Organization.type" />
</extension>
<extension url="elementId">
<valueString value="Organization.name" />
</extension>
<extension url="elementId">
<valueString value="Organization.telecom" />
</extension>
<extension url="elementId">
<valueString value="Organization.telecom.system" />
</extension>
<extension url="elementId">
<valueString value="Organization.telecom.value" />
</extension>
<extension url="elementId">
<valueString value="Organization.address" />
</extension>
<extension url="elementId">
<valueString value="Organization.contact.address.city" />
</extension>
<extension url="elementId">
<valueString value="Organization.partOf" />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/server" />
</extension>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="elementId">
<valueString value="Organization.identifier" />
</extension>
<extension url="elementId">
<valueString value="Organization.identifier.system" />
</extension>
<extension url="elementId">
<valueString value="Organization.identifier.value" />
</extension>
<extension url="elementId">
<valueString value="Organization.active" />
</extension>
<extension url="elementId">
<valueString value="Organization.type" />
</extension>
<extension url="elementId">
<valueString value="Organization.name" />
</extension>
<extension url="elementId">
<valueString value="Organization.telecom" />
</extension>
<extension url="elementId">
<valueString value="Organization.telecom.system" />
</extension>
<extension url="elementId">
<valueString value="Organization.telecom.value" />
</extension>
<extension url="elementId">
<valueString value="Organization.address" />
</extension>
<extension url="elementId">
<valueString value="Organization.contact.address.city" />
</extension>
<extension url="elementId">
<valueString value="Organization.partOf" />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/client" />
</extension>
</extension>
<url value="http://fhir.infoway-inforoute.ca/io/CA-CSD/StructureDefinition/CA-CSD-Organization" />
<name value="Organization" />
<status value="draft" />
<description value="An organization is an “umbrella” entity that may be considered an administrative body under whose auspices care services are provided. These may include a Health Region, Non-Government Organization, a healthcare partner with multiple locations, or eve a one-physician family practice. An organization has a unique identifier and may have additional administrative attributes such as contact person, mailing address, etc. Departments of an institution, or other administrative units, may be represented as child Organizations of a parent Organization." />
<copyright value="Copyright © 2024+ Canada Health Infoway. All rights reserved. [Terms of Use and License Agreements](https://ic.infoway-inforoute.ca/en/about/tou). [Privacy Policy](https://www.infoway-inforoute.ca/en/legal/privacy-policy)." />
<fhirVersion value="4.0.1" />
<kind value="resource" />
<abstract value="false" />
<type value="Organization" />
<baseDefinition value="https://profiles.ihe.net/ITI/mCSD/StructureDefinition/IHE.mCSD.Organization" />
<derivation value="constraint" />
<differential>
<element id="Organization.identifier">
<path value="Organization.identifier" />
<comment value="Identified as a query requirement through mCSD CapabilityStatement." />
<mustSupport value="true" />
</element>
<element id="Organization.identifier.system">
<path value="Organization.identifier.system" />
<comment value="mustSupport element identified within the CA Core profile." />
<min value="1" />
<max value="1" />
<mustSupport value="true" />
</element>
<element id="Organization.identifier.value">
<path value="Organization.identifier.value" />
<comment value="mustSupport element identified within the CA Core profile." />
<min value="1" />
<max value="1" />
<mustSupport value="true" />
</element>
<element id="Organization.active">
<path value="Organization.active" />
<comment value="Identified as a query requirement through mCSD CapabilityStatement." />
<mustSupport value="true" />
</element>
<element id="Organization.type">
<path value="Organization.type" />
<comment value="Identified as a query requirement through mCSD CapabilityStatement." />
<mustSupport value="true" />
</element>
<element id="Organization.name">
<path value="Organization.name" />
<comment value="Identified as a query requirement through mCSD CapabilityStatement, and mustSupport element in the CA Baseline. Elements with a modified minimum cardinality of 1 will have a mustSupport element to ensure that it is populated." />
<mustSupport value="true" />
</element>
<element id="Organization.telecom">
<path value="Organization.telecom" />
<comment value="Identified as a requirement and mustSupport element from the CA Core." />
<mustSupport value="true" />
</element>
<element id="Organization.telecom.system">
<path value="Organization.telecom.system" />
<comment value="Identified as a requirement and mustSupport element from the CA Core." />
<mustSupport value="true" />
</element>
<element id="Organization.telecom.value">
<path value="Organization.telecom.value" />
<comment value="Identified as a requirement and mustSupport element from the CA Core." />
<min value="1" />
<mustSupport value="true" />
</element>
<element id="Organization.address">
<path value="Organization.address" />
<comment value="Identified as a query requirement for searching for providers by role and all associated relationships in a specific city. Requires need to identify the organization address of the organization that the provider is a part of." />
<mustSupport value="true" />
</element>
<element id="Organization.partOf">
<path value="Organization.partOf" />
<comment value="Identified as a query requirement through mCSD CapabilityStatement. Allows the search to return the location without having to go through the practitionerRole resource." />
<type>
<code value="Reference" />
<targetProfile value="http://fhir.infoway-inforoute.ca/io/CA-CSD/StructureDefinition/CA-CSD-Organization" />
</type>
<mustSupport value="true" />
</element>
<element id="Organization.contact.address.city">
<path value="Organization.contact.address.city" />
<comment value="Identified as a query requirement for searching for providers by role and all associated relationships in a specific city. Requires need to identify the organization address of the organization that the provider is a part of." />
<mustSupport value="true" />
</element>
</differential>
</StructureDefinition>
{
"resourceType": "StructureDefinition",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [
{
"url": "code",
"valueCode": "SHALL:able-to-populate"
},
{
"url": "code",
"valueCode": "SHOULD:populate"
},
{
"url": "elementId",
"valueString": "Organization.identifier"
},
{
"url": "elementId",
"valueString": "Organization.identifier.system"
},
{
"url": "elementId",
"valueString": "Organization.identifier.value"
},
{
"url": "elementId",
"valueString": "Organization.active"
},
{
"url": "elementId",
"valueString": "Organization.type"
},
{
"url": "elementId",
"valueString": "Organization.name"
},
{
"url": "elementId",
"valueString": "Organization.telecom"
},
{
"url": "elementId",
"valueString": "Organization.telecom.system"
},
{
"url": "elementId",
"valueString": "Organization.telecom.value"
},
{
"url": "elementId",
"valueString": "Organization.address"
},
{
"url": "elementId",
"valueString": "Organization.contact.address.city"
},
{
"url": "elementId",
"valueString": "Organization.partOf"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/server"
}
]
},
{
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "elementId",
"valueString": "Organization.identifier"
},
{
"url": "elementId",
"valueString": "Organization.identifier.system"
},
{
"url": "elementId",
"valueString": "Organization.identifier.value"
},
{
"url": "elementId",
"valueString": "Organization.active"
},
{
"url": "elementId",
"valueString": "Organization.type"
},
{
"url": "elementId",
"valueString": "Organization.name"
},
{
"url": "elementId",
"valueString": "Organization.telecom"
},
{
"url": "elementId",
"valueString": "Organization.telecom.system"
},
{
"url": "elementId",
"valueString": "Organization.telecom.value"
},
{
"url": "elementId",
"valueString": "Organization.address"
},
{
"url": "elementId",
"valueString": "Organization.contact.address.city"
},
{
"url": "elementId",
"valueString": "Organization.partOf"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/client"
}
]
}
],
"id": "CA-CSD-Organization",
"url": "http://fhir.infoway-inforoute.ca/io/CA-CSD/StructureDefinition/CA-CSD-Organization",
"name": "Organization",
"description": "An organization is an “umbrella” entity that may be considered an administrative body under whose auspices care services are provided. These may include a Health Region, Non-Government Organization, a healthcare partner with multiple locations, or eve a one-physician family practice. An organization has a unique identifier and may have additional administrative attributes such as contact person, mailing address, etc. Departments of an institution, or other administrative units, may be represented as child Organizations of a parent Organization.",
"status": "draft",
"copyright": "Copyright © 2024+ Canada Health Infoway. All rights reserved. [Terms of Use and License Agreements](https://ic.infoway-inforoute.ca/en/about/tou). [Privacy Policy](https://www.infoway-inforoute.ca/en/legal/privacy-policy).",
"fhirVersion": "4.0.1",
"kind": "resource",
"abstract": false,
"type": "Organization",
"baseDefinition": "https://profiles.ihe.net/ITI/mCSD/StructureDefinition/IHE.mCSD.Organization",
"derivation": "constraint",
"differential": {
"element": [
{
"id": "Organization.identifier",
"path": "Organization.identifier",
"comment": "Identified as a query requirement through mCSD CapabilityStatement.",
"mustSupport": true
},
{
"id": "Organization.identifier.system",
"path": "Organization.identifier.system",
"comment": "mustSupport element identified within the CA Core profile.",
"min": 1,
"max": "1",
"mustSupport": true
},
{
"id": "Organization.identifier.value",
"path": "Organization.identifier.value",
"comment": "mustSupport element identified within the CA Core profile.",
"min": 1,
"max": "1",
"mustSupport": true
},
{
"id": "Organization.active",
"path": "Organization.active",
"comment": "Identified as a query requirement through mCSD CapabilityStatement.",
"mustSupport": true
},
{
"id": "Organization.type",
"path": "Organization.type",
"comment": "Identified as a query requirement through mCSD CapabilityStatement.",
"mustSupport": true
},
{
"id": "Organization.name",
"path": "Organization.name",
"comment": "Identified as a query requirement through mCSD CapabilityStatement, and mustSupport element in the CA Baseline. Elements with a modified minimum cardinality of 1 will have a mustSupport element to ensure that it is populated.",
"mustSupport": true
},
{
"id": "Organization.telecom",
"path": "Organization.telecom",
"comment": "Identified as a requirement and mustSupport element from the CA Core.",
"mustSupport": true
},
{
"id": "Organization.telecom.system",
"path": "Organization.telecom.system",
"comment": "Identified as a requirement and mustSupport element from the CA Core.",
"mustSupport": true
},
{
"id": "Organization.telecom.value",
"path": "Organization.telecom.value",
"comment": "Identified as a requirement and mustSupport element from the CA Core.",
"min": 1,
"mustSupport": true
},
{
"id": "Organization.address",
"path": "Organization.address",
"comment": "Identified as a query requirement for searching for providers by role and all associated relationships in a specific city. Requires need to identify the organization address of the organization that the provider is a part of.",
"mustSupport": true
},
{
"id": "Organization.partOf",
"path": "Organization.partOf",
"comment": "Identified as a query requirement through mCSD CapabilityStatement. Allows the search to return the location without having to go through the practitionerRole resource.",
"type": [
{
"code": "Reference",
"targetProfile": [
"http://fhir.infoway-inforoute.ca/io/CA-CSD/StructureDefinition/CA-CSD-Organization"
]
}
],
"mustSupport": true
},
{
"id": "Organization.contact.address.city",
"path": "Organization.contact.address.city",
"comment": "Identified as a query requirement for searching for providers by role and all associated relationships in a specific city. Requires need to identify the organization address of the organization that the provider is a part of.",
"mustSupport": true
}
]
}
}

Terminology bindings (Differential)

Terminology bindings (Snapshot)

PathConformanceValueSet
Organization.languagepreferredhttp://hl7.org/fhir/ValueSet/languages
Organization.identifier.userequiredhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1
Organization.identifier.typeextensiblehttp://hl7.org/fhir/ValueSet/identifier-type
Organization.typeexamplehttp://hl7.org/fhir/ValueSet/organization-type
Organization.telecom.systemrequiredhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
Organization.telecom.userequiredhttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
Organization.contact.purposeextensiblehttp://hl7.org/fhir/ValueSet/contactentity-type
Organization.contact.address.userequiredhttp://hl7.org/fhir/ValueSet/address-use|4.0.1
Organization.contact.address.typerequiredhttp://hl7.org/fhir/ValueSet/address-type|4.0.1
PathConformanceValueSet
Organization.languagepreferredhttp://hl7.org/fhir/ValueSet/languages
Organization.identifier.userequiredhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1
Organization.identifier.typeextensiblehttp://hl7.org/fhir/ValueSet/identifier-type
Organization.typeexamplehttp://hl7.org/fhir/ValueSet/organization-type
Organization.telecom.systemrequiredhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
Organization.telecom.userequiredhttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
Organization.contact.purposeextensiblehttp://hl7.org/fhir/ValueSet/contactentity-type
Organization.contact.address.userequiredhttp://hl7.org/fhir/ValueSet/address-use|4.0.1
Organization.contact.address.typerequiredhttp://hl7.org/fhir/ValueSet/address-type|4.0.1

Constraints

Obligations

ObligationsActorElement
SHALL:able-to-populate, SHOULD:populatehttp://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/serverOrganization.identifier, Organization.identifier.system, Organization.identifier.value, Organization.active, Organization.type, Organization.name, Organization.telecom, Organization.telecom.system, Organization.telecom.value, Organization.address, Organization.contact.address.city, Organization.partOf
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/clientOrganization.identifier, Organization.identifier.system, Organization.identifier.value, Organization.active, Organization.type, Organization.name, Organization.telecom, Organization.telecom.system, Organization.telecom.value, Organization.address, Organization.contact.address.city, Organization.partOf

Additional Functionalities Usage

Search for providers by role and all associated relationships in a specific City

  • Utilizes .address for searchability alongside supporting address-based search parameters

IG © based on FHIR R4 | Package package:ca.infoway.io.ca-csd@1.1.1-dft-preBallot
HL7® and FHIR® are the registered trademarks of Health Level Seven International