Extensions for Using Data Elements from FHIR R4B in FHIR STU3 - Downloaded Version null See the Directory of published versions
| Page standards status: Trial-use | Maturity Level: 0 |
Definitions for the profile-Organization resource profile.
Guidance on how to interpret the contents of this table can be foundhere
| 0. 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. |
| Short | A grouping of people or organizations with a common purpose |
| Control | 0..* |
| Invariants | 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)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) |
| 2. 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. |
| Short | A set of rules under which this content was created |
| 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. 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. |
| Control | 0..1 |
| Type | uri |
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 4. 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. |
| Short | Extensions that cannot be ignored |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR |
| Alternate Names | extensions, user content |
| 6. Organization.active | |
| Definition | Whether the organization's record is still in active use. |
| Short | Whether the organization's record is still in active use |
| Comments | 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. |
| Control | 0..1 |
| Type | boolean |
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | 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. |
| Default Value | true |
Guidance on how to interpret the contents of this table can be foundhere
| 0. Organization | |
| 2. Organization.meta | |
| 4. Organization.meta.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on Organization.meta.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 6. Organization.meta.extension:meta | |
| Slice Name | meta |
| Definition | R4B: |
| Short | R4B: meta additional types |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R4B: meta additional types) (Extension Type: Meta) |
| 8. Organization.text | |
| 10. Organization.text.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on Organization.text.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 12. Organization.text.extension:text | |
| Slice Name | text |
| Definition | R4B: |
| Short | R4B: text additional types |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R4B: text additional types) (Complex Extension) |
| 14. Organization.identifier | |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| 16. Organization.identifier.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on Organization.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 18. Organization.identifier.extension:identifier | |
| Slice Name | identifier |
| Definition | R4B: |
| Short | R4B: identifier additional types |
| Comments | Element |
| Control | 0..* |
| Type | Extension(R4B: identifier additional types) (Extension Type: Identifier) |
| 20. Organization.telecom | |
| 22. Organization.telecom.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on Organization.telecom.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 24. Organization.telecom.extension:telecom | |
| Slice Name | telecom |
| Definition | R4B: |
| Short | R4B: telecom additional types |
| Comments | Element |
| Control | 0..* |
| Type | Extension(R4B: telecom additional types) (Extension Type: ContactPoint) |
| 26. Organization.address | |
| 28. Organization.address.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on Organization.address.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 30. Organization.address.extension:address | |
| Slice Name | address |
| Definition | R4B: |
| Short | R4B: address additional types |
| Comments | Element |
| Control | 0..* |
| Type | Extension(R4B: address additional types) (Extension Type: Address) |
| 32. Organization.partOf | |
| 34. Organization.partOf.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on Organization.partOf.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 36. Organization.partOf.extension:partOf | |
| Slice Name | partOf |
| Definition | R4B: |
| Short | R4B: partOf additional types |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) |
| 38. Organization.contact | |
| 40. Organization.contact.name | |
| 42. Organization.contact.name.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on Organization.contact.name.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 44. Organization.contact.name.extension:name | |
| Slice Name | name |
| Definition | R4B: |
| Short | R4B: name additional types |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R4B: name additional types) (Extension Type: HumanName) |
| 46. Organization.contact.telecom | |
| 48. Organization.contact.telecom.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on Organization.contact.telecom.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 50. Organization.contact.telecom.extension:telecom | |
| Slice Name | telecom |
| Definition | R4B: |
| Short | R4B: telecom additional types |
| Comments | Element |
| Control | 0..* |
| Type | Extension(R4B: telecom additional types) (Extension Type: ContactPoint) |
| 52. Organization.contact.address | |
| 54. Organization.contact.address.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on Organization.contact.address.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 56. Organization.contact.address.extension:address | |
| Slice Name | address |
| Definition | R4B: |
| Short | R4B: address additional types |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R4B: address additional types) (Extension Type: Address) |
| 58. Organization.endpoint | |
| 60. Organization.endpoint.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on Organization.endpoint.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 62. Organization.endpoint.extension:endpoint | |
| Slice Name | endpoint |
| Definition | R4B: |
| Short | R4B: endpoint additional types |
| Comments | Element |
| Control | 0..* |
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) |
Guidance on how to interpret the contents of this table can be foundhere
| 0. 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. | ||||
| Short | A grouping of people or organizations with a common purpose | ||||
| Control | 0..* | ||||
| Invariants | 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) | ||||
| 2. Organization.id | |||||
| Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||||
| Short | Logical id of this artifact | ||||
| 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. | ||||
| Control | 0..1 | ||||
| Type | id | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 4. 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. | ||||
| Short | Metadata about the resource | ||||
| Control | 0..1 | ||||
| Type | Meta | ||||
| Summary | true | ||||
| 6. Organization.meta.id | |||||
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 8. Organization.meta.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on Organization.meta.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 10. Organization.meta.extension:meta | |||||
| Slice Name | meta | ||||
| Definition | R4B: | ||||
| Short | R4B: meta additional types | ||||
| Comments | Element | ||||
| Control | 0..1 | ||||
| Type | Extension(R4B: meta additional types) (Extension Type: Meta) | ||||
| 12. Organization.meta.versionId | |||||
| Definition | The version specific identifier, as it appears in the version portion of the URL. This values changes when the resource is created, updated, or deleted. | ||||
| Short | Version specific identifier | ||||
| Comments | The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes. | ||||
| Control | 0..1 | ||||
| Type | id | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 14. Organization.meta.lastUpdated | |||||
| Definition | When the resource last changed - e.g. when the version changed. | ||||
| Short | When the resource version last changed | ||||
| Comments | This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. | ||||
| Control | 0..1 | ||||
| Type | instant | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 16. Organization.meta.profile | |||||
| Definition | A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. | ||||
| Short | Profiles this resource claims to conform to | ||||
| Comments | It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set. | ||||
| Control | 0..* | ||||
| Type | uri | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 18. Organization.meta.security | |||||
| Definition | Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. | ||||
| Short | Security Labels applied to this resource | ||||
| Comments | The security labels can be updated without changing the stated version of the resource The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored. | ||||
| Control | 0..* | ||||
| Binding | Unless not suitable, these codes SHALL be taken from All Security Labels (extensible to http://hl7.org/fhir/ValueSet/security-labels|3.0.2)Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| Type | Coding | ||||
| Summary | true | ||||
| 20. Organization.meta.tag | |||||
| Definition | Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. | ||||
| Short | Tags applied to this resource | ||||
| Comments | The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored. | ||||
| Control | 0..* | ||||
| Binding | For example codes, see Common Tags (example to http://hl7.org/fhir/ValueSet/common-tags|3.0.2)Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones" | ||||
| Type | Coding | ||||
| Summary | true | ||||
| 22. 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. | ||||
| Short | A set of rules under which this content was created | ||||
| 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. 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. | ||||
| Control | 0..1 | ||||
| Type | uri | ||||
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 24. Organization.language | |||||
| Definition | The base language in which the resource is written. | ||||
| Short | Language of the resource content | ||||
| 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). | ||||
| Control | 0..1 | ||||
| Binding | Unless not suitable, these codes SHALL be taken from Common Languages (extensible to http://hl7.org/fhir/ValueSet/languages|3.0.2)A human language.
| ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 26. 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. | ||||
| Short | Text summary of the resource, for human interpretation | ||||
| Comments | 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. | ||||
| Control | 0..1 This element is affected by the following invariants: dom-1 | ||||
| Type | Narrative | ||||
| Alternate Names | narrative, html, xhtml, display | ||||
| 28. Organization.text.id | |||||
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 30. Organization.text.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on Organization.text.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 32. Organization.text.extension:text | |||||
| Slice Name | text | ||||
| Definition | R4B: | ||||
| Short | R4B: text additional types | ||||
| Comments | Element | ||||
| Control | 0..1 | ||||
| Type | Extension(R4B: text additional types) (Complex Extension) | ||||
| 34. Organization.text.status | |||||
| Definition | The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data. | ||||
| Short | generated | extensions | additional | empty | ||||
| Control | 1..1 | ||||
| Binding | The codes SHALL be taken from NarrativeStatus (required to http://hl7.org/fhir/ValueSet/narrative-status|3.0.2)The status of a resource narrative | ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 36. Organization.text.div | |||||
| Definition | The actual narrative content, a stripped down version of XHTML. | ||||
| Short | Limited xhtml content | ||||
| Comments | The contents of the html element are an XHTML fragment containing only the basic html formatting elements described in chapters 7-11 and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained stylesheets. The XHTML content may not contain a head, a body, external stylesheet references, scripts, forms, base/link/xlink, frames, iframes and objects. | ||||
| Control | 1..1 | ||||
| Type | xhtml | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Invariants | txt-1: The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes (htmlchecks())txt-2: The narrative SHALL have some non-whitespace content ( htmlchecks()) | ||||
| 38. 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. | ||||
| Short | Contained, inline 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. | ||||
| Control | 0..* | ||||
| Type | Resource | ||||
| Alternate Names | inline resources, anonymous resources, contained resources | ||||
| 40. 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. | ||||
| Short | Additional Content defined by implementations | ||||
| 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. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Alternate Names | extensions, user content | ||||
| 42. 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. | ||||
| Short | Extensions that cannot be ignored | ||||
| 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. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
| Alternate Names | extensions, user content | ||||
| 44. Organization.identifier | |||||
| Definition | Identifier for the organization that is used to identify the organization across multiple disparate systems. | ||||
| Short | Identifies this organization across multiple systems | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 0..* This element is affected by the following invariants: org-1 | ||||
| Type | Identifier | ||||
| Summary | true | ||||
| 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. | ||||
| 46. Organization.identifier.id | |||||
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 48. Organization.identifier.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on Organization.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 50. Organization.identifier.extension:identifier | |||||
| Slice Name | identifier | ||||
| Definition | R4B: | ||||
| Short | R4B: identifier additional types | ||||
| Comments | Element | ||||
| Control | 0..* | ||||
| Type | Extension(R4B: identifier additional types) (Extension Type: Identifier) | ||||
| 52. Organization.identifier.use | |||||
| Definition | The purpose of this identifier. | ||||
| Short | usual | official | temp | secondary (If known) | ||||
| Comments | This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. | ||||
| Control | 0..1 | ||||
| Binding | The codes SHALL be taken from IdentifierUse (required to http://hl7.org/fhir/ValueSet/identifier-use|3.0.2)Identifies the purpose for this identifier, if known . | ||||
| Type | code | ||||
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | ||||
| 54. Organization.identifier.type | |||||
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| Short | Description of identifier | ||||
| Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. | ||||
| Control | 0..1 | ||||
| Binding | Unless not suitable, these codes SHALL be taken from Identifier Type Codes (extensible to http://hl7.org/fhir/ValueSet/identifier-type|3.0.2)A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| Type | CodeableConcept | ||||
| Summary | true | ||||
| Requirements | Allows users to make use of identifiers when the identifier system is not known. | ||||
| 56. Organization.identifier.system | |||||
| Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | ||||
| Short | The namespace for the identifier value | ||||
| Control | 0..1 | ||||
| Type | uri | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. | ||||
| Example | General: http://www.acme.com/identifiers/patient | ||||
| 58. Organization.identifier.value | |||||
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | ||||
| Short | The value that is unique | ||||
| Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Example | General: 123456 | ||||
| 60. Organization.identifier.period | |||||
| Definition | Time period during which identifier is/was valid for use. | ||||
| Short | Time period when id is/was valid for use | ||||
| Control | 0..1 | ||||
| Type | Period | ||||
| Summary | true | ||||
| 62. Organization.identifier.assigner | |||||
| Definition | Organization that issued/manages the identifier. | ||||
| Short | Organization that issued id (may be just text) | ||||
| Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. | ||||
| Control | 0..1 | ||||
| Type | Reference(Organization) | ||||
| Summary | true | ||||
| 64. Organization.active | |||||
| Definition | Whether the organization's record is still in active use. | ||||
| Short | Whether the organization's record is still in active use | ||||
| Comments | 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. | ||||
| Control | 0..1 | ||||
| Type | boolean | ||||
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | 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. | ||||
| Default Value | true | ||||
| 66. Organization.type | |||||
| Definition | The kind(s) of organization that this is. | ||||
| Short | Kind of organization | ||||
| 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 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. | ||||
| Control | 0..* | ||||
| Binding | For example codes, see OrganizationType (example to http://hl7.org/fhir/ValueSet/organization-type|3.0.2)Used to categorize the organization | ||||
| Type | CodeableConcept | ||||
| Summary | true | ||||
| Requirements | Need to be able to track the kind of organization that this is - different organization types have different uses. | ||||
| 68. Organization.name | |||||
| Definition | A name associated with the organization. | ||||
| Short | Name used for the organization | ||||
| Comments | 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. | ||||
| Control | 0..1 This element is affected by the following invariants: org-1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Need to use the name as the label of the organization. | ||||
| 70. Organization.alias | |||||
| Definition | A list of alternate names that the organization is known as, or was known as in the past. | ||||
| Short | A list of alternate names that the organization is known as, or was known as in the past | ||||
| Comments | 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. | ||||
| Control | 0..* | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Requirements | 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. | ||||
| 72. Organization.telecom | |||||
| Definition | A contact detail for the organization. | ||||
| Short | A contact detail 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. | ||||
| Control | 0..* This element is affected by the following invariants: org-3 | ||||
| Type | ContactPoint | ||||
| Requirements | Human contact for the organization. | ||||
| Invariants | org-3: The telecom of an organization can never be of use 'home' (where(use = 'home').empty()) | ||||
| 74. Organization.telecom.id | |||||
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 76. Organization.telecom.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on Organization.telecom.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 78. Organization.telecom.extension:telecom | |||||
| Slice Name | telecom | ||||
| Definition | R4B: | ||||
| Short | R4B: telecom additional types | ||||
| Comments | Element | ||||
| Control | 0..* | ||||
| Type | Extension(R4B: telecom additional types) (Extension Type: ContactPoint) | ||||
| 80. Organization.telecom.system | |||||
| Definition | Telecommunications form for contact point - what communications system is required to make use of the contact. | ||||
| Short | phone | fax | email | pager | url | sms | other | ||||
| Control | 0..1 This element is affected by the following invariants: cpt-2 | ||||
| Binding | The codes SHALL be taken from ContactPointSystem (required to http://hl7.org/fhir/ValueSet/contact-point-system|3.0.2)Telecommunications form for contact point | ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 82. Organization.telecom.value | |||||
| Definition | The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address). | ||||
| Short | The actual contact point details | ||||
| Comments | Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Need to support legacy numbers that are not in a tightly controlled format. | ||||
| 84. Organization.telecom.use | |||||
| Definition | Identifies the purpose for the contact point. | ||||
| Short | home | work | temp | old | mobile - purpose of this contact point | ||||
| Comments | This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one. Applications can assume that a contact is current unless it explicitly says that it is temporary or old. | ||||
| Control | 0..1 | ||||
| Binding | The codes SHALL be taken from ContactPointUse (required to http://hl7.org/fhir/ValueSet/contact-point-use|3.0.2)Use of contact point | ||||
| Type | code | ||||
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose. | ||||
| 86. Organization.telecom.rank | |||||
| Definition | Specifies a preferred order in which to use a set of contacts. Contacts are ranked with lower values coming before higher values. | ||||
| Short | Specify preferred order of use (1 = highest) | ||||
| Comments | Note that rank does not necessarily follow the order in which the contacts are represented in the instance. | ||||
| Control | 0..1 | ||||
| Type | positiveInt | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 88. Organization.telecom.period | |||||
| Definition | Time period when the contact point was/is in use. | ||||
| Short | Time period when the contact point was/is in use | ||||
| Control | 0..1 | ||||
| Type | Period | ||||
| Summary | true | ||||
| 90. Organization.address | |||||
| Definition | An address for the organization. | ||||
| Short | An address for the organization | ||||
| Comments | Organization may have multiple addresses with different uses or applicable periods. The use code home is not to be used. | ||||
| 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. | ||||
| Invariants | org-2: An address of an organization can never be of use 'home' (where(use = 'home').empty()) | ||||
| 92. Organization.address.id | |||||
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 94. Organization.address.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on Organization.address.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 96. Organization.address.extension:address | |||||
| Slice Name | address | ||||
| Definition | R4B: | ||||
| Short | R4B: address additional types | ||||
| Comments | Element | ||||
| Control | 0..* | ||||
| Type | Extension(R4B: address additional types) (Extension Type: Address) | ||||
| 98. Organization.address.use | |||||
| Definition | The purpose of this address. | ||||
| Short | home | work | temp | old - purpose of this address | ||||
| 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. | ||||
| Control | 0..1 | ||||
| Binding | The codes SHALL be taken from AddressUse (required to http://hl7.org/fhir/ValueSet/address-use|3.0.2)The use of an address | ||||
| Type | code | ||||
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Allows an appropriate address to be chosen from a list of many. | ||||
| Example | General: home | ||||
| 100. 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. | ||||
| Short | postal | physical | both | ||||
| Control | 0..1 | ||||
| Binding | The codes SHALL be taken from AddressType (required to http://hl7.org/fhir/ValueSet/address-type|3.0.2)The type of an address (physical / postal) | ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Example | General: both | ||||
| 102. Organization.address.text | |||||
| Definition | A full text representation of the address. | ||||
| Short | Text representation of the address | ||||
| Comments | Can provide both a text representation and parts. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | A renderable, unencoded form. | ||||
| Example | General: 137 Nowhere Street, Erewhon 9132 | ||||
| 104. 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. | ||||
| Short | Street name, number, direction & P.O. Box etc. | ||||
| Control | 0..* | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | home | work | temp | old - purpose of this address. | ||||
| Example | General: 137 Nowhere Street | ||||
| 106. Organization.address.city | |||||
| Definition | The name of the city, town, village or other community or delivery center. | ||||
| Short | Name of city, town etc. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Alternate Names | Municpality | ||||
| Example | General: Erewhon | ||||
| 108. Organization.address.district | |||||
| Definition | The name of the administrative area (county). | ||||
| Short | District name (aka county) | ||||
| Comments | District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Alternate Names | County | ||||
| Example | General: Madison | ||||
| 110. 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). | ||||
| Short | Sub-unit of country (abbreviations ok) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Alternate Names | Province, Territory | ||||
| 112. Organization.address.postalCode | |||||
| Definition | A postal code designating a region defined by the postal service. | ||||
| Short | Postal code for area | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Alternate Names | Zip | ||||
| Example | General: 9132 | ||||
| 114. Organization.address.country | |||||
| Definition | Country - a nation as commonly understood or generally accepted. | ||||
| Short | Country (e.g. can be ISO 3166 2 or 3 letter code) | ||||
| Comments | ISO 3166 3 letter codes can be used in place of a full country name. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 116. Organization.address.period | |||||
| Definition | Time period when address was/is in use. | ||||
| Short | Time period when address was/is in use | ||||
| Control | 0..1 | ||||
| Type | Period | ||||
| Summary | true | ||||
| Requirements | Allows addresses to be placed in historical context. | ||||
| Example | General: { "start" : "2010-03-23", "end" : "2010-07-01" } | ||||
| 118. Organization.partOf | |||||
| Definition | The organization of which this organization forms a part. | ||||
| Short | The organization of which this organization forms a part | ||||
| Control | 0..1 | ||||
| Type | Reference(Organization) | ||||
| Summary | true | ||||
| Requirements | Need to be able to track the hierarchy of organizations within an organization. | ||||
| 120. Organization.partOf.id | |||||
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 122. Organization.partOf.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on Organization.partOf.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 124. Organization.partOf.extension:partOf | |||||
| Slice Name | partOf | ||||
| Definition | R4B: | ||||
| Short | R4B: partOf additional types | ||||
| Comments | Element | ||||
| Control | 0..1 | ||||
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) | ||||
| 126. 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. | ||||
| Short | Literal reference, Relative, internal or absolute URL | ||||
| 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. | ||||
| Control | 0..1 This element is affected by the following invariants: ref-1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 128. Organization.partOf.identifier | |||||
| Definition | An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. | ||||
| Short | Logical reference, when literal reference is not known | ||||
| Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 0..1 | ||||
| Type | Identifier | ||||
| Summary | true | ||||
| 130. Organization.partOf.display | |||||
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. | ||||
| Short | Text alternative for the resource | ||||
| 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. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 132. Organization.contact | |||||
| Definition | Contact for the organization for a certain purpose. | ||||
| Short | Contact for the organization for a certain purpose | ||||
| 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. | ||||
| Control | 0..* | ||||
| Type | BackboneElement | ||||
| Requirements | Need to keep track of assigned contact points within bigger organization. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count())) | ||||
| 134. Organization.contact.id | |||||
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 136. 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. | ||||
| Short | Additional Content defined by implementations | ||||
| 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. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Alternate Names | extensions, user content | ||||
| 138. 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. | ||||
| Short | Extensions that cannot be ignored | ||||
| 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. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
| Summary | true | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| 140. Organization.contact.purpose | |||||
| Definition | Indicates a purpose for which the contact can be reached. | ||||
| Short | The type of contact | ||||
| Control | 0..1 | ||||
| Binding | Unless not suitable, these codes SHALL be taken from ContactEntityType (extensible to http://hl7.org/fhir/ValueSet/contactentity-type|3.0.2)The purpose for which you would contact a contact party | ||||
| Type | CodeableConcept | ||||
| Requirements | Need to distinguish between multiple contact persons. | ||||
| 142. Organization.contact.name | |||||
| Definition | A name associated with the contact. | ||||
| Short | A name associated with the contact | ||||
| Control | 0..1 | ||||
| Type | HumanName | ||||
| Requirements | Need to be able to track the person by name. | ||||
| 144. Organization.contact.name.id | |||||
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 146. Organization.contact.name.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on Organization.contact.name.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 148. Organization.contact.name.extension:name | |||||
| Slice Name | name | ||||
| Definition | R4B: | ||||
| Short | R4B: name additional types | ||||
| Comments | Element | ||||
| Control | 0..1 | ||||
| Type | Extension(R4B: name additional types) (Extension Type: HumanName) | ||||
| 150. Organization.contact.name.use | |||||
| Definition | Identifies the purpose for this name. | ||||
| Short | usual | official | temp | nickname | anonymous | old | maiden | ||||
| Comments | This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one. Applications can assume that a name is current unless it explicitly says that it is temporary or old. | ||||
| Control | 0..1 | ||||
| Binding | The codes SHALL be taken from NameUse (required to http://hl7.org/fhir/ValueSet/name-use|3.0.2)The use of a human name | ||||
| Type | code | ||||
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Allows the appropriate name for a particular context of use to be selected from among a set of names. | ||||
| 152. Organization.contact.name.text | |||||
| Definition | A full text representation of the name. | ||||
| Short | Text representation of the full name | ||||
| Comments | Can provide both a text representation and structured parts. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | A renderable, unencoded form. | ||||
| 154. Organization.contact.name.family | |||||
| Definition | The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father. | ||||
| Short | Family name (often called 'Surname') | ||||
| Comments | Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures). | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Alternate Names | surname | ||||
| 156. Organization.contact.name.given | |||||
| Definition | Given name. | ||||
| Short | Given names (not always 'first'). Includes middle names | ||||
| Comments | If only initials are recorded, they may be used in place of the full name. Not called "first name" since given names do not always come first. | ||||
| Control | 0..* | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Alternate Names | first name, middle name | ||||
| 158. Organization.contact.name.prefix | |||||
| Definition | Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name. | ||||
| Short | Parts that come before the name | ||||
| Control | 0..* | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 160. Organization.contact.name.suffix | |||||
| Definition | Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name. | ||||
| Short | Parts that come after the name | ||||
| Control | 0..* | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 162. Organization.contact.name.period | |||||
| Definition | Indicates the period of time when this name was valid for the named person. | ||||
| Short | Time period when name was/is in use | ||||
| Control | 0..1 | ||||
| Type | Period | ||||
| Summary | true | ||||
| Requirements | Allows names to be placed in historical context. | ||||
| 164. Organization.contact.telecom | |||||
| Definition | A contact detail (e.g. a telephone number or an email address) by which the party may be contacted. | ||||
| Short | Contact details (telephone, email, etc.) for a contact | ||||
| Control | 0..* | ||||
| Type | ContactPoint | ||||
| Requirements | People have (primary) ways to contact them in some way such as phone, email. | ||||
| 166. Organization.contact.telecom.id | |||||
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 168. Organization.contact.telecom.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on Organization.contact.telecom.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 170. Organization.contact.telecom.extension:telecom | |||||
| Slice Name | telecom | ||||
| Definition | R4B: | ||||
| Short | R4B: telecom additional types | ||||
| Comments | Element | ||||
| Control | 0..* | ||||
| Type | Extension(R4B: telecom additional types) (Extension Type: ContactPoint) | ||||
| 172. Organization.contact.telecom.system | |||||
| Definition | Telecommunications form for contact point - what communications system is required to make use of the contact. | ||||
| Short | phone | fax | email | pager | url | sms | other | ||||
| Control | 0..1 This element is affected by the following invariants: cpt-2 | ||||
| Binding | The codes SHALL be taken from ContactPointSystem (required to http://hl7.org/fhir/ValueSet/contact-point-system|3.0.2)Telecommunications form for contact point | ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 174. Organization.contact.telecom.value | |||||
| Definition | The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address). | ||||
| Short | The actual contact point details | ||||
| Comments | Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Need to support legacy numbers that are not in a tightly controlled format. | ||||
| 176. Organization.contact.telecom.use | |||||
| Definition | Identifies the purpose for the contact point. | ||||
| Short | home | work | temp | old | mobile - purpose of this contact point | ||||
| Comments | This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one. Applications can assume that a contact is current unless it explicitly says that it is temporary or old. | ||||
| Control | 0..1 | ||||
| Binding | The codes SHALL be taken from ContactPointUse (required to http://hl7.org/fhir/ValueSet/contact-point-use|3.0.2)Use of contact point | ||||
| Type | code | ||||
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose. | ||||
| 178. Organization.contact.telecom.rank | |||||
| Definition | Specifies a preferred order in which to use a set of contacts. Contacts are ranked with lower values coming before higher values. | ||||
| Short | Specify preferred order of use (1 = highest) | ||||
| Comments | Note that rank does not necessarily follow the order in which the contacts are represented in the instance. | ||||
| Control | 0..1 | ||||
| Type | positiveInt | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 180. Organization.contact.telecom.period | |||||
| Definition | Time period when the contact point was/is in use. | ||||
| Short | Time period when the contact point was/is in use | ||||
| Control | 0..1 | ||||
| Type | Period | ||||
| Summary | true | ||||
| 182. Organization.contact.address | |||||
| Definition | Visiting or postal addresses for the contact. | ||||
| Short | 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. | ||||
| 184. Organization.contact.address.id | |||||
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 186. Organization.contact.address.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on Organization.contact.address.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 188. Organization.contact.address.extension:address | |||||
| Slice Name | address | ||||
| Definition | R4B: | ||||
| Short | R4B: address additional types | ||||
| Comments | Element | ||||
| Control | 0..1 | ||||
| Type | Extension(R4B: address additional types) (Extension Type: Address) | ||||
| 190. Organization.contact.address.use | |||||
| Definition | The purpose of this address. | ||||
| Short | home | work | temp | old - purpose of this address | ||||
| 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. | ||||
| Control | 0..1 | ||||
| Binding | The codes SHALL be taken from AddressUse (required to http://hl7.org/fhir/ValueSet/address-use|3.0.2)The use of an address | ||||
| Type | code | ||||
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Allows an appropriate address to be chosen from a list of many. | ||||
| Example | General: home | ||||
| 192. Organization.contact.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. | ||||
| Short | postal | physical | both | ||||
| Control | 0..1 | ||||
| Binding | The codes SHALL be taken from AddressType (required to http://hl7.org/fhir/ValueSet/address-type|3.0.2)The type of an address (physical / postal) | ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Example | General: both | ||||
| 194. Organization.contact.address.text | |||||
| Definition | A full text representation of the address. | ||||
| Short | Text representation of the address | ||||
| Comments | Can provide both a text representation and parts. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | A renderable, unencoded form. | ||||
| Example | General: 137 Nowhere Street, Erewhon 9132 | ||||
| 196. Organization.contact.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. | ||||
| Short | Street name, number, direction & P.O. Box etc. | ||||
| Control | 0..* | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | home | work | temp | old - purpose of this address. | ||||
| Example | General: 137 Nowhere Street | ||||
| 198. Organization.contact.address.city | |||||
| Definition | The name of the city, town, village or other community or delivery center. | ||||
| Short | Name of city, town etc. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Alternate Names | Municpality | ||||
| Example | General: Erewhon | ||||
| 200. Organization.contact.address.district | |||||
| Definition | The name of the administrative area (county). | ||||
| Short | District name (aka county) | ||||
| Comments | District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Alternate Names | County | ||||
| Example | General: Madison | ||||
| 202. Organization.contact.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). | ||||
| Short | Sub-unit of country (abbreviations ok) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Alternate Names | Province, Territory | ||||
| 204. Organization.contact.address.postalCode | |||||
| Definition | A postal code designating a region defined by the postal service. | ||||
| Short | Postal code for area | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Alternate Names | Zip | ||||
| Example | General: 9132 | ||||
| 206. Organization.contact.address.country | |||||
| Definition | Country - a nation as commonly understood or generally accepted. | ||||
| Short | Country (e.g. can be ISO 3166 2 or 3 letter code) | ||||
| Comments | ISO 3166 3 letter codes can be used in place of a full country name. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 208. Organization.contact.address.period | |||||
| Definition | Time period when address was/is in use. | ||||
| Short | Time period when address was/is in use | ||||
| Control | 0..1 | ||||
| Type | Period | ||||
| Summary | true | ||||
| Requirements | Allows addresses to be placed in historical context. | ||||
| Example | General: { "start" : "2010-03-23", "end" : "2010-07-01" } | ||||
| 210. Organization.endpoint | |||||
| Definition | Technical endpoints providing access to services operated for the organization. | ||||
| Short | Technical endpoints providing access to services operated for the organization | ||||
| Control | 0..* | ||||
| Type | Reference(Endpoint) | ||||
| Requirements | 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. | ||||
| 212. Organization.endpoint.id | |||||
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 214. Organization.endpoint.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on Organization.endpoint.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 216. Organization.endpoint.extension:endpoint | |||||
| Slice Name | endpoint | ||||
| Definition | R4B: | ||||
| Short | R4B: endpoint additional types | ||||
| Comments | Element | ||||
| Control | 0..* | ||||
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) | ||||
| 218. Organization.endpoint.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. | ||||
| Short | Literal reference, Relative, internal or absolute URL | ||||
| 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. | ||||
| Control | 0..1 This element is affected by the following invariants: ref-1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 220. Organization.endpoint.identifier | |||||
| Definition | An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. | ||||
| Short | Logical reference, when literal reference is not known | ||||
| Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 0..1 | ||||
| Type | Identifier | ||||
| Summary | true | ||||
| 222. Organization.endpoint.display | |||||
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. | ||||
| Short | Text alternative for the resource | ||||
| 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. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||