Release 5 Draft Ballot

This page is part of the FHIR Specification (v4.6.0: R5 Draft Ballot - see ballot notes). 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 GroupMaturity Level: 3 Trial UseSecurity Category: Business Compartments: Not linked to any defined compartments

This resource has been identified by FMG as a possible normative candidate for R5; this will be discussed with it's owning committee. Ballot comment is requested on this.

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.

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.

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 Annotation, Identifier, Signature, UsageContext, Account, ActivityDefinition, AdverseEvent, AuditEvent, Basic, BiologicallyDerivedProduct, CapabilityStatement, CapabilityStatement2, CarePlan, CareTeam, CatalogEntry, ChargeItem, Citation, Claim, ClaimResponse, Communication, CommunicationRequest, Composition, Consent, Contract, Coverage, CoverageEligibilityRequest, CoverageEligibilityResponse, Device, DeviceDefinition, DeviceRequest, DeviceUsage, DiagnosticReport, DocumentManifest, DocumentReference, Encounter, Endpoint, EnrollmentRequest, EnrollmentResponse, EpisodeOfCare, EvidenceReport, ExplanationOfBenefit, Flag, Goal, Group, HealthcareService, ImagingStudy, Immunization, ImmunizationEvaluation, ImmunizationRecommendation, Ingredient, InsurancePlan, Invoice, Linkage, Location, ManufacturedItemDefinition, MeasureReport, Medication, MedicationDispense, MedicationKnowledge, MedicationRequest, MedicationUsage, MedicinalProductDefinition, MessageHeader, MolecularSequence, NutritionIntake, NutritionProduct, Observation, ObservationDefinition, itself, OrganizationAffiliation, PackagedProductDefinition, Patient, PaymentNotice, PaymentReconciliation, Permission, Person, PlanDefinition, Practitioner, PractitionerRole, Procedure, Provenance, QuestionnaireResponse, RegulatedAuthorization, RequestGroup, ResearchStudy, ServiceRequest, SpecimenDefinition, SubscriptionTopic, SubstanceDefinition, SupplyDelivery, SupplyRequest, Task and VerificationResult.

This resource implements the ParticipantContactable pattern.

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization TUDomainResourceA grouping of people or organizations with a common purpose
+ Rule: The organization SHALL at least have a name or an identifier, and possibly more than one
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier ΣI0..*IdentifierIdentifies this organization across multiple systems
... active ?!Σ0..1booleanWhether the organization's record is still in active use
... type Σ0..*CodeableConceptKind of organization
OrganizationType (Example)
... alias 0..*stringA list of alternate names that the organization is known as, or was known as in the past
... telecom I0..*ContactPointA contact detail for the organization
+ Rule: The telecom of an organization can never be of use 'home'
... address I0..*AddressAn address for the organization
+ Rule: An address of an organization can never be of use 'home'
... partOf Σ0..1Reference(Organization)The organization of which this organization forms a part
... contact 0..*BackboneElementContact for the organization for a certain purpose
.... purpose 0..1CodeableConceptThe type of contact
ContactEntityType (Extensible)
.... name 0..1HumanNameA name associated with the contact
.... telecom 0..*ContactPointContact details (telephone, email, etc.) for a contact
.... address 0..1AddressVisiting 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

Turtle Template

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


[ 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
  • No Changes

See the Full Difference for further information

This analysis is available as XML or JSON.

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

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization TUDomainResourceA grouping of people or organizations with a common purpose
+ Rule: The organization SHALL at least have a name or an identifier, and possibly more than one
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier ΣI0..*IdentifierIdentifies this organization across multiple systems
... active ?!Σ0..1booleanWhether the organization's record is still in active use
... type Σ0..*CodeableConceptKind of organization
OrganizationType (Example)
... alias 0..*stringA list of alternate names that the organization is known as, or was known as in the past
... telecom I0..*ContactPointA contact detail for the organization
+ Rule: The telecom of an organization can never be of use 'home'
... address I0..*AddressAn address for the organization
+ Rule: An address of an organization can never be of use 'home'
... partOf Σ0..1Reference(Organization)The organization of which this organization forms a part
... contact 0..*BackboneElementContact for the organization for a certain purpose
.... purpose 0..1CodeableConceptThe type of contact
ContactEntityType (Extensible)
.... name 0..1HumanNameA name associated with the contact
.... telecom 0..*ContactPointContact details (telephone, email, etc.) for a contact
.... address 0..1AddressVisiting 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

Turtle Template

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


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

Organization
  • No Changes

See the Full Difference for further information

This analysis is available as XML or JSON.

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

 

See the Profiles & Extensions and the alternate definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) + see the extensions, the spreadsheet version & the dependency analysis a

PathDefinitionTypeReference
Organization.type ExampleOrganizationType
Organization.contact.purpose ExtensibleContactEntityType

idLevelLocationDescriptionExpression
org-1Rule (base)The organization SHALL at least have a name or an identifier, and possibly more than one(identifier.count() + name.count()) > 0
org-2Rule Organization.addressAn address of an organization can never be of use 'home'where(use = 'home').empty()
org-3Rule Organization.telecomThe telecom of an organization can never be of use 'home'where(use = 'home').empty()
  • 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.

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
            Nuclear Medicine Research Trials (edu)
        Maternity Ward
        Childrens Ward
        Day Procedures Unit
    Mobile Services (Ambulance)
    Research Center (edu)
        Nuclear Medicine  (edu)
    Burgers University (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.

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

NameTypeDescriptionExpressionIn Common
active NtokenIs the Organization record activeOrganization.active
addressstringA server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or textOrganization.address
address-city NstringA city specified in an addressOrganization.address.city
address-country NstringA country specified in an addressOrganization.address.country
address-postalcode NstringA postal code specified in an addressOrganization.address.postalCode
address-state NstringA state specified in an addressOrganization.address.state
address-use NtokenA use code specified in an addressOrganization.address.use
endpointreferenceTechnical endpoints providing access to services operated for the organizationOrganization.endpoint
(Endpoint)
identifiertokenAny identifier for the organization (not the accreditation issuer's identifier)Organization.identifier
namestringA portion of the organization's name or aliasOrganization.name | Organization.alias
partofreferenceAn organization of which this organization forms a partOrganization.partOf
(Organization)
phonetic NstringA portion of the organization's name using some kind of phonetic matching algorithmOrganization.name
typetokenA code for the type of organizationOrganization.type