R4 Ballot #1 (Mixed Normative/Trial use)

This page is part of the FHIR Specification (v3.3.0: R4 Ballot 2). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2

8.6 Resource Organization - Content

Patient Administration

Work Group

Maturity Level: 3

Trial Use

Compartments: Not linked to any defined compartments

A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, etc.

8.6.1 Scope and Usage

This resource may be used in a shared registry of contact and other information for various organizations or it can be used merely as a support for other resources that need to reference organizations, perhaps as a document, message or as a contained resource. If using a registry approach, it's entirely possible for multiple registries to exist, each dealing with different types or levels of organization.

8.6.2 Boundaries and Relationships

The Organization resource is used for collections of people that have come together to achieve an objective. The Group resource is used to identify a collection of people (or animals, devices, etc.) that are gathered for the purpose of analysis or acting upon, but are not expected to act themselves.

The Organization resource often exists as a hierarchy of organization resources, using the part-of property to provide the association of the child to its parent organization.
This organizational hierarchy helps communicate the conceptual structure, whereas the Location resource provides the physical representation of the hierarchy.
The linkage between Organization and Location is from each point in the location hierarchy to the appropriate level in the Organization hierarchy. These links don't all have to be to the top level Organization.
When populating the organization and location hierarchies there is often not a clear distinction between these 2, however to assist in making the decision, Locations are always used for recording where a service occurs, and hence where encounters and observations are associated. The Organization property on these resources might not be the location where the service took place.

This resource is referenced by Account, AuditEvent, BiologicallyDerivedProduct, CarePlan, CareTeam, ChargeItem, Claim, ClaimResponse, Communication, CommunicationRequest, Composition, Consent, Contract, Coverage, Device, DeviceRequest, DiagnosticReport, DocumentManifest, DocumentReference, EligibilityRequest, EligibilityResponse, Encounter, Endpoint, EnrollmentRequest, EnrollmentResponse, EntryDefinition, EpisodeOfCare, ExplanationOfBenefit, Flag, Goal, HealthcareService, ImagingStudy, Immunization, ImmunizationEvaluation, ImmunizationRecommendation, Invoice, Linkage, Location, MeasureReport, Media, Medication, MedicationDispense, MedicationRequest, MedicationStatement, MedicinalProduct, MedicinalProductAuthorization, MedicinalProductDeviceSpec, MedicinalProductIngredient, MedicinalProductPackaged, MessageHeader, Observation, OccupationalData, OrganizationRole, Patient, PaymentNotice, PaymentReconciliation, Person, Practitioner, PractitionerRole, Procedure, ProcessRequest, ProcessResponse, ProductPlan, Provenance, ResearchStudy, Sequence, ServiceRequest, SupplyDelivery, SupplyRequest, Task and VerificationResult

Structure

Name	Flags	Card.	Type	Description & Constraints
Organization	I TU		DomainResource	A grouping of people or organizations with a common purpose + The organization SHALL at least have a name or an id, and possibly more than one Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
identifier	Σ I	0..*	Identifier	Identifies this organization across multiple systems
active	?!Σ	0..1	boolean	Whether the organization's record is still in active use
type	Σ	0..*	CodeableConcept	Kind of organization OrganizationType (Example)
name	Σ I	0..1	string	Name used for the organization
alias		0..*	string	A list of alternate names that the organization is known as, or was known as in the past
telecom	I	0..*	ContactPoint	A contact detail for the organization + The telecom of an organization can never be of use 'home'
address	I	0..*	Address	An address for the organization + An address of an organization can never be of use 'home'
partOf	Σ	0..1	Reference(Organization)	The organization of which this organization forms a part
contact		0..*	BackboneElement	Contact for the organization for a certain purpose
purpose		0..1	CodeableConcept	The type of contact ContactEntityType (Extensible)
name		0..1	HumanName	A name associated with the contact
telecom		0..*	ContactPoint	Contact details (telephone, email, etc.) for a contact
address		0..1	Address	Visiting or postal addresses for the contact
endpoint		0..*	Reference(Endpoint)	Technical endpoints providing access to services operated for the organization
Documentation for this format

UML Diagram (Legend)

XML Template

<Organization xmlns="http://hl7.org/fhir"> 
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!--  0..* Identifier Identifies this organization  across multiple systems --></identifier>
 <active value="[boolean]"/><!-- 0..1 Whether the organization's record is still in active use -->
 <type><!-- 0..* CodeableConcept Kind of organization --></type>
 <name value="[string]"/><!--  0..1 Name used for the organization -->
 <alias value="[string]"/><!-- 0..* A list of alternate names that the organization is known as, or was known as in the past -->
 <telecom><!--  0..* ContactPoint A contact detail for the organization --></telecom>
 <address><!--  0..* Address An address for the organization --></address>
 <partOf><!-- 0..1 Reference(Organization) The organization of which this organization forms a part --></partOf>
 <contact>  <!-- 0..* Contact for the organization for a certain purpose -->
  <purpose><!-- 0..1 CodeableConcept The type of contact --></purpose>
  <name><!-- 0..1 HumanName A name associated with the contact --></name>
  <telecom><!-- 0..* ContactPoint Contact details (telephone, email, etc.)  for a contact --></telecom>
  <address><!-- 0..1 Address Visiting or postal addresses for the contact --></address>
 </contact>
 <endpoint><!-- 0..* Reference(Endpoint) Technical endpoints providing access to services operated for the organization --></endpoint>
</Organization>

JSON Template

{
  "resourceType" : "Organization",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // C? Identifies this organization  across multiple systems
  "active" : <boolean>, // Whether the organization's record is still in active use
  "type" : [{ CodeableConcept }], // Kind of organization
  "name" : "<string>", // C? Name used for the organization
  "alias" : ["<string>"], // A list of alternate names that the organization is known as, or was known as in the past
  "telecom" : [{ ContactPoint }], // C? A contact detail for the organization
  "address" : [{ Address }], // C? An address for the organization
  "partOf" : { Reference(Organization) }, // The organization of which this organization forms a part
  "contact" : [{ // Contact for the organization for a certain purpose
    "purpose" : { CodeableConcept }, // The type of contact
    "name" : { HumanName }, // A name associated with the contact
    "telecom" : [{ ContactPoint }], // Contact details (telephone, email, etc.)  for a contact
    "address" : { Address } // Visiting or postal addresses for the contact
  }],
  "endpoint" : [{ Reference(Endpoint) }] // Technical endpoints providing access to services operated for the organization
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .


[ a fhir:Organization;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:Organization.identifier [ Identifier ], ... ; # 0..* Identifies this organization  across multiple systems
  fhir:Organization.active [ boolean ]; # 0..1 Whether the organization's record is still in active use
  fhir:Organization.type [ CodeableConcept ], ... ; # 0..* Kind of organization
  fhir:Organization.name [ string ]; # 0..1 Name used for the organization
  fhir:Organization.alias [ string ], ... ; # 0..* A list of alternate names that the organization is known as, or was known as in the past
  fhir:Organization.telecom [ ContactPoint ], ... ; # 0..* A contact detail for the organization
  fhir:Organization.address [ Address ], ... ; # 0..* An address for the organization
  fhir:Organization.partOf [ Reference(Organization) ]; # 0..1 The organization of which this organization forms a part
  fhir:Organization.contact [ # 0..* Contact for the organization for a certain purpose
    fhir:Organization.contact.purpose [ CodeableConcept ]; # 0..1 The type of contact
    fhir:Organization.contact.name [ HumanName ]; # 0..1 A name associated with the contact
    fhir:Organization.contact.telecom [ ContactPoint ], ... ; # 0..* Contact details (telephone, email, etc.)  for a contact
    fhir:Organization.contact.address [ Address ]; # 0..1 Visiting or postal addresses for the contact
  ], ...;
  fhir:Organization.endpoint [ Reference(Endpoint) ], ... ; # 0..* Technical endpoints providing access to services operated for the organization
]

Changes since R3

Organization

Organization.active

Default Value "true" removed

See the Full Difference for further information

This analysis is available as XML or JSON.

See R2 <--> R3 Conversion Maps (status = 14 tests that all execute ok. All tests pass round-trip testing and 2 r3 resources are invalid (2 errors).). Note: these have note yet been updated to be R3 to R4

Structure

Name	Flags	Card.	Type	Description & Constraints
Organization	I TU		DomainResource	A grouping of people or organizations with a common purpose + The organization SHALL at least have a name or an id, and possibly more than one Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
identifier	Σ I	0..*	Identifier	Identifies this organization across multiple systems
active	?!Σ	0..1	boolean	Whether the organization's record is still in active use
type	Σ	0..*	CodeableConcept	Kind of organization OrganizationType (Example)
name	Σ I	0..1	string	Name used for the organization
alias		0..*	string	A list of alternate names that the organization is known as, or was known as in the past
telecom	I	0..*	ContactPoint	A contact detail for the organization + The telecom of an organization can never be of use 'home'
address	I	0..*	Address	An address for the organization + An address of an organization can never be of use 'home'
partOf	Σ	0..1	Reference(Organization)	The organization of which this organization forms a part
contact		0..*	BackboneElement	Contact for the organization for a certain purpose
purpose		0..1	CodeableConcept	The type of contact ContactEntityType (Extensible)
name		0..1	HumanName	A name associated with the contact
telecom		0..*	ContactPoint	Contact details (telephone, email, etc.) for a contact
address		0..1	Address	Visiting or postal addresses for the contact
endpoint		0..*	Reference(Endpoint)	Technical endpoints providing access to services operated for the organization
Documentation for this format

UML Diagram (Legend)

XML Template

<Organization xmlns="http://hl7.org/fhir"> 
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!--  0..* Identifier Identifies this organization  across multiple systems --></identifier>
 <active value="[boolean]"/><!-- 0..1 Whether the organization's record is still in active use -->
 <type><!-- 0..* CodeableConcept Kind of organization --></type>
 <name value="[string]"/><!--  0..1 Name used for the organization -->
 <alias value="[string]"/><!-- 0..* A list of alternate names that the organization is known as, or was known as in the past -->
 <telecom><!--  0..* ContactPoint A contact detail for the organization --></telecom>
 <address><!--  0..* Address An address for the organization --></address>
 <partOf><!-- 0..1 Reference(Organization) The organization of which this organization forms a part --></partOf>
 <contact>  <!-- 0..* Contact for the organization for a certain purpose -->
  <purpose><!-- 0..1 CodeableConcept The type of contact --></purpose>
  <name><!-- 0..1 HumanName A name associated with the contact --></name>
  <telecom><!-- 0..* ContactPoint Contact details (telephone, email, etc.)  for a contact --></telecom>
  <address><!-- 0..1 Address Visiting or postal addresses for the contact --></address>
 </contact>
 <endpoint><!-- 0..* Reference(Endpoint) Technical endpoints providing access to services operated for the organization --></endpoint>
</Organization>

JSON Template

{
  "resourceType" : "Organization",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // C? Identifies this organization  across multiple systems
  "active" : <boolean>, // Whether the organization's record is still in active use
  "type" : [{ CodeableConcept }], // Kind of organization
  "name" : "<string>", // C? Name used for the organization
  "alias" : ["<string>"], // A list of alternate names that the organization is known as, or was known as in the past
  "telecom" : [{ ContactPoint }], // C? A contact detail for the organization
  "address" : [{ Address }], // C? An address for the organization
  "partOf" : { Reference(Organization) }, // The organization of which this organization forms a part
  "contact" : [{ // Contact for the organization for a certain purpose
    "purpose" : { CodeableConcept }, // The type of contact
    "name" : { HumanName }, // A name associated with the contact
    "telecom" : [{ ContactPoint }], // Contact details (telephone, email, etc.)  for a contact
    "address" : { Address } // Visiting or postal addresses for the contact
  }],
  "endpoint" : [{ Reference(Endpoint) }] // Technical endpoints providing access to services operated for the organization
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .


[ a fhir:Organization;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:Organization.identifier [ Identifier ], ... ; # 0..* Identifies this organization  across multiple systems
  fhir:Organization.active [ boolean ]; # 0..1 Whether the organization's record is still in active use
  fhir:Organization.type [ CodeableConcept ], ... ; # 0..* Kind of organization
  fhir:Organization.name [ string ]; # 0..1 Name used for the organization
  fhir:Organization.alias [ string ], ... ; # 0..* A list of alternate names that the organization is known as, or was known as in the past
  fhir:Organization.telecom [ ContactPoint ], ... ; # 0..* A contact detail for the organization
  fhir:Organization.address [ Address ], ... ; # 0..* An address for the organization
  fhir:Organization.partOf [ Reference(Organization) ]; # 0..1 The organization of which this organization forms a part
  fhir:Organization.contact [ # 0..* Contact for the organization for a certain purpose
    fhir:Organization.contact.purpose [ CodeableConcept ]; # 0..1 The type of contact
    fhir:Organization.contact.name [ HumanName ]; # 0..1 A name associated with the contact
    fhir:Organization.contact.telecom [ ContactPoint ], ... ; # 0..* Contact details (telephone, email, etc.)  for a contact
    fhir:Organization.contact.address [ Address ]; # 0..1 Visiting or postal addresses for the contact
  ], ...;
  fhir:Organization.endpoint [ Reference(Endpoint) ], ... ; # 0..* Technical endpoints providing access to services operated for the organization
]

Changes since DSTU2

Organization

Organization.active

Default Value "true" removed

See the Full Difference for further information

This analysis is available as XML or JSON.

See R2 <--> R3 Conversion Maps (status = 14 tests that all execute ok. All tests pass round-trip testing and 2 r3 resources are invalid (2 errors).). Note: these have note yet been updated to be R3 to R4

Alternate definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) + see the extensions & the dependency analysis

8.6.3.1 Terminology Bindings

Path	Definition	Type	Reference
Organization.type	Used to categorize the organization	Example	OrganizationType
Organization.contact.purpose	The purpose for which you would contact a contact party	Extensible	ContactEntityType

Path

Definition

Type

Reference

Organization.type

Used to categorize the organization

Example

OrganizationType

Organization.contact.purpose

The purpose for which you would contact a contact party

Extensible

ContactEntityType

8.6.3.2 Constraints

org-1: The organization SHALL at least have a name or an id, and possibly more than one (expression : (identifier.count() + name.count()) > 0)
org-2: On Organization.address: An address of an organization can never be of use 'home' (expression on Organization.address: where(use = 'home').empty())
org-3: On Organization.telecom: The telecom of an organization can never be of use 'home' (expression on Organization.telecom: where(use = 'home').empty())

8.6.4 Notes:

There are two places for contact information: one on Organization itself and zero or more using the ContactEntity construct. The first one is to be used for the generic, public organization point of contact. The ContactEntity is to be used for reaching a person or party that has been designated by the organization to be contacted for a specific purpose or goal.

8.6.5 Example Organization Hierarchy:

An example organization hierarchy should help give some guidance as to one example of how a location hierarchy could look within a fictitious Medical Organization.
(The nesting here would be the "part-of" structure of the Organization resource)

Burgers University Medical Center
    Eastern Services (prov)
        Emergency Dept
        Oncology Dept
            Neuclear Medicine Research Trials (edu)
        Maternity Ward
        Childrens Ward
        Day Procedures Unit
    Mobile Services (Ambulance)
    Research Center (edu)
        Neuclear Medicine  (edu)
    Burgers University (edu)
        Neuclear Medicine Faculty (edu)
        Undergraduate Medicine (edu)
        ...

Note that physical structures of this hierarchy are not present - these are defined by a Location hierarchy.

8.6.6 Search Parameters

Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

Name	Type	Description	Expression	In Common
active	token	Is the Organization record active	Organization.active
address	string	A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text	Organization.address
address-city	string	A city specified in an address	Organization.address.city
address-country	string	A country specified in an address	Organization.address.country
address-postalcode	string	A postal code specified in an address	Organization.address.postalCode
address-state	string	A state specified in an address	Organization.address.state
address-use	token	A use code specified in an address	Organization.address.use
endpoint	reference	Technical endpoints providing access to services operated for the organization	Organization.endpoint (Endpoint)
identifier	token	Any identifier for the organization (not the accreditation issuer's identifier)	Organization.identifier
name	string	A portion of the organization's name or alias	Organization.name \| Organization.alias
partof	reference	An organization of which this organization forms a part	Organization.partOf (Organization)
phonetic	string	A portion of the organization's name using some kind of phonetic matching algorithm	Organization.name
type	token	A code for the type of organization	Organization.type