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
Todo
Definitions for the cda-organization Profile.
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. |
Control | 1..1 |
Requirements | |
Comments | |
Invariants | Defined 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 resoure. Once assigned, this value never changes. |
Control | 0..1 |
Type | id |
Requirements | |
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. |
Control | 0..1 |
Type | Meta |
Requirements | |
Comments | |
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. |
Control | 0..1 |
Type | uri |
Is Modifier | true |
Requirements | |
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. |
Control | 0..1 |
Binding | A human language The codes SHALL be taken from http://tools.ietf.org/html/bcp47 |
Type | code |
Requirements | |
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. |
Control | 0..1 This element is affected by the following invariants: dom-1 |
Type | Narrative |
Requirements | |
Alternate Names | narrative, 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. |
Control | 0..* |
Type | Resource |
Requirements | |
Alternate Names | inline 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 (http://hl7.org/fhir/ExtensionDefinition/cda-whole-organization) | |
Definition | |
Control | 0..1 |
Type | Reference(Profile = #Organization) |
Requirements | |
Comments | |
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. |
Control | 0..* |
Type | Extension |
Requirements | |
Alternate Names | extensions, 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. |
Control | 0..* This element is affected by the following invariants: org-1 |
Type | Identifier |
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. |
Comments | |
Organization.name | |
Definition | A name associated with the organization. |
Control | 0..1 This element is affected by the following invariants: org-1 |
Type | string |
Requirements | Need to use the name as the label of the organization. |
Comments | |
Organization.type | |
Definition | The kind of organization that this is. |
Control | 0..1 |
Binding | null For codes, see http://hl7.org/fhir/v3/vs/OrganizationIndustryClass |
Type | CodeableConcept |
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.telecom | |
Definition | A contact detail for the organization. |
Control | 0..* This element is affected by the following invariants: org-3 |
Type | ContactPoint |
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. |
Invariants | Defined 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. |
Control | 0..* This element is affected by the following invariants: org-2 |
Type | Address |
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. |
Invariants | Defined on this element org-2: An address of an organization can never be of use 'home' (xpath: count(f:use[@value='home']) = 0) |
Organization.partOf | |
Definition | The organization of which this organization forms a part. |
Control | 0..1 |
Type | Reference(Profile = #Organization) |
Requirements | Need to be able to track the hierarchy of organizations within an organization. |
Comments | |
Organization.partOf.id | |
Definition | unique id for the element within a resource (for internal references). |
Control | 0..1 |
Type | id |
Requirements | |
Comments | |
Organization.partOf.extension (http://hl7.org/fhir/ExtensionDefinition/cda-org-partof-code) | |
Definition | |
Control | 0..1 |
Binding | null For codes, see v3 Code System RoleCode |
Type | CodeableConcept |
Requirements | |
Comments | |
Organization.partOf.extension (http://hl7.org/fhir/ExtensionDefinition/cda-org-partof-statuscode) | |
Definition | |
Control | 0..1 |
Binding | null For codes, see v3 Code System RoleStatus |
Type | CodeableConcept |
Requirements | |
Comments | |
Organization.partOf.extension (http://hl7.org/fhir/ExtensionDefinition/cda-org-partof-effectivetime) | |
Definition | |
Control | 0..1 |
Type | Period |
Requirements | |
Comments | |
Organization.partOf.reference | |
Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
Control | 0..1 This element is affected by the following invariants: ref-1 |
Type | string |
Requirements | |
Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the url conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
Organization.partOf.display | |
Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
Control | 0..1 |
Type | string |
Requirements | |
Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. |
Organization.contact | |
Definition | Contact for the organization for a certain purpose. |
Control | 0..0 |
Requirements | Need to keep track of assigned contact points within bigger organization. |
Comments | |
Organization.contact.id | |
Definition | unique id for the element within a resource (for internal references). |
Control | 0..1 |
Type | id |
Requirements | |
Comments | |
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. |
Control | 0..* |
Type | Extension |
Requirements | |
Alternate Names | extensions, 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. |
Control | 0..* |
Type | Extension |
Requirements | |
Alternate Names | extensions, 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. |
Control | 0..1 |
Binding | The purpose for which you would contact a contact party The codes SHOULD be taken from ContactEntityType; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
Requirements | Need to distinguish between multiple contact persons. |
Comments | |
Organization.contact.name | |
Definition | A name associated with the contact. |
Control | 0..1 |
Type | HumanName |
Requirements | Need to be able to track the person by name. |
Comments | |
Organization.contact.telecom | |
Definition | A contact detail (e.g. a telephone number or an email address) by which the party may be contacted. |
Control | 0..* |
Type | ContactPoint |
Requirements | People have (primary) ways to contact them in some way such as phone, email. |
Comments | |
Organization.contact.address | |
Definition | Visiting or postal addresses for the contact. |
Control | 0..1 |
Type | Address |
Requirements | May need to keep track of a contact party's address for contacting, billing or reporting requirements. |
Comments | |
Organization.contact.gender | |
Definition | Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes. |
Control | 0..1 |
Binding | The gender of a person used for administrative purposes The codes SHALL be taken from AdministrativeGender |
Type | code |
Requirements | Needed to address the person correctly. |
Comments | |
Organization.location | |
Definition | Location(s) the organization uses to provide services. |
Control | 0..0 |
Type | Reference(Profile = (Profile = http://hl7.org/fhir/Profile/Location)) |
Requirements | |
Comments | |
Organization.active | |
Definition | Whether the organization's record is still in active use. |
Control | 0..0 |
Type | boolean |
Is Modifier | true |
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 Value | true |