FHIR Release 3 (STU) Current Build

8.6 Resource Organization - Content

Patient Administration Work Group Maturity Level : 3   Trial Use Security Category : Business 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, payer/insurer, 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 may might not be the location where the service took place.

This resource is referenced by Annotation , Identifier , Signature , UsageContext , Account , AuditEvent , Basic , BiologicallyDerivedProduct , CapabilityStatement , CarePlan , CareTeam , CatalogEntry , ChargeItem , Claim , ClaimResponse , Communication , CommunicationRequest , Composition , Consent , Contract , Coverage , CoverageEligibilityRequest , CoverageEligibilityResponse , Device , DeviceDefinition , DeviceRequest , DiagnosticReport , DocumentManifest , DocumentReference , EligibilityRequest , EligibilityResponse , Encounter , Endpoint , EnrollmentRequest , EnrollmentResponse , EpisodeOfCare , ExplanationOfBenefit , Flag , Goal , Group , HealthcareService , ImagingManifest ImagingStudy , Immunization , ImmunizationEvaluation , ImmunizationRecommendation , InsurancePlan , Invoice , Linkage , Location , MeasureReport , Medication Media , MedicationAdministration Medication , MedicationDispense , MedicationKnowledge , MedicationRequest , MedicationStatement , MedicinalProduct , MedicinalProductAuthorization , MedicinalProductIngredient , MedicinalProductManufactured , MedicinalProductPackaged , MessageHeader , MolecularSequence , Observation , itself, OrganizationAffiliation , Patient , PaymentNotice , PaymentReconciliation , Person , Practitioner , PractitionerRole , Procedure , ProcedureRequest , ProcessRequest , ProcessResponse , Provenance , ReferralRequest QuestionnaireResponse , ResearchStudy , Sequence ServiceRequest , SupplyDelivery , SupplyRequest , Task and Task VerificationResult

8.6.3 Resource Content

Structure

Name Flags Card. Type Description & Constraints doco
. . Organization I TU DomainResource A grouping of people or organizations with a common purpose
+ Rule: The organization SHALL at least have a name or an id, identifier, 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 Organization type ( Example )
. . . name Σ I 0..1 string Name used for the organization
. . . alias 0..* string A list of alternate 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
+ Rule: The telecom of an organization can never be of use 'home'
. . . address I 0..* Address An address for the organization
+ Rule: 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 Contact entity type ( 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

doco Documentation for this format

UML Diagram ( Legend )

Organization ( DomainResource ) Identifier for the organization that is used to identify the organization across multiple disparate systems identifier : Identifier [0..*] Whether the organization's record is still in active use (this element modifies the meaning of other elements) active : boolean [0..1] The kind(s) of organization that this is type : CodeableConcept [0..*] « Used to categorize the organization organization. (Strength=Example) OrganizationType ?? » A name associated with the organization name : string [0..1] A list ofalternate of alternate names that the organization is known as, or was known as in the past alias : string [0..*] A contact detail for the organization telecom : ContactPoint [0..*] An address for the organization address : Address [0..*] The organization of which this organization forms a part partOf : Reference [0..1] « Organization » Technical endpoints providing access to services operated for the organization endpoint : Reference [0..*] « Endpoint » Contact Indicates a purpose for which the contact can be reached purpose : CodeableConcept [0..1] « The purpose for which you would contact a contact party party. (Strength=Extensible) ContactEntityType + » A name associated with the contact name : HumanName [0..1] A contact detail (e.g. a telephone number or an email address) by which the party may be contacted telecom : ContactPoint [0..*] Visiting or postal addresses for the contact address : Address [0..1] Contact for the organization for a certain purpose contact [0..*]

XML Template

Turtle Template 

@prefix fhir: <http://hl7.org/fhir/> .doco
[ a 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:

  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 R3

Organization Organization.type Max Cardinality changed from 1 to *
Organization.alias Organization.active
  • Added Element Default Value "true" removed
Organization.endpoint Organization.contact.purpose
  • Added Element Change code system for extensibly bound codes from "http://hl7.org/fhir/contactentity-type" to "http://terminology.hl7.org/CodeSystem/contactentity-type"

See the Full Difference for further information

This analysis is available as XML or JSON .

See R2 <--> R3 <--> R4 Conversion Maps (status = 14 11 tests that all execute ok. All tests pass round-trip testing and 2 1 r3 resources are invalid (2 (0 errors). ). )

Structure

Name Flags Card. Type Description & Constraints doco
. . Organization I TU DomainResource A grouping of people or organizations with a common purpose
+ Rule: The organization SHALL at least have a name or an id, identifier, 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 Organization type ( Example )
. . . name Σ I 0..1 string Name used for the organization
. . . alias 0..* string A list of alternate 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
+ Rule: The telecom of an organization can never be of use 'home'
. . . address I 0..* Address An address for the organization
+ Rule: 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 Contact entity type ( 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

doco Documentation for this format

UML Diagram ( Legend )

Organization ( DomainResource ) Identifier for the organization that is used to identify the organization across multiple disparate systems identifier : Identifier [0..*] Whether the organization's record is still in active use (this element modifies the meaning of other elements) active : boolean [0..1] The kind(s) of organization that this is type : CodeableConcept [0..*] « Used to categorize the organization organization. (Strength=Example) OrganizationType ?? » A name associated with the organization name : string [0..1] A list ofalternate of alternate names that the organization is known as, or was known as in the past alias : string [0..*] A contact detail for the organization telecom : ContactPoint [0..*] An address for the organization address : Address [0..*] The organization of which this organization forms a part partOf : Reference [0..1] « Organization » Technical endpoints providing access to services operated for the organization endpoint : Reference [0..*] « Endpoint » Contact Indicates a purpose for which the contact can be reached purpose : CodeableConcept [0..1] « The purpose for which you would contact a contact party party. (Strength=Extensible) ContactEntityType + » A name associated with the contact name : HumanName [0..1] A contact detail (e.g. a telephone number or an email address) by which the party may be contacted telecom : ContactPoint [0..*] Visiting or postal addresses for the contact address : Address [0..1] Contact for the organization for a certain purpose contact [0..*]

XML Template

Turtle Template 

@prefix fhir: <http://hl7.org/fhir/> .doco
[ a 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:

  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 Release 3

Organization Organization.type Max Cardinality changed from 1 to *
Organization.alias Organization.active
  • Added Element Default Value "true" removed
Organization.endpoint Organization.contact.purpose
  • Added Element Change code system for extensibly bound codes from "http://hl7.org/fhir/contactentity-type" to "http://terminology.hl7.org/CodeSystem/contactentity-type"

See the Full Difference for further information

This analysis is available as XML or JSON .

See R2 <--> R3 <--> R4 Conversion Maps (status = 14 11 tests that all execute ok. All tests pass round-trip testing and 2 1 r3 resources are invalid (2 (0 errors). ). )

 

Alternate See the Profiles & Extensions and the alternate definitions: Master Definition ( XML , + JSON ), , XML Schema / Schematron (for ) + 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 organization. Example OrganizationType
Organization.contact.purpose The purpose for which you would contact a contact party party. Extensible ContactEntityType

8.6.3.2 Constraints

id Level Location Description Expression
org-1 : Rule (base) The organization SHALL at least have a name or an id, identifier, and possibly more than one ( expression : (identifier.count() + name.count()) > 0 )
org-2 : On Organization.address: Rule 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: Rule 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)

            Nuclear Medicine Research Trials (edu)

        Maternity Ward
        Childrens Ward
        Day Procedures Unit
    Mobile Services (Ambulance)
    Research Center (edu)
        Neuclear Medicine  (edu)

        Nuclear Medicine  (edu)

    Burgers University (edu)
        Neuclear Medicine Faculty (edu)

        Nuclear 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 A server defined search that may match any of the string fields in Is the Address, including line, city, state, country, postalCode, and/or text Organization record active Organization.active
address string A (part of the) address server defined search that may match any of the organization 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