Validated Healthcare Directory
0.2.0 - CI Build United States of America flag

Validated Healthcare Directory, published by HL7 International - Patient Administration Work Group. This is not an authorized publication; it is the continuous build for version 0.2.0). This version is based on the current content of https://github.com/HL7/VhDir/ and changes regularly. See the Directory of published versions

Resource Profile: VhdirNetwork - Detailed Descriptions

Active as of 2017-09-01

Definitions for the vhdir-network resource profile.

Guidance on how to interpret the contents of this table can be found here

0. Organization
Definition

The details of a healthcare provider insurance network

ShortNetwork
2. Organization.extension
Must Supportfalse
SlicingThis element introduces a set of slices on Organization.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ url
4. Organization.extension:timePeriod
Slice NametimePeriod
Definition

The date range that this network should be considered available.

ShortValid time period for this Network
Control0..1
TypeExtension(Period) (Extension Type: Period)
Must Supporttrue
6. Organization.extension:coverageArea
Slice NamecoverageArea
Definition

An extension referencing a Location resource defining the coverage area of a health insurance provider network

ShortNetwork coverage area
TypeExtension(VhDir Location Reference) (Extension Type: Reference(VhDir Location))
Must Supporttrue
8. Organization.extension:restriction
Slice Namerestriction
Definition

Identifies and conveys information about restrictions on the use or release of exchanged information, e.g. information that can only be shared under particular condition, such as a signed data use agreement between parties

ShortRestriction
Control0..*
TypeExtension(VhDir Usage Restriction) (Extension Type: Reference(VhDir Restriction))
Must Supporttrue
10. Organization.identifier
Definition

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

ShortIdentifies this network across multiple systems
NoteThis is a business identifier, not a resource identifier (see discussion)
Must Supporttrue
12. Organization.identifier.extension
Must Supportfalse
SlicingThis element introduces a set of slices on Organization.identifier.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ url
14. Organization.identifier.extension:status
Slice Namestatus
Control1..1
TypeExtension(VhDir Identifier Status) (Extension Type: code)
Must Supporttrue
16. Organization.identifier.use
Must Supporttrue
18. Organization.identifier.type
Must Supporttrue
20. Organization.identifier.system
Must Supporttrue
22. Organization.identifier.value
Must Supporttrue
24. Organization.identifier.period
Must Supporttrue
26. Organization.identifier.assigner
TypeReference(VhDir Organization)
Must Supporttrue
28. Organization.active
Definition

Whether the networks's record is still in active use

ShortWhether the network's record is still in active use.
Comments

This element is labeled as a modifier because it may be used to mark that the resource was created in error.

Control1..?
Must Supporttrue
Labelstatus
30. Organization.type
Definition

Type of network

ShortType of network
Comments

Type of network

BindingFor example codes, see VhDir Network Type Value Set
Must Supporttrue
Requirements

Need to be able to track the kind of network this is.

32. Organization.name
Definition

A name associated with the network (official name designated by the owner of the network).

ShortName
Comments

If the name of an network changes, consider putting the old name in the alias column so that it can still be located through searches.

Must Supporttrue
Requirements

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

LabelNetwork Name
34. Organization.alias
Definition

A list of alternate names that the network is known as, or was known as in the past.

ShortAlternate names by which the Network is known
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 network.

Must Supporttrue
Requirements

Over time networks may go through many changes and may be known by different names to different users.

Labelalias
36. Organization.telecom
Control0..0
Must Supporttrue
38. Organization.address
Definition

An address for the network.

ShortAn address for the network
Comments

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

Must Supporttrue
Requirements

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

40. Organization.partOf
Definition

The organization that "owns" this network (typically a payer)

ShortReference to organization that owns the network
Control1..?
TypeReference(VhDir Organization)
Must Supporttrue
Requirements

Need to specify the payor organization of this network

42. Organization.contact
Definition

Contact for the network for a certain purpose.

ShortContact for the network for a certain purpose.
Must Supporttrue
Requirements

Need to keep track of assigned contact points for the network

44. Organization.contact.purpose
Must Supporttrue
46. Organization.contact.name
Must Supporttrue
48. Organization.contact.name.use
Must Supporttrue
50. Organization.contact.name.text
Must Supporttrue
52. Organization.contact.name.family
Control1..?
Must Supporttrue
54. Organization.contact.name.given
Control1..*
Must Supporttrue
56. Organization.contact.name.prefix
Must Supporttrue
58. Organization.contact.name.suffix
Must Supporttrue
60. Organization.contact.name.period
Must Supporttrue
62. Organization.contact.telecom
Must Supporttrue
64. Organization.contact.telecom.extension
Must Supportfalse
SlicingThis element introduces a set of slices on Organization.contact.telecom.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ url
66. Organization.contact.telecom.extension:availabletime
Slice Nameavailabletime
TypeExtension(VhDir Contactpoint Availabletime) (Complex Extension)
Must Supporttrue
68. Organization.contact.telecom.extension:viaintermediary
Slice Nameviaintermediary
Control0..1
TypeExtension(VhDir Contactpoint Viaintermediary) (Extension Type: Reference(VhDir Practitioner Role, VhDir Organization, VhDir Organization Affiliation, VhDir Location))
Must Supporttrue
70. Organization.contact.telecom.system
Control1..?
Must Supporttrue
72. Organization.contact.telecom.value
Control1..?
Must Supporttrue
74. Organization.contact.telecom.use
Must Supporttrue
76. Organization.contact.telecom.rank
Must Supporttrue
78. Organization.contact.telecom.period
Must Supporttrue
80. Organization.contact.address
Must Supporttrue
82. Organization.endpoint
Definition

Technical endpoints providing access to services operated for the network

ShortTechnical endpoints providing access to services operated for the network
TypeReference(VhDir Endpoint)
Must Supporttrue
Requirements

Networks may 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.

Guidance on how to interpret the contents of this table can be found here

0. Organization
Definition

The details of a healthcare provider insurance network


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, payer/insurer, etc.

ShortNetworkA grouping of people or organizations with a common purpose
Control0..*
Is Modifierfalse
Summaryfalse
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).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-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
org-1: The organization SHALL at least have a name or an identifier, and possibly more than one ((identifier.count() + name.count()) > 0)
org-1: The organization SHALL at least have a name or an identifier, 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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

ShortA 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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

Control0..1
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. Organization.extension
Definition

An Extension


May be used to represent additional information that is not part of the basic definition of the resource. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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

Control0..*
TypeExtension
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Organization.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ url
6. Organization.extension:timePeriod
Slice NametimePeriod
Definition

The date range that this network should be considered available.

ShortValid time period for this Network
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(Period) (Extension Type: Period)
Is Modifierfalse
Must Supporttrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
8. Organization.extension:coverageArea
Slice NamecoverageArea
Definition

An extension referencing a Location resource defining the coverage area of a health insurance provider network

ShortNetwork coverage area
Control0..*
This element is affected by the following invariants: ele-1
TypeExtension(VhDir Location Reference) (Extension Type: Reference(VhDir Location))
Is Modifierfalse
Must Supporttrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
10. Organization.extension:restriction
Slice Namerestriction
Definition

Identifies and conveys information about restrictions on the use or release of exchanged information, e.g. information that can only be shared under particular condition, such as a signed data use agreement between parties

ShortRestriction
Control0..*
This element is affected by the following invariants: ele-1
TypeExtension(VhDir Usage Restriction) (Extension Type: Reference(VhDir Restriction))
Is Modifierfalse
Must Supporttrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
12. 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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Summaryfalse
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
14. Organization.identifier
Definition

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


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

ShortIdentifies this network across multiple systemsIdentifies this organization across multiple systems
NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
This element is affected by the following invariants: org-1
TypeIdentifier
Is Modifierfalse
Must Supporttrue
Summarytrue
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.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
16. Organization.identifier.extension
Definition

An Extension


May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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

Control0..*
TypeExtension
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Organization.identifier.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ url
18. Organization.identifier.extension:status
Slice Namestatus
Definition

Describes the status of an identifier

ShortStatus
Control1..1
TypeExtension(VhDir Identifier Status) (Extension Type: code)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
20. Organization.identifier.use
Definition

The purpose of this identifier.

Shortusual | official | temp | secondary | old (If known)
Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Control0..1
BindingThe codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1

Identifies the purpose for this identifier, if known .

Typecode
Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
22. Organization.identifier.type
Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

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

Control0..1
BindingUnless not suitable, these codes SHALL be taken from Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
24. Organization.identifier.system
Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

ShortThe namespace for the identifier value
Comments

Identifier.system is always case sensitive.

Control0..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
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<br/><b>General</b>:http://www.acme.com/identifiers/patient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
26. Organization.identifier.value
Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

ShortThe 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. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Example<br/><b>General</b>:123456
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
28. Organization.identifier.period
Definition

Time period during which identifier is/was valid for use.

ShortTime period when id is/was valid for use
Control0..1
TypePeriod
Is Modifierfalse
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
30. Organization.identifier.assigner
Definition

Organization that issued/manages the identifier.

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

Control0..1
TypeReference(VhDir Organization, Organization)
Is Modifierfalse
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
32. Organization.active
Definition

Whether the networks's record is still in active use


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

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

This element is labeled as a modifier because it may be used to mark that the resource was created in error.


This active flag is not intended to be used to mark an organization 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.

Control10..1
Typeboolean
Is Modifiertrue because This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
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.

Labelstatus
Meaning if MissingThis resource is generally assumed to be active if no value is provided for the active element
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
34. Organization.type
Definition

Type of network


The kind(s) of organization that this is.

ShortType of networkKind of organization
Comments

Type of network


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.

Control0..*
BindingFor example codes, see VhDir Network Type Value Sethttp://hl7.org/fhir/ValueSet/organization-type
TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

Need to be able to track the kind of network this is.


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

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
36. Organization.name
Definition

A name associated with the network (official name designated by the owner of the network).


A name associated with the organization.

ShortNameName used for the organization
Comments

If the name of an network changes, consider putting the old name in the alias column so that it can still be located through searches.


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.

Control0..1
This element is affected by the following invariants: org-1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Requirements

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


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

LabelNetwork Name
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
38. Organization.alias
Definition

A list of alternate names that the network is known as, or was known as in the past.


A list of alternate names that the organization is known as, or was known as in the past.

ShortAlternate names by which the Network is knownA 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 network.


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.

Control0..*
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Requirements

Over time networks may go through many changes and may be known by different names to different users.

For searching knowing previous names that the network was known by can be very useful.


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.

Labelalias
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
40. Organization.telecom
Definition

A contact detail for the organization.

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

Control0..0*
This element is affected by the following invariants: org-3
TypeContactPoint
Is Modifierfalse
Must Supporttrue
Summaryfalse
Requirements

Human contact for the organization.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
org-3: The telecom of an organization can never be of use 'home' (where(use = 'home').empty())
org-3: The telecom of an organization can never be of use 'home' (where(use = 'home').empty())
42. Organization.address
Definition

An address for the network.


An address for the organization.

ShortAn address for the networkAn address for the organization
Comments

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


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

Control0..*
This element is affected by the following invariants: org-2
TypeAddress
Is Modifierfalse
Must Supporttrue
Summaryfalse
Requirements

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


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

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
org-2: An address of an organization can never be of use 'home' (where(use = 'home').empty())
org-2: An address of an organization can never be of use 'home' (where(use = 'home').empty())
44. Organization.partOf
Definition

The organization that "owns" this network (typically a payer)


The organization of which this organization forms a part.

ShortReference to organization that owns the networkThe organization of which this organization forms a part
Control10..1
TypeReference(VhDir Organization, Organization)
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

Need to specify the payor organization of this network


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

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
46. Organization.contact
Definition

Contact for the network for a certain purpose.


Contact for the organization for a certain purpose.

ShortContact for the network for a certain purpose.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.

Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Requirements

Need to keep track of assigned contact points for the network


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

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
48. 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
50. Organization.contact.purpose
Definition

Indicates a purpose for which the contact can be reached.

ShortThe type of contact
Control0..1
BindingUnless not suitable, these codes SHALL be taken from ContactEntityTypehttp://hl7.org/fhir/ValueSet/contactentity-type

The purpose for which you would contact a contact party.

TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summaryfalse
Requirements

Need to distinguish between multiple contact persons.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
52. Organization.contact.name
Definition

A name associated with the contact.

ShortA name associated with the contact
Control0..1
TypeHumanName
Is Modifierfalse
Must Supporttrue
Summaryfalse
Requirements

Need to be able to track the person by name.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
54. Organization.contact.name.use
Definition

Identifies the purpose for this name.

Shortusual | official | temp | nickname | anonymous | old | maiden
Comments

Applications can assume that a name is current unless it explicitly says that it is temporary or old.

Control0..1
BindingThe codes SHALL be taken from NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1

The use of a human name.

Typecode
Is Modifiertrue because This is labeled as &quot;Is Modifier&quot; because applications should not mistake a temporary or old name etc.for a current/permanent one
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Requirements

Allows the appropriate name for a particular context of use to be selected from among a set of names.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
56. Organization.contact.name.text
Definition

Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts.

ShortText representation of the full name
Comments

Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Requirements

A renderable, unencoded form.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
58. 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.

ShortFamily name (often called 'Surname')
Comments

Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).

Control10..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Alternate Namessurname
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
60. Organization.contact.name.given
Definition

Given name.

ShortGiven names (not always 'first'). Includes middle names
Comments

If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called "first name" since given names do not always come first.

Control10..*
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Alternate Namesfirst name, middle name
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
62. 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.

ShortParts that come before the name
Control0..*
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
64. 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.

ShortParts that come after the name
Control0..*
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
66. Organization.contact.name.period
Definition

Indicates the period of time when this name was valid for the named person.

ShortTime period when name was/is in use
Control0..1
TypePeriod
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

Allows names to be placed in historical context.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
68. Organization.contact.telecom
Definition

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

ShortContact details (telephone, email, etc.) for a contact
Control0..*
TypeContactPoint
Is Modifierfalse
Must Supporttrue
Summaryfalse
Requirements

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

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
70. Organization.contact.telecom.extension
Definition

An Extension


May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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

Control0..*
TypeExtension
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Organization.contact.telecom.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ url
72. Organization.contact.telecom.extension:availabletime
Slice Nameavailabletime
Definition

Time period when the contact point is to be used

ShortAvailable time
Control0..*
TypeExtension(VhDir Contactpoint Availabletime) (Complex Extension)
Is Modifierfalse
Must Supporttrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
74. Organization.contact.telecom.extension:viaintermediary
Slice Nameviaintermediary
Definition

Represents an external point of contact responsible for handling communications with this entity

Shortviaintermediary
Control0..1
TypeExtension(VhDir Contactpoint Viaintermediary) (Extension Type: Reference(VhDir Practitioner Role, VhDir Organization, VhDir Organization Affiliation, VhDir Location))
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
76. Organization.contact.telecom.system
Definition

Telecommunications form for contact point - what communications system is required to make use of the contact.

Shortphone | fax | email | pager | url | sms | other
Control10..1
This element is affected by the following invariants: cpt-2
BindingThe codes SHALL be taken from ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1

Telecommunications form for contact point.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
78. 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).

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

Control10..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Requirements

Need to support legacy numbers that are not in a tightly controlled format.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
80. Organization.contact.telecom.use
Definition

Identifies the purpose for the contact point.

Shorthome | work | temp | old | mobile - purpose of this contact point
Comments

Applications can assume that a contact is current unless it explicitly says that it is temporary or old.

Control0..1
BindingThe codes SHALL be taken from ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1

Use of contact point.

Typecode
Is Modifiertrue because This is labeled as &quot;Is Modifier&quot; because applications should not mistake a temporary or old contact etc.for a current/permanent one
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Requirements

Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
82. Organization.contact.telecom.rank
Definition

Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.

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

Control0..1
TypepositiveInt
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
84. Organization.contact.telecom.period
Definition

Time period when the contact point was/is in use.

ShortTime period when the contact point was/is in use
Control0..1
TypePeriod
Is Modifierfalse
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
86. Organization.contact.address
Definition

Visiting or postal addresses for the contact.

ShortVisiting or postal addresses for the contact
Control0..1
TypeAddress
Is Modifierfalse
Must Supporttrue
Summaryfalse
Requirements

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

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
88. Organization.endpoint
Definition

Technical endpoints providing access to services operated for the network


Technical endpoints providing access to services operated for the organization.

ShortTechnical endpoints providing access to services operated for the networkTechnical endpoints providing access to services operated for the organization
Control0..*
TypeReference(VhDir Endpoint, Endpoint)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Requirements

Networks may 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.


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.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

Guidance on how to interpret the contents of this table can be found here

0. Organization
Definition

The details of a healthcare provider insurance network

ShortNetwork
Control0..*
Is Modifierfalse
Summaryfalse
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).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-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
org-1: The organization SHALL at least have a name or an identifier, 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.

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

Control0..1
Typeid
Is Modifierfalse
Summarytrue
4. Organization.meta
Definition

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

ShortMetadata about the resource
Control0..1
TypeMeta
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. 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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

ShortA 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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

Control0..1
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. Organization.language
Definition

The base language in which the resource is written.

ShortLanguage 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).

Control0..1
BindingThe codes SHOULD be taken from CommonLanguages: A human language.
Additional BindingsPurpose
AllLanguagesMax Binding
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. Organization.text
Definition

A human-readable narrative that contains a summary of the resource and can 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.

ShortText 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 information is added later.

Control0..1
TypeNarrative
Is Modifierfalse
Summaryfalse
Alternate Namesnarrative, html, xhtml, display
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. 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.

ShortContained, 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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

Control0..*
TypeResource
Is Modifierfalse
Summaryfalse
Alternate Namesinline resources, anonymous resources, contained resources
14. Organization.extension
Definition

An Extension

ShortExtension
Control0..*
TypeExtension
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Organization.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ url
16. Organization.extension:timePeriod
Slice NametimePeriod
Definition

The date range that this network should be considered available.

ShortValid time period for this Network
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(Period) (Extension Type: Period)
Is Modifierfalse
Must Supporttrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
18. Organization.extension:coverageArea
Slice NamecoverageArea
Definition

An extension referencing a Location resource defining the coverage area of a health insurance provider network

ShortNetwork coverage area
Control0..*
This element is affected by the following invariants: ele-1
TypeExtension(VhDir Location Reference) (Extension Type: Reference(VhDir Location))
Is Modifierfalse
Must Supporttrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
20. Organization.extension:restriction
Slice Namerestriction
Definition

Identifies and conveys information about restrictions on the use or release of exchanged information, e.g. information that can only be shared under particular condition, such as a signed data use agreement between parties

ShortRestriction
Control0..*
This element is affected by the following invariants: ele-1
TypeExtension(VhDir Usage Restriction) (Extension Type: Reference(VhDir Restriction))
Is Modifierfalse
Must Supporttrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
22. 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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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.

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

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Summaryfalse
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
24. Organization.identifier
Definition

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

ShortIdentifies this network across multiple systems
NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
This element is affected by the following invariants: org-1
TypeIdentifier
Is Modifierfalse
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
26. 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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
28. Organization.identifier.extension
Definition

An Extension

ShortExtension
Control0..*
TypeExtension
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Organization.identifier.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ url
30. Organization.identifier.extension:status
Slice Namestatus
Definition

Describes the status of an identifier

ShortStatus
Control1..1
TypeExtension(VhDir Identifier Status) (Extension Type: code)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
32. Organization.identifier.use
Definition

The purpose of this identifier.

Shortusual | official | temp | secondary | old (If known)
Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Control0..1
BindingThe codes SHALL be taken from IdentifierUse: Identifies the purpose for this identifier, if known .
Typecode
Is Modifiertrue because This is labeled as &quot;Is Modifier&quot; because applications should not mistake a temporary id for a permanent one.
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
34. Organization.identifier.type
Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

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

Control0..1
BindingUnless not suitable, these codes SHALL be taken from Identifier Type Codes: A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
36. Organization.identifier.system
Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

ShortThe namespace for the identifier value
Comments

Identifier.system is always case sensitive.

Control0..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
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<br/><b>General</b>:http://www.acme.com/identifiers/patient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
38. Organization.identifier.value
Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

ShortThe 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. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Example<br/><b>General</b>:123456
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
40. Organization.identifier.period
Definition

Time period during which identifier is/was valid for use.

ShortTime period when id is/was valid for use
Control0..1
TypePeriod
Is Modifierfalse
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
42. Organization.identifier.assigner
Definition

Organization that issued/manages the identifier.

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

Control0..1
TypeReference(VhDir Organization)
Is Modifierfalse
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
44. Organization.active
Definition

Whether the networks's record is still in active use

ShortWhether the network's record is still in active use.
Comments

This element is labeled as a modifier because it may be used to mark that the resource was created in error.

Control1..1
Typeboolean
Is Modifiertrue because This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
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.

Labelstatus
Meaning if MissingThis resource is generally assumed to be active if no value is provided for the active element
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
46. Organization.type
Definition

Type of network

ShortType of network
Comments

Type of network

Control0..*
BindingFor example codes, see VhDir Network Type Value Set
TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

Need to be able to track the kind of network this is.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
48. Organization.name
Definition

A name associated with the network (official name designated by the owner of the network).

ShortName
Comments

If the name of an network changes, consider putting the old name in the alias column so that it can still be located through searches.

Control0..1
This element is affected by the following invariants: org-1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Requirements

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

LabelNetwork Name
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
50. Organization.alias
Definition

A list of alternate names that the network is known as, or was known as in the past.

ShortAlternate names by which the Network is known
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 network.

Control0..*
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Requirements

Over time networks may go through many changes and may be known by different names to different users.

Labelalias
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
52. Organization.telecom
Definition

A contact detail for the organization.

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

Control0..0
This element is affected by the following invariants: org-3
TypeContactPoint
Is Modifierfalse
Must Supporttrue
Summaryfalse
Requirements

Human contact for the organization.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
org-3: The telecom of an organization can never be of use 'home' (where(use = 'home').empty())
54. Organization.address
Definition

An address for the network.

ShortAn address for the network
Comments

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

Control0..*
This element is affected by the following invariants: org-2
TypeAddress
Is Modifierfalse
Must Supporttrue
Summaryfalse
Requirements

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

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
org-2: An address of an organization can never be of use 'home' (where(use = 'home').empty())
56. Organization.partOf
Definition

The organization that "owns" this network (typically a payer)

ShortReference to organization that owns the network
Control1..1
TypeReference(VhDir Organization)
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

Need to specify the payor organization of this network

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
58. Organization.contact
Definition

Contact for the network for a certain purpose.

ShortContact for the network 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.

Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Requirements

Need to keep track of assigned contact points for the network

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
60. 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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
62. Organization.contact.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
64. 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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.

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
66. Organization.contact.purpose
Definition

Indicates a purpose for which the contact can be reached.

ShortThe type of contact
Control0..1
BindingUnless not suitable, these codes SHALL be taken from ContactEntityType: The purpose for which you would contact a contact party.
TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summaryfalse
Requirements

Need to distinguish between multiple contact persons.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
68. Organization.contact.name
Definition

A name associated with the contact.

ShortA name associated with the contact
Control0..1
TypeHumanName
Is Modifierfalse
Must Supporttrue
Summaryfalse
Requirements

Need to be able to track the person by name.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
70. 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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
72. Organization.contact.name.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Organization.contact.name.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ url
74. Organization.contact.name.use
Definition

Identifies the purpose for this name.

Shortusual | official | temp | nickname | anonymous | old | maiden
Comments

Applications can assume that a name is current unless it explicitly says that it is temporary or old.

Control0..1
BindingThe codes SHALL be taken from NameUse: The use of a human name.
Typecode
Is Modifiertrue because This is labeled as &quot;Is Modifier&quot; because applications should not mistake a temporary or old name etc.for a current/permanent one
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Requirements

Allows the appropriate name for a particular context of use to be selected from among a set of names.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
76. Organization.contact.name.text
Definition

Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts.

ShortText representation of the full name
Comments

Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Requirements

A renderable, unencoded form.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
78. 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.

ShortFamily name (often called 'Surname')
Comments

Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).

Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Alternate Namessurname
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
80. Organization.contact.name.given
Definition

Given name.

ShortGiven names (not always 'first'). Includes middle names
Comments

If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called "first name" since given names do not always come first.

Control1..*
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Alternate Namesfirst name, middle name
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
82. 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.

ShortParts that come before the name
Control0..*
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
84. 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.

ShortParts that come after the name
Control0..*
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
86. Organization.contact.name.period
Definition

Indicates the period of time when this name was valid for the named person.

ShortTime period when name was/is in use
Control0..1
TypePeriod
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

Allows names to be placed in historical context.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
88. Organization.contact.telecom
Definition

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

ShortContact details (telephone, email, etc.) for a contact
Control0..*
TypeContactPoint
Is Modifierfalse
Must Supporttrue
Summaryfalse
Requirements

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

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
90. 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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
92. Organization.contact.telecom.extension
Definition

An Extension

ShortExtension
Control0..*
TypeExtension
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Organization.contact.telecom.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ url
94. Organization.contact.telecom.extension:availabletime
Slice Nameavailabletime
Definition

Time period when the contact point is to be used

ShortAvailable time
Control0..*
TypeExtension(VhDir Contactpoint Availabletime) (Complex Extension)
Is Modifierfalse
Must Supporttrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
96. Organization.contact.telecom.extension:viaintermediary
Slice Nameviaintermediary
Definition

Represents an external point of contact responsible for handling communications with this entity

Shortviaintermediary
Control0..1
TypeExtension(VhDir Contactpoint Viaintermediary) (Extension Type: Reference(VhDir Practitioner Role, VhDir Organization, VhDir Organization Affiliation, VhDir Location))
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
98. Organization.contact.telecom.system
Definition

Telecommunications form for contact point - what communications system is required to make use of the contact.

Shortphone | fax | email | pager | url | sms | other
Control1..1
This element is affected by the following invariants: cpt-2
BindingThe codes SHALL be taken from ContactPointSystem: Telecommunications form for contact point.
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
100. 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).

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

Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Requirements

Need to support legacy numbers that are not in a tightly controlled format.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
102. Organization.contact.telecom.use
Definition

Identifies the purpose for the contact point.

Shorthome | work | temp | old | mobile - purpose of this contact point
Comments

Applications can assume that a contact is current unless it explicitly says that it is temporary or old.

Control0..1
BindingThe codes SHALL be taken from ContactPointUse: Use of contact point.
Typecode
Is Modifiertrue because This is labeled as &quot;Is Modifier&quot; because applications should not mistake a temporary or old contact etc.for a current/permanent one
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Requirements

Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
104. Organization.contact.telecom.rank
Definition

Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.

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

Control0..1
TypepositiveInt
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
106. Organization.contact.telecom.period
Definition

Time period when the contact point was/is in use.

ShortTime period when the contact point was/is in use
Control0..1
TypePeriod
Is Modifierfalse
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
108. Organization.contact.address
Definition

Visiting or postal addresses for the contact.

ShortVisiting or postal addresses for the contact
Control0..1
TypeAddress
Is Modifierfalse
Must Supporttrue
Summaryfalse
Requirements

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

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
110. Organization.endpoint
Definition

Technical endpoints providing access to services operated for the network

ShortTechnical endpoints providing access to services operated for the network
Control0..*
TypeReference(VhDir Endpoint)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Requirements

Networks may 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.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))