| Organization | C | | http://hl7.org/fhir/StructureDefinition/DomainResource | Element idOrganization Short descriptionA grouping of people or organizations with a common purpose DefinitionA 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.
http://hl7.org/fhir/StructureDefinition/DomainResource Constraints- dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.empty() - dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative
contained.text.empty() - dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() - dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
contained.where(('#'+id in %resource.descendants().reference).not()).empty() - org-1: The organization SHALL at least have a name or an id, and possibly more than one
(identifier.count() + name.count()) > 0
Mappings- rim: Entity. Role, or Act
- v2: (also see master files messages)
- rim: Organization(classCode=ORG, determinerCode=INST)
- servd: Organization
- w5: administrative.group
|
| id | Σ | 0..1 | id | There are no (further) constraints on this element Element idOrganization.id Short descriptionLogical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
id |
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idOrganization.meta Short descriptionMetadata about the resource DefinitionThe 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.
Meta |
| implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idOrganization.implicitRules Short descriptionA set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.
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.
This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.
uri |
| language | | 0..1 | codeBinding | There are no (further) constraints on this element Element idOrganization.language Short descriptionLanguage of the resource content DefinitionThe base language in which the resource is written.
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).
code BindingA human language. http://hl7.org/fhir/ValueSet/languages (extensible) Binding extensions |
| text | C | 0..1 | Narrative | There are no (further) constraints on this element Element idOrganization.text Short descriptionText summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA 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.
Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later.
Narrative ConditionsThe cardinality or value of this element may be affected by these constraints: dom-1 Mappings |
| contained | | 0..* | Resource | There are no (further) constraints on this element Element idOrganization.contained Short descriptionContained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese 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.
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.
Resource Mappings |
| extension | | 0..* | Extension | There are no (further) constraints on this element Element idOrganization.extension Short descriptionAdditional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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.
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.
Extension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url Mappings |
| modifierExtension | ?! | 0..* | Extension | There are no (further) constraints on this element Element idOrganization.modifierExtension Short descriptionExtensions that cannot be ignored Alternate namesextensions, user content DefinitionMay 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.
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.
Extension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url Mappings |
| identifier | Σ C | 0..* | Identifier | There are no (further) constraints on this element Element idOrganization.identifier Short descriptionIdentifies this organization across multiple systems DefinitionIdentifier for the organization that is used to identify the organization across multiple disparate systems.
Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization.
Identifier ConditionsThe cardinality or value of this element may be affected by these constraints: org-1 Mappings- v2: XON.10 / XON.3
- rim: .scopes[Role](classCode=IDENT)
- servd: ./Identifiers
- w5: id
|
| active | Σ ?! | 0..1 | boolean | There are no (further) constraints on this element Element idOrganization.active Short descriptionWhether the organization's record is still in active use DefinitionWhether the organization's record is still in active use.
Need a flag to indicate a record is no longer to be used and should generally be hidden for the user in the UI.
Default is true.
This active flag is not intended to be used to mark an organizations as temporarily closed or under construction. Instead the Location(s) within the Organization should have the suspended status. If further details of the reason for the suspension are required, then an extension on this element should be used.
This element is labeled as a modifier because it may be used to mark that the resource was created in error.
boolean Default valuetrue Mappings- v2: No equivalent in HL7 v2
- rim: .status
- servd: ./Status (however this concept in ServD more covers why the organization is active or not, could be delisted, deregistered, not operational yet) this could alternatively be derived from ./StartDate and ./EndDate and given a context date.
- w5: status
|
| type | Σ | 0..* | CodeableConcept | There are no (further) constraints on this element Element idOrganization.type Short descriptionKind of organization DefinitionThe kind(s) of organization that this is.
Need to be able to track the kind of organization that this is - different organization types have different uses.
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
When considering if multiple types are appropriate, you should evaluate if child organizations would be a more appropriate use of the concept, as different types likely are in different sub-areas of the organization. This is most likely to be used where type values have orthogonal values, such as a religious, academic and medical center.
We expect that some jurisdictions will profile this optionality to be a single cardinality.
CodeableConcept BindingUsed to categorize the organization http://hl7.org/fhir/ValueSet/organization-type (example) Mappings- v2: No equivalent in v2
- rim: .code
- servd: n/a
- w5: class
|
| name | Σ C | 0..1 | string | There are no (further) constraints on this element Element idOrganization.name Short descriptionName used for the organization DefinitionA name associated with the organization.
Need to use the name as the label of the organization.
If the name of an organization changes, consider putting the old name in the alias column so that it can still be located through searches.
string ConditionsThe cardinality or value of this element may be affected by these constraints: org-1 Mappings- v2: XON.1
- rim: .name
- servd: .PreferredName/Name
|
| alias | | 0..* | string | There are no (further) constraints on this element Element idOrganization.alias Short descriptionA list of alternate names that the organization is known as, or was known as in the past DefinitionA list of alternate names that the organization is known as, or was known as in the past.
Over time locations and organizations go through many changes and can be known by different names.
For searching knowing previous names that the organization was known by can be very useful.
There are no dates associated with the alias/historic names, as this is not intended to track when names were used, but to assist in searching so that older names can still result in identifying the organization.
string Mappings |
| telecom | C | 0..* | ContactPoint | There are no (further) constraints on this element Element idOrganization.telecom Short descriptionA contact detail for the organization DefinitionA contact detail for the organization.
Human contact for the organization.
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.
ContactPoint ConditionsThe cardinality or value of this element may be affected by these constraints: org-3 Constraints- org-3: The telecom of an organization can never be of use 'home'
where(use = 'home').empty()
Mappings- v2: ORC-22?
- rim: .telecom
- servd: ./ContactPoints
|
| address | C | 0..* | Address | There are no (further) constraints on this element Element idOrganization.address Short descriptionAn address for the organization DefinitionAn address for the organization.
May need to keep track of the organization's addresses for contacting, billing or reporting requirements.
Organization may have multiple addresses with different uses or applicable periods. The use code home is not to be used.
Address ConditionsThe cardinality or value of this element may be affected by these constraints: org-2 Constraints- org-2: An address of an organization can never be of use 'home'
where(use = 'home').empty()
Mappings- v2: ORC-23?
- rim: .address
- servd: ./PrimaryAddress and ./OtherAddresses
|
| partOf | Σ | 0..1 | Reference(http://hl7.org/fhir/StructureDefinition/Organization) | There are no (further) constraints on this element Element idOrganization.partOf Short descriptionThe organization of which this organization forms a part DefinitionThe organization of which this organization forms a part.
Need to be able to track the hierarchy of organizations within an organization.
Reference(http://hl7.org/fhir/StructureDefinition/Organization) Mappings- v2: No equivalent in HL7 v2
- rim: .playedBy[classCode=Part].scoper
- servd: n/a
|
| contact | | 0..* | BackboneElement | There are no (further) constraints on this element Element idOrganization.contact Short descriptionContact for the organization for a certain purpose DefinitionContact for the organization for a certain purpose.
Need to keep track of assigned contact points within bigger organization.
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.
BackboneElement Mappings |
| endpoint | | 0..* | Reference(http://hl7.org/fhir/StructureDefinition/Endpoint) | There are no (further) constraints on this element Element idOrganization.endpoint Short descriptionTechnical endpoints providing access to services operated for the organization DefinitionTechnical endpoints providing access to services operated for the organization.
Organizations have multiple systems that provide various services and need to be able to define the technical connection details for how to connect to them, and for what purpose.
Reference(http://hl7.org/fhir/StructureDefinition/Endpoint) Mappings |