2nd DSTU Draft For Comment

This page is part of the FHIR Specification (v0.4.0: DSTU 2 Draft). 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

5.5 Resource Organization - Content

This resource maintained by the Patient Administration Work Group

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.

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

5.5.2 Boundaries and Relationships

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

This resource is referenced by CarePlan, CarePlan2, ClaimResponse, Communication, CommunicationRequest, Composition, Contract, Coverage, Device, DiagnosticReport, DocumentManifest, DocumentReference, EligibilityRequest, EligibilityResponse, Encounter, EnrollmentRequest, EnrollmentResponse, EpisodeOfCare, ExplanationOfBenefit, ImagingObjectSelection, Immunization, ImmunizationRecommendation, InstitutionalClaim, Location, Medication, MessageHeader, Observation, OralHealthClaim, Order, OrderResponse, Patient, PaymentNotice, PaymentReconciliation, PendedRequest, Person, PharmacyClaim, Practitioner, ProcedureRequest, ProfessionalClaim, Readjudicate, ReferralRequest, Reversal, StatusRequest, StatusResponse, SupportingDocumentation and VisionClaim

5.5.3 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization IDomainResourceA 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
... identifier I0..*IdentifierIdentifies this organization across multiple systems
... name I0..1stringName used for the organization
... type 0..1CodeableConceptKind of organization
OrganizationType (Example)
... telecom I0..*ContactPointA contact detail for the organization
The telecom of an organization can never be of use 'home'
... address I0..*AddressAn address for the organization
An address of an organization can never be of use 'home'
... partOf 0..1OrganizationThe organization of which this organization forms a part
... contact 0..*ElementContact for the organization for a certain purpose
.... purpose 0..1CodeableConceptThe type of contact
ContactPartyType (Incomplete)
.... 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
.... gender 0..1codemale | female | other | unknown
AdministrativeGender (Required)
... location 0..*LocationLocation(s) the organization uses to provide services
... active M0..1booleanWhether the organization's record is still in active use

XML Template

<Organization xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- ?? 0..* Identifier Identifies this organization  across multiple systems --></identifier>
 <name value="[string]"/><!-- ?? 0..1 Name used for the organization -->
 <type><!-- 0..1 CodeableConcept Kind of organization --></type>
 <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>
  <gender value="[code]"/><!-- 0..1 male | female | other | unknown -->
 </contact>
 <location><!-- 0..* Reference(Location) 
     Location(s) the organization uses to provide services --></location>
 <active value="[boolean]"/><!-- 0..1 Whether the organization's record is still in active use -->
</Organization>

JSON Template

{doco
  "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
  "name" : "<string>", // C? Name used for the organization
  "type" : { CodeableConcept }, // Kind of organization
  "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
    "gender" : "<code>" // male | female | other | unknown
  }],
  "location" : [{ Reference(Location) }], // 
     Location(s) the organization uses to provide services
  "active" : <boolean> // Whether the organization's record is still in active use
}

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization IDomainResourceA 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
... identifier I0..*IdentifierIdentifies this organization across multiple systems
... name I0..1stringName used for the organization
... type 0..1CodeableConceptKind of organization
OrganizationType (Example)
... telecom I0..*ContactPointA contact detail for the organization
The telecom of an organization can never be of use 'home'
... address I0..*AddressAn address for the organization
An address of an organization can never be of use 'home'
... partOf 0..1OrganizationThe organization of which this organization forms a part
... contact 0..*ElementContact for the organization for a certain purpose
.... purpose 0..1CodeableConceptThe type of contact
ContactPartyType (Incomplete)
.... 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
.... gender 0..1codemale | female | other | unknown
AdministrativeGender (Required)
... location 0..*LocationLocation(s) the organization uses to provide services
... active M0..1booleanWhether the organization's record is still in active use

XML Template

<Organization xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- ?? 0..* Identifier Identifies this organization  across multiple systems --></identifier>
 <name value="[string]"/><!-- ?? 0..1 Name used for the organization -->
 <type><!-- 0..1 CodeableConcept Kind of organization --></type>
 <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>
  <gender value="[code]"/><!-- 0..1 male | female | other | unknown -->
 </contact>
 <location><!-- 0..* Reference(Location) 
     Location(s) the organization uses to provide services --></location>
 <active value="[boolean]"/><!-- 0..1 Whether the organization's record is still in active use -->
</Organization>

JSON Template

{doco
  "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
  "name" : "<string>", // C? Name used for the organization
  "type" : { CodeableConcept }, // Kind of organization
  "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
    "gender" : "<code>" // male | female | other | unknown
  }],
  "location" : [{ Reference(Location) }], // 
     Location(s) the organization uses to provide services
  "active" : <boolean> // Whether the organization's record is still in active use
}

 

Alternate definitions: Schema/Schematron, Resource Profile (XML, JSON), Questionnaire

5.5.3.1 Terminology Bindings

PathDefinitionTypeReference
Organization.type Used to categorize the organizationExamplehttp://hl7.org/fhir/vs/organization-type
Organization.contact.purpose The purpose for which you would contact a contact partyIncompletehttp://hl7.org/fhir/vs/contactentity-type
Organization.contact.gender The gender of a person used for administrative purposesFixedhttp://hl7.org/fhir/administrative-gender

5.5.3.2 Constraints

  • org-1: The organization SHALL at least have a name or an id, and possibly more than one (xpath: count(f:identifier | f:name) > 0)
  • org-2: On Organization.address: An address of an organization can never be of use 'home' (xpath on f:Organization/f:address: count(f:use[@value='home']) = 0)
  • org-3: On Organization.telecom: The telecom of an organization can never be of use 'home' (xpath on f:Organization/f:telecom: count(f:use[@value='home']) = 0)

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

5.5.5 Search Parameters

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

NameTypeDescriptionPaths
activetokenWhether the organization's record is activeOrganization.active
identifiertokenAny identifier for the organization (not the accreditation issuer's identifier)Organization.identifier
namestringA portion of the organization's nameOrganization.name
partofreferenceSearch all organizations that are part of the given organizationOrganization.partOf
(Organization)
phoneticstringA portion of the organization's name using some kind of phonetic matching algorithm
typetokenA code for the type of organizationOrganization.type