DSTU2 QA Preview

This page is part of the FHIR Specification (v1.0.0: DSTU 2 Ballot 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

F.??.4 StructureDefinition: QICore-Organization - Detailed Descriptions

Definitions for the qicore-organization Profile.

Organization(QICore-Organization)
Definition

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.

Control0..*
TypeOrganization
InvariantsDefined on this element
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)
Organization.id
Definition

The logical id of the resource, as used in the url for the resource. Once assigned, this value never changes.

Control0..1
Typeid
Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.

Organization.meta
Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.

Control0..1
TypeMeta
Organization.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.

Control0..1
Typeuri
Is Modifiertrue
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element as much as possible.

Organization.language
Definition

The base language in which the resource is written.

Control0..1
BindingA human language
The codes SHALL be taken from http://tools.ietf.org/html/bcp47
Typecode
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

Organization.text
Definition

A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

Control0..1 This element is affected by the following invariants: dom-1
TypeNarrative
Alternate Namesnarrative, html, xhtml, display
Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.

Organization.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

Control0..*
TypeResource
Alternate Namesinline resources, anonymous resources, contained resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.

Organization.extension
Definition

May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Organization.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Organization.identifier
Definition

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

Control0..* This element is affected by the following invariants: org-1
TypeIdentifier
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.

Organization.active
Definition

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

Control0..1
Typeboolean
Is Modifiertrue
Must Supporttrue
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.

Comments

Default is true.

Default Valuetrue
Organization.type
Definition

The kind of organization that this is.

Control0..1
BindingUsed to categorize the organization
For example codes, see OrganizationType
TypeCodeableConcept
Must Supporttrue
Requirements

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

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.

Organization.name
Definition

A name associated with the organization.

Control0..1 This element is affected by the following invariants: org-1
Typestring
Requirements

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

Organization.telecom
Definition

A contact detail for the organization.

Control0..* This element is affected by the following invariants: org-3
TypeContactPoint
Requirements

Human contact for the organization.

Comments

The use code home is not to be used. Note that these contacts are not the contact details of people who are employed by or represent the organization, but official contacts for the organization itself.

InvariantsDefined on this element
org-3: The telecom of an organization can never be of use 'home' (xpath: count(f:use[@value='home']) = 0)
Organization.address
Definition

An address for the organization.

Control0..* This element is affected by the following invariants: org-2
TypeAddress
Requirements

May need to keep track of the organization's addresses for contacting, billing or reporting requirements.

Comments

Organization may have multiple addresses with different uses or applicable periods. The use code home is not to be used.

InvariantsDefined on this element
org-2: An address of an organization can never be of use 'home' (xpath: count(f:use[@value='home']) = 0)
Organization.address.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Organization.address.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Organization.address.use
Definition

The purpose of this address.

Control0..1
BindingThe use of an address
The codes SHALL be taken from AddressUse
Typecode
Is Modifiertrue
Requirements

Allows an appropriate address to be chosen from a list of many.

Comments

This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc for a current/permanent one. Applications can assume that an address is current unless it explicitly says that it is temporary or old.

Examplehome
Organization.address.type
Definition

Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.

Control0..1
BindingThe type of an address (physical / postal)
The codes SHALL be taken from AddressType
Typecode
Exampleboth
Organization.address.text
Definition

A full text representation of the address.

Control0..1
Typestring
Requirements

A renderable, unencoded form.

Comments

Can provide both a text representation and parts.

Example137 Nowhere Street, Erewhon 9132
Organization.address.line
Definition

This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.

Control0..*
Typestring
Requirements

home | work | temp | old - purpose of this address.

Example137 Nowhere Street
Organization.address.city
Definition

The name of the city, town, village or other community or delivery center.

Control0..1
Typestring
Alternate NamesMuncipality
ExampleErewhon
Organization.address.district
Definition

The name of the administrative area (county).

Control0..1
Typestring
Alternate NamesCounty
Comments

District is sometimes known as county, but in some regions 'county' in used in place of city (municipality), so county name should be conveyed in city instead.

ExampleMadison
Organization.address.state
Definition

Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (i.e. US 2 letter state codes).

Control0..1
BindingTwo letter USPS alphabetic codes.
The codes SHOULD be taken from USPS Two Letter Alphabetic Codes
Typestring
Alternate NamesProvince, Territory
Organization.address.postalCode
Definition

A postal code designating a region defined by the postal service.

Control0..1
Typestring
Alternate NamesZip
Example9132
Organization.address.country
Definition

Country - a nation as commonly understood or generally accepted.

Control0..1
Typestring
Comments

ISO 3166 3 letter codes can be used in place of a full country name.

Organization.address.period
Definition

Time period when address was/is in use.

Control0..1
TypePeriod
Requirements

Allows addresses to be placed in historical context.

Example&lt;valuePeriod&nbsp;xmlns=&quot;http://hl7.org/fhir&quot;&gt;<br/>&nbsp;&nbsp;&lt;start&nbsp;value=&quot;2010-03-23&quot;/&gt;<br/>&nbsp;&nbsp;&lt;end&nbsp;value=&quot;2010-07-01&quot;/&gt;<br/>&lt;/valuePeriod&gt;<br/>
Organization.partOf
Definition

The organization of which this organization forms a part.

Control0..1
TypeReference(QICore-Organization)
Requirements

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

Organization.contact
Definition

Contact for the organization for a certain purpose.

Control0..*
TypeBackboneElement
Requirements

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

Comments

Where multiple contacts for the same purpose are provided there is a standard extension that can be used to determine which one is the preferred contact to use.

Organization.contact.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Organization.contact.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Organization.contact.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Organization.contact.purpose
Definition

Indicates a purpose for which the contact can be reached.

Control0..1
BindingThe purpose for which you would contact a contact party
The codes SHALL be taken from ContactEntityType; other codes may be used where these codes are not suitable
TypeCodeableConcept
Requirements

Need to distinguish between multiple contact persons.

Organization.contact.name
Definition

A name associated with the contact.

Control0..1
TypeHumanName
Requirements

Need to be able to track the person by name.

Organization.contact.telecom
Definition

A contact detail (e.g. a telephone number or an email address) by which the party may be contacted.

Control0..*
TypeContactPoint
Requirements

People have (primary) ways to contact them in some way such as phone, email.

Organization.contact.address
Definition

Visiting or postal addresses for the contact.

Control0..1
TypeAddress
Requirements

May need to keep track of a contact party's address for contacting, billing or reporting requirements.