R6 Ballot (2nd Draft)

Publish-box (todo)

Patient Administration icon Work GroupMaturity Level: 5 Trial UseSecurity Category: Business Compartments: No defined compartments

Detailed Descriptions for the elements in the Organization resource.

Organization
Element Id Organization
Definition

A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action.

Short Display A grouping of people or organizations with a common purpose
Cardinality 0..*
Type DomainResource
Summary false
Invariants
Defined on this element
org-1Rule The organization SHALL at least have a name or an identifier, and possibly more than one(identifier.count() + name.count()) > 0
Organization.identifier
Element Id Organization.identifier
Definition

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

Short Display Identifies this organization across multiple systems
Note This is a business identifier, not a resource identifier (see discussion)
Cardinality 0..*
Type Identifier
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.

Summary true
Invariants
Affect this element
org-1Rule The organization SHALL at least have a name or an identifier, and possibly more than one(identifier.count() + name.count()) > 0
Organization.active
Element Id Organization.active
Definition

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

Short Display Whether the organization's record is still in active use
Cardinality 0..1
Type boolean
Is Modifier true (Reason: This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid)
Meaning if Missing This resource is generally assumed to be active if no value is provided for the active element
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.

Summary true
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.

Organization.type
Element Id Organization.type
Definition

The kind(s) of organization that this is.

Short Display Kind of organization
Cardinality 0..*
Terminology Binding Organization Type (Example)
Type CodeableConcept
Requirements

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

Summary true
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.

Organization.name
Element Id Organization.name
Definition

A name associated with the organization.

Short Display Name used for the organization
Cardinality 0..1
Type string
Requirements

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

Summary true
Comments

If the name of an organization changes, consider putting the old name in the alias column so that it can still be located through searches.

Invariants
Affect this element
org-1Rule The organization SHALL at least have a name or an identifier, and possibly more than one(identifier.count() + name.count()) > 0
Organization.alias
Element Id Organization.alias
Definition

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

Short Display A list of alternate names that the organization is known as, or was known as in the past
Cardinality 0..*
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.

Summary false
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.

Organization.description
Element Id Organization.description
Definition

Description of the organization, which helps provide additional general context on the organization to ensure that the correct organization is selected.

Short Display Additional details about the Organization that could be displayed as further information to identify the Organization beyond its name
Cardinality 0..1
Type markdown
Requirements

Humans need additional information to verify a correct Organization has been selected.

Summary true
Organization.contact
Element Id Organization.contact
Definition

The contact details of communication devices available relevant to the specific Organization. This can include addresses, phone numbers, fax numbers, mobile numbers, email addresses and web sites.

Short Display Official contact details for the Organization
Cardinality 0..*
Type ExtendedContactDetail
Requirements

Need to keep track of assigned contact points within bigger organization.

Summary false
Comments

The address/telecom use code 'home' are not to be used. Note that these contacts are not the contact details of people who provide the service (that would be through PractitionerRole), these are official contacts for the Organization itself for specific purposes. E.g. Mailing Addresses, Billing Addresses, Contact numbers for Booking or Billing Enquiries, general web address, web address for online bookings etc.

Invariants
Defined on this element
org-3Rule The telecom of an organization can never be of use 'home'telecom.where(use = 'home').empty()
org-4Rule The address of an organization can never be of use 'home'address.where(use = 'home').empty()
Organization.partOf
Element Id Organization.partOf
Definition

The organization of which this organization forms a part.

Short Display The organization of which this organization forms a part
Cardinality 0..1
Type Reference(Organization)
Hierarchy This reference is part of a strict Hierarchy
Requirements

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

Summary true
Organization.endpoint
Element Id Organization.endpoint
Definition

Technical endpoints providing access to services operated for the organization.

Short Display Technical endpoints providing access to services operated for the organization
Cardinality 0..*
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.

Summary false
Comments

Note that an organization might have endpoints listed in any of the referenced directory resources, not just at the top Organization level (i.e. sub Organizations, Locations, HealthcareServices, PractitionerRoles)

The Endpoint.managingOrganization property indicates the organization that is supporting/managing the technical endpoint.

Organization.qualification
Element Id Organization.qualification
Definition

The official certifications, accreditations, training, designations and licenses that authorize and/or otherwise endorse the provision of care by the organization.

For example, an approval to provide a type of services issued by a certifying body (such as the US Joint Commission) to an organization.

Short Display Qualifications, certifications, accreditations, licenses, training, etc. pertaining to the provision of care
Cardinality 0..*
Summary false
Organization.qualification.identifier
Element Id Organization.qualification.identifier
Definition

An identifier allocated to this qualification for this organization.

Short Display An identifier for this qualification for the organization
Note This is a business identifier, not a resource identifier (see discussion)
Cardinality 0..*
Type Identifier
Requirements

Often, specific identities are assigned for the qualification by the assigning organization.

Summary false
Organization.qualification.code
Element Id Organization.qualification.code
Definition

Coded representation of the qualification.

Short Display Coded representation of the qualification
Cardinality 1..1
Terminology Binding Qualification:
Type CodeableConcept
Summary false
Organization.qualification.status
Element Id Organization.qualification.status
Definition

Qualifications often take time to attain and might be tracked during this time, and completed qualifications might not always be valid. This status concept has some overlap with period and both should be considered together. Refer to the descriptions of the codes for how the period should be interpreted.

If a qualification is revoked or otherwise cancelled, then the period is likely to be ignored, and might be related to when it was active.

Short Display Status/progress of the qualification
Cardinality 0..1
Terminology Binding Qualification Status (Preferred)
Type CodeableConcept
Summary false
Organization.qualification.period
Element Id Organization.qualification.period
Definition

Period during which the qualification is valid.

Short Display Period during which the qualification is valid
Cardinality 0..1
Type Period
Requirements

Qualifications are often for a limited period of time, and can be revoked.

Summary false
Organization.qualification.issuer
Element Id Organization.qualification.issuer
Definition

Organization that regulates and issues the qualification.

Short Display Organization that regulates and issues the qualification
Cardinality 0..1
Type Reference(Organization)
Summary false