HL7 FHIR® Validated Healthcare Directory Implementation Guide STU 1

Validated Healthcare Directory, HL7 International - Patient Admistration Working Group - CI build for vesion 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

Property Definitions: StructureDefinition-vhdir-organization

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

Control0..*
InvariantsDefined on this element
dom-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.

Control0..1
Typeid
Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

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

Control0..1
TypeMeta
4. 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.

Control0..1
Typeuri
Is Modifiertrue
Comments

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

5. Organization.language
Definition

The base language in which the resource is written.

Control0..1
BindingA human language.
The codes SHOULD be taken from CommonLanguages
Max Binding: AllLanguages
Typecode
Comments

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

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

Control0..1
TypeNarrative
Alternate Namesnarrative, html, xhtml, display
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.

7. Organization.contained
Definition

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

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

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

8. Organization.extension
Definition

An Extension

Control0..*
TypeExtension
SlicingThis element introduces a set of slices on Organization.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
9. Organization.extension:description
SliceNamedescription
Definition

An extension to provide a human-readable description of the organization

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(OrgDescription) (Extension Type: string)
Must Supporttrue
InvariantsDefined on this element
ele-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())
10. Organization.extension:digitalcertificate
SliceNamedigitalcertificate
Definition

An extension to describe digital certificates

Control0..* This element is affected by the following invariants: ele-1
TypeExtension(DigitalCertificate) (Extension Type: Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage)
Must Supporttrue
InvariantsDefined on this element
ele-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())
11. Organization.extension:qualification
SliceNamequalification
Definition

An extensions to represent qualifications obtained by the organization (e.g. accreditation)

Control0..* This element is affected by the following invariants: ele-1
TypeExtension(Qualification) (Extension Type: Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage)
Must Supporttrue
InvariantsDefined on this element
ele-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())
12. Organization.extension:restriction
SliceNamerestriction
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

Control0..* This element is affected by the following invariants: ele-1
TypeExtension(UsageRestriction) (Extension Type: Reference(VhdirRestriction))
Must Supporttrue
InvariantsDefined on this element
ele-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())
13. Organization.extension:insurancePlan
SliceNameinsurancePlan
Definition

Health insurance products offered by the organization to its employees

Control0..* This element is affected by the following invariants: ele-1
TypeExtension(InsurancePlanReference) (Extension Type: Reference(VhdirInsurancePlan))
Must Supporttrue
InvariantsDefined on this element
ele-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.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).

Control0..*
TypeExtension
Is Modifiertrue
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
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.

15. Organization.identifier
Definition

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

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..* This element is affected by the following invariants: org-1
TypeIdentifier
Must Supporttrue
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.

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

Control0..1
Typestring
17. Organization.identifier.extension
Definition

An Extension

Control0..*
TypeExtension
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:
  • value @ url
18. Organization.identifier.extension:status
SliceNamestatus
Definition

Describes the status of an identifier

Control1..1
TypeExtension(IdentifierStatus) (Extension Type: code)
Must Supporttrue
19. Organization.identifier.extension:status.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
20. Organization.identifier.extension:status.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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

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

SlicingThis element introduces a set of slices on Organization.identifier.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
21. Organization.identifier.extension:status.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Valuehttp://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status
22. Organization.identifier.extension:status.value[x]:valueCode
SliceNamevalueCode
Definition

Describes the status of an identifier

Control1..1
BindingThe codes SHALL be taken from VhDir Identifier Status Value Set
Typecode
[x] NoteSee Choice of Data Types for further information about how to use [x]
Must Supporttrue
23. Organization.identifier.use
Definition

The purpose of this identifier.

Control0..1
BindingIdentifies the purpose for this identifier, if known .
The codes SHALL be taken from IdentifierUse
Typecode
Is Modifiertrue
Must Supporttrue
Requirements

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

Comments

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

24. Organization.identifier.type
Definition

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

Control0..1
BindingA coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
The codes SHALL be taken from Identifier Type Codes; other codes may be used where these codes are not suitable
TypeCodeableConcept
Must Supporttrue
Requirements

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

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.

25. Organization.identifier.system
Definition

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

Control0..1
Typeuri
Must Supporttrue
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.

Comments

Identifier.system is always case sensitive.

Example
General:http://www.acme.com/identifiers/patient
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.

Control0..1
Typestring
Must Supporttrue
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.

Example
General:123456
27. Organization.identifier.period
Definition

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

Control0..1
TypePeriod
Must Supporttrue
28. Organization.identifier.assigner
Definition

Organization that issued/manages the identifier.

Control0..1
TypeReference(VhdirOrganization)
Must Supporttrue
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.

29. Organization.active
Definition

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

Control1..1
Typeboolean
Is Modifiertrue
Must Supporttrue
Requirements

Need a flag to indicate a record is no longer to be used and should generally be hidden for the user in the UI.

Comments

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.

Meaning if MissingThis resource is generally assumed to be active if no value is provided for the active element
30. Organization.type
Definition

The kind(s) of organization that this is.

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

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

Comments

Organizations can be corporations, wards, sections, clinical teams, government departments, etc. Note that code is generally a classifier of the type of organization; in many applications, codes are used to identity a particular organization (say, ward) as opposed to another of the same type - these are identifiers, not codes

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.

31. Organization.name
Definition

A name associated with the organization.

Control1..1 This element is affected by the following invariants: org-1
Typestring
Must Supporttrue
Requirements

Need to use the name as the label of 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.

32. Organization.alias
Definition

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

Control0..*
Typestring
Must Supporttrue
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.

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.

33. Organization.alias.id
Definition

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

Control0..1
Typestring
34. Organization.alias.extension
Definition

An Extension

Control0..*
TypeExtension
SlicingThis element introduces a set of slices on Organization.alias.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
35. Organization.alias.extension:type
SliceNametype
Definition

An extension to specify the type of alias an organization used

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(OrgAliasType) (Extension Type: CodeableConcept)
Must Supporttrue
InvariantsDefined on this element
ele-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())
36. Organization.alias.extension:period
SliceNameperiod
Definition

An extension to describe the period of time an organization’s alias was in use

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(OrgAliasPeriod) (Extension Type: Period)
Must Supporttrue
InvariantsDefined on this element
ele-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())
37. Organization.alias.value
Definition

The actual value

Control0..1
Must Supporttrue
Max Length1048576
38. Organization.telecom
Definition

A contact detail for the organization.

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

Human contact for the organization.

Comments

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

InvariantsDefined on this element
org-3: The telecom of an organization can never be of use 'home' (: where(use = 'home').empty())
39. 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.

Control0..1
Typestring
40. Organization.telecom.extension
Definition

An Extension

Control0..*
TypeExtension
SlicingThis element introduces a set of slices on Organization.telecom.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
41. Organization.telecom.extension:viaintermediary
SliceNameviaintermediary
Definition

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

Control0..1
TypeExtension(ContactPointViaIntermediary) (Extension Type: Reference(VhdirPractitionerRole | VhdirOrganization | VhdirOrganizationAffiliation | VhdirLocation))
Must Supporttrue
42. Organization.telecom.extension:viaintermediary.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
43. Organization.telecom.extension:viaintermediary.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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

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

SlicingThis element introduces a set of slices on Organization.telecom.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
44. Organization.telecom.extension:viaintermediary.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Valuehttp://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary
45. Organization.telecom.extension:viaintermediary.value[x]:valueReference
SliceNamevalueReference
Definition

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

Control1..1
TypeReference(VhdirPractitionerRole | VhdirOrganization | VhdirOrganizationAffiliation | VhdirLocation)
[x] NoteSee Choice of Data Types for further information about how to use [x]
Must Supporttrue
46. Organization.telecom.extension:availabletime
SliceNameavailabletime
Definition

Time period when the contact point is to be used

Control0..*
TypeExtension(ContactPointAvailableTime) (Extension Type: Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage)
Must Supporttrue
47. Organization.telecom.extension:availabletime.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
48. Organization.telecom.extension:availabletime.extension
Definition

An Extension

Control0..*
TypeExtension
SlicingThis element introduces a set of slices on Organization.telecom.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
49. Organization.telecom.extension:availabletime.extension:daysOfWeek
SliceNamedaysOfWeek
Definition

Days of the week - mon|tue|wed|thu|fri|sat|sun

Control0..*
TypeExtension
Must Supporttrue
50. Organization.telecom.extension:availabletime.extension:daysOfWeek.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
51. Organization.telecom.extension:availabletime.extension:daysOfWeek.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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

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

SlicingThis element introduces a set of slices on Organization.telecom.extension.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
52. Organization.telecom.extension:availabletime.extension:daysOfWeek.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed ValuedaysOfWeek
53. Organization.telecom.extension:availabletime.extension:daysOfWeek.value[x]:valueCode
SliceNamevalueCode
Definition

Days of the week - mon|tue|wed|thu|fri|sat|sun

Control1..1
BindingThe codes SHALL be taken from DaysOfWeek
Typecode
[x] NoteSee Choice of Data Types for further information about how to use [x]
54. Organization.telecom.extension:availabletime.extension:allDay
SliceNameallDay
Definition

Always available? e.g. 24 hour service

Control0..1
TypeExtension
Must Supporttrue
55. Organization.telecom.extension:availabletime.extension:allDay.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
56. Organization.telecom.extension:availabletime.extension:allDay.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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

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

SlicingThis element introduces a set of slices on Organization.telecom.extension.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
57. Organization.telecom.extension:availabletime.extension:allDay.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed ValueallDay
58. Organization.telecom.extension:availabletime.extension:allDay.value[x]:valueBoolean
SliceNamevalueBoolean
Definition

Always available? e.g. 24 hour service

Control1..1
Typeboolean
[x] NoteSee Choice of Data Types for further information about how to use [x]
59. Organization.telecom.extension:availabletime.extension:availableStartTime
SliceNameavailableStartTime
Definition

Opening time of day (ignored if allDay = true)

Control0..1
TypeExtension
Must Supporttrue
60. Organization.telecom.extension:availabletime.extension:availableStartTime.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
61. Organization.telecom.extension:availabletime.extension:availableStartTime.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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

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

SlicingThis element introduces a set of slices on Organization.telecom.extension.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
62. Organization.telecom.extension:availabletime.extension:availableStartTime.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed ValueavailableStartTime
63. Organization.telecom.extension:availabletime.extension:availableStartTime.value[x]:valueTime
SliceNamevalueTime
Definition

Opening time of day (ignored if allDay = true)

Control1..1
Typetime
[x] NoteSee Choice of Data Types for further information about how to use [x]
64. Organization.telecom.extension:availabletime.extension:availableEndTime
SliceNameavailableEndTime
Definition

Closing time of day (ignored if allDay = true)

Control0..1
TypeExtension
Must Supporttrue
65. Organization.telecom.extension:availabletime.extension:availableEndTime.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
66. Organization.telecom.extension:availabletime.extension:availableEndTime.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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

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

SlicingThis element introduces a set of slices on Organization.telecom.extension.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
67. Organization.telecom.extension:availabletime.extension:availableEndTime.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed ValueavailableEndTime
68. Organization.telecom.extension:availabletime.extension:availableEndTime.value[x]:valueTime
SliceNamevalueTime
Definition

Closing time of day (ignored if allDay = true)

Control1..1
Typetime
[x] NoteSee Choice of Data Types for further information about how to use [x]
69. Organization.telecom.extension:availabletime.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Valuehttp://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
70. Organization.telecom.extension:availabletime.value[x]
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Control0..0
TypeChoice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage
[x] NoteSee Choice of Data Types for further information about how to use [x]
Must Supporttrue
71. Organization.telecom.system
Definition

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

Control1..1 This element is affected by the following invariants: cpt-2
BindingTelecommunications form for contact point.
The codes SHALL be taken from ContactPointSystem
Typecode
Must Supporttrue
72. 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).

Control1..1
Typestring
Must Supporttrue
Requirements

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

Comments

Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.

73. Organization.telecom.use
Definition

Identifies the purpose for the contact point.

Control0..1
BindingUse of contact point.
The codes SHALL be taken from ContactPointUse
Typecode
Is Modifiertrue
Must Supporttrue
Requirements

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

Comments

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

74. Organization.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.

Control0..1
TypepositiveInt
Must Supporttrue
Comments

Note that rank does not necessarily follow the order in which the contacts are represented in the instance.

75. Organization.telecom.period
Definition

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

Control0..1
TypePeriod
Must Supporttrue
76. Organization.address
Definition

An address for the organization.

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

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

Comments

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

InvariantsDefined on this element
org-2: An address of an organization can never be of use 'home' (: where(use = 'home').empty())
77. 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.

Control0..1
Typestring
78. Organization.address.extension
Definition

An Extension

Control0..*
TypeExtension
SlicingThis element introduces a set of slices on Organization.address.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
79. Organization.address.extension:geolocation
SliceNamegeolocation
Definition

The absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML).

Control0..1
TypeExtension(Geolocation) (Extension Type: Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage)
Must Supporttrue
Comments

The extension can be further extended to include unique geolocation identifiers, confidence, altitude, etc.

80. Organization.address.extension:geolocation.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
81. Organization.address.extension:geolocation.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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

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

SlicingThis element introduces a set of slices on Organization.address.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
82. Organization.address.extension:geolocation.extension:latitude
SliceNamelatitude
Definition

Latitude. The value domain and the interpretation are the same as for the text of the latitude element in KML (see notes below).

Control1..1
TypeExtension
83. Organization.address.extension:geolocation.extension:latitude.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
84. Organization.address.extension:geolocation.extension:latitude.extension
Definition

An Extension

Control0..0
TypeExtension
SlicingThis element introduces a set of slices on Organization.address.extension.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
85. Organization.address.extension:geolocation.extension:latitude.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Valuelatitude
86. Organization.address.extension:geolocation.extension:latitude.valueDecimal
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Control0..1
Typedecimal
87. Organization.address.extension:geolocation.extension:longitude
SliceNamelongitude
Definition

Longitude. The value domain and the interpretation are the same as for the text of the longitude element in KML (see notes below).

Control1..1
TypeExtension
88. Organization.address.extension:geolocation.extension:longitude.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
89. Organization.address.extension:geolocation.extension:longitude.extension
Definition

An Extension

Control0..0
TypeExtension
SlicingThis element introduces a set of slices on Organization.address.extension.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
90. Organization.address.extension:geolocation.extension:longitude.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Valuelongitude
91. Organization.address.extension:geolocation.extension:longitude.valueDecimal
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Control0..1
Typedecimal
92. Organization.address.extension:geolocation.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Valuehttp://hl7.org/fhir/StructureDefinition/geolocation
93. Organization.address.extension:geolocation.value[x]
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Control0..0
TypeChoice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage
[x] NoteSee Choice of Data Types for further information about how to use [x]
94. Organization.address.use
Definition

The purpose of this address.

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

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

Comments

Applications can assume that an address is current unless it explicitly says that it is temporary or old.

Example
General:home
95. Organization.address.type
Definition

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

Control0..1
BindingThe type of an address (physical / postal).
The codes SHALL be taken from AddressType
Typecode
Must Supporttrue
Comments

The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource).

Example
General:both
96. Organization.address.text
Definition

Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.

Control0..1
Typestring
Must Supporttrue
Requirements

A renderable, unencoded form.

Comments

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

Example
General:137 Nowhere Street, Erewhon 9132
97. Organization.address.line
Definition

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

Control0..*
Typestring
Must Supporttrue
Example
General:137 Nowhere Street
98. Organization.address.city
Definition

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

Control0..1
Typestring
Must Supporttrue
Alternate NamesMunicpality
Example
General:Erewhon
99. Organization.address.district
Definition

The name of the administrative area (county).

Control0..1
Typestring
Must Supporttrue
Alternate NamesCounty
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.

Example
General:Madison
100. 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 (e.g. US 2 letter state codes).

Control0..1
Typestring
Must Supporttrue
Alternate NamesProvince, Territory
101. Organization.address.postalCode
Definition

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

Control0..1
Typestring
Must Supporttrue
Alternate NamesZip
Example
General:9132
102. Organization.address.country
Definition

Country - a nation as commonly understood or generally accepted.

Control0..1
Typestring
Must Supporttrue
Comments

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

103. Organization.address.period
Definition

Time period when address was/is in use.

Control0..1
TypePeriod
Must Supporttrue
Requirements

Allows addresses to be placed in historical context.

Example
General:<valuePeriod xmlns="http://hl7.org/fhir">
  <start value="2010-03-23T00:00:00+00:00"/>
  <end value="2010-07-01T00:00:00+00:00"/>
</valuePeriod>
104. Organization.partOf
Definition

The organization of which this organization forms a part.

Control0..1
TypeReference(VhdirOrganization)
Must Supporttrue
Requirements

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

105. Organization.contact
Definition

Contact for the organization for a certain purpose.

Control0..*
TypeBackboneElement
Must Supporttrue
Requirements

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

Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
106. 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.

Control0..1
Typestring
107. 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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

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

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

Control0..*
TypeExtension
Is Modifiertrue
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
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.

109. Organization.contact.purpose
Definition

Indicates a purpose for which the contact can be reached.

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

Need to distinguish between multiple contact persons.

110. Organization.contact.name
Definition

A name associated with the contact.

Control0..1
TypeHumanName
Must Supporttrue
Requirements

Need to be able to track the person by name.

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

Control0..1
Typestring
112. 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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

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

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:
  • value @ url
113. Organization.contact.name.use
Definition

Identifies the purpose for this name.

Control0..1
BindingThe use of a human name.
The codes SHALL be taken from NameUse
Typecode
Is Modifiertrue
Must Supporttrue
Requirements

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

Comments

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

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

Control0..1
Typestring
Must Supporttrue
Requirements

A renderable, unencoded form.

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.

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

Control1..1
Typestring
Must Supporttrue
Alternate Namessurname
Comments

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

116. Organization.contact.name.given
Definition

Given name.

Control1..*
Typestring
Must Supporttrue
Alternate Namesfirst name, middle name
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.

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

Control0..*
Typestring
Must Supporttrue
118. 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.

Control0..*
Typestring
Must Supporttrue
119. Organization.contact.name.period
Definition

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

Control0..1
TypePeriod
Must Supporttrue
Requirements

Allows names to be placed in historical context.

120. Organization.contact.telecom
Definition

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

Control0..*
TypeContactPoint
Must Supporttrue
Requirements

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

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

Control0..1
Typestring
122. Organization.contact.telecom.extension
Definition

An Extension

Control0..*
TypeExtension
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:
  • value @ url
123. Organization.contact.telecom.extension:viaintermediary
SliceNameviaintermediary
Definition

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

Control0..1
TypeExtension(ContactPointViaIntermediary) (Extension Type: Reference(VhdirPractitionerRole | VhdirOrganization | VhdirOrganizationAffiliation | VhdirLocation))
Must Supporttrue
124. Organization.contact.telecom.extension:viaintermediary.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
125. Organization.contact.telecom.extension:viaintermediary.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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

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

SlicingThis element introduces a set of slices on Organization.contact.telecom.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
126. Organization.contact.telecom.extension:viaintermediary.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Valuehttp://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary
127. Organization.contact.telecom.extension:viaintermediary.value[x]:valueReference
SliceNamevalueReference
Definition

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

Control1..1
TypeReference(VhdirPractitionerRole | VhdirOrganization | VhdirOrganizationAffiliation | VhdirLocation)
[x] NoteSee Choice of Data Types for further information about how to use [x]
Must Supporttrue
128. Organization.contact.telecom.extension:availabletime
SliceNameavailabletime
Definition

Time period when the contact point is to be used

Control0..*
TypeExtension(ContactPointAvailableTime) (Extension Type: Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage)
Must Supporttrue
129. Organization.contact.telecom.extension:availabletime.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
130. Organization.contact.telecom.extension:availabletime.extension
Definition

An Extension

Control0..*
TypeExtension
SlicingThis element introduces a set of slices on Organization.contact.telecom.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
131. Organization.contact.telecom.extension:availabletime.extension:daysOfWeek
SliceNamedaysOfWeek
Definition

Days of the week - mon|tue|wed|thu|fri|sat|sun

Control0..*
TypeExtension
Must Supporttrue
132. Organization.contact.telecom.extension:availabletime.extension:daysOfWeek.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
133. Organization.contact.telecom.extension:availabletime.extension:daysOfWeek.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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

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

SlicingThis element introduces a set of slices on Organization.contact.telecom.extension.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
134. Organization.contact.telecom.extension:availabletime.extension:daysOfWeek.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed ValuedaysOfWeek
135. Organization.contact.telecom.extension:availabletime.extension:daysOfWeek.value[x]:valueCode
SliceNamevalueCode
Definition

Days of the week - mon|tue|wed|thu|fri|sat|sun

Control1..1
BindingThe codes SHALL be taken from DaysOfWeek
Typecode
[x] NoteSee Choice of Data Types for further information about how to use [x]
136. Organization.contact.telecom.extension:availabletime.extension:allDay
SliceNameallDay
Definition

Always available? e.g. 24 hour service

Control0..1
TypeExtension
Must Supporttrue
137. Organization.contact.telecom.extension:availabletime.extension:allDay.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
138. Organization.contact.telecom.extension:availabletime.extension:allDay.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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

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

SlicingThis element introduces a set of slices on Organization.contact.telecom.extension.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
139. Organization.contact.telecom.extension:availabletime.extension:allDay.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed ValueallDay
140. Organization.contact.telecom.extension:availabletime.extension:allDay.value[x]:valueBoolean
SliceNamevalueBoolean
Definition

Always available? e.g. 24 hour service

Control1..1
Typeboolean
[x] NoteSee Choice of Data Types for further information about how to use [x]
141. Organization.contact.telecom.extension:availabletime.extension:availableStartTime
SliceNameavailableStartTime
Definition

Opening time of day (ignored if allDay = true)

Control0..1
TypeExtension
Must Supporttrue
142. Organization.contact.telecom.extension:availabletime.extension:availableStartTime.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
143. Organization.contact.telecom.extension:availabletime.extension:availableStartTime.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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

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

SlicingThis element introduces a set of slices on Organization.contact.telecom.extension.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
144. Organization.contact.telecom.extension:availabletime.extension:availableStartTime.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed ValueavailableStartTime
145. Organization.contact.telecom.extension:availabletime.extension:availableStartTime.value[x]:valueTime
SliceNamevalueTime
Definition

Opening time of day (ignored if allDay = true)

Control1..1
Typetime
[x] NoteSee Choice of Data Types for further information about how to use [x]
146. Organization.contact.telecom.extension:availabletime.extension:availableEndTime
SliceNameavailableEndTime
Definition

Closing time of day (ignored if allDay = true)

Control0..1
TypeExtension
Must Supporttrue
147. Organization.contact.telecom.extension:availabletime.extension:availableEndTime.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
148. Organization.contact.telecom.extension:availabletime.extension:availableEndTime.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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

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

SlicingThis element introduces a set of slices on Organization.contact.telecom.extension.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
149. Organization.contact.telecom.extension:availabletime.extension:availableEndTime.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed ValueavailableEndTime
150. Organization.contact.telecom.extension:availabletime.extension:availableEndTime.value[x]:valueTime
SliceNamevalueTime
Definition

Closing time of day (ignored if allDay = true)

Control1..1
Typetime
[x] NoteSee Choice of Data Types for further information about how to use [x]
151. Organization.contact.telecom.extension:availabletime.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Valuehttp://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
152. Organization.contact.telecom.extension:availabletime.value[x]
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Control0..0
TypeChoice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage
[x] NoteSee Choice of Data Types for further information about how to use [x]
Must Supporttrue
153. Organization.contact.telecom.system
Definition

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

Control1..1 This element is affected by the following invariants: cpt-2
BindingTelecommunications form for contact point.
The codes SHALL be taken from ContactPointSystem
Typecode
Must Supporttrue
154. 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).

Control1..1
Typestring
Must Supporttrue
Requirements

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

Comments

Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.

155. Organization.contact.telecom.use
Definition

Identifies the purpose for the contact point.

Control0..1
BindingUse of contact point.
The codes SHALL be taken from ContactPointUse
Typecode
Is Modifiertrue
Must Supporttrue
Requirements

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

Comments

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

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

Control0..1
TypepositiveInt
Must Supporttrue
Comments

Note that rank does not necessarily follow the order in which the contacts are represented in the instance.

157. Organization.contact.telecom.period
Definition

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

Control0..1
TypePeriod
Must Supporttrue
158. Organization.contact.address
Definition

Visiting or postal addresses for the contact.

Control0..1
TypeAddress
Must Supporttrue
Requirements

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

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

Control0..1
Typestring
160. Organization.contact.address.extension
Definition

An Extension

Control0..*
TypeExtension
SlicingThis element introduces a set of slices on Organization.contact.address.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
161. Organization.contact.address.extension:position
SliceNameposition
Definition

The absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML).

Control0..1
TypeExtension(Geolocation) (Extension Type: Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage)
Must Supporttrue
Comments

The extension can be further extended to include unique geolocation identifiers, confidence, altitude, etc.

162. Organization.contact.address.extension:position.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
163. Organization.contact.address.extension:position.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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

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

SlicingThis element introduces a set of slices on Organization.contact.address.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
164. Organization.contact.address.extension:position.extension:latitude
SliceNamelatitude
Definition

Latitude. The value domain and the interpretation are the same as for the text of the latitude element in KML (see notes below).

Control1..1
TypeExtension
165. Organization.contact.address.extension:position.extension:latitude.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
166. Organization.contact.address.extension:position.extension:latitude.extension
Definition

An Extension

Control0..0
TypeExtension
SlicingThis element introduces a set of slices on Organization.contact.address.extension.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
167. Organization.contact.address.extension:position.extension:latitude.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Valuelatitude
168. Organization.contact.address.extension:position.extension:latitude.valueDecimal
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Control0..1
Typedecimal
169. Organization.contact.address.extension:position.extension:longitude
SliceNamelongitude
Definition

Longitude. The value domain and the interpretation are the same as for the text of the longitude element in KML (see notes below).

Control1..1
TypeExtension
170. Organization.contact.address.extension:position.extension:longitude.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
171. Organization.contact.address.extension:position.extension:longitude.extension
Definition

An Extension

Control0..0
TypeExtension
SlicingThis element introduces a set of slices on Organization.contact.address.extension.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
172. Organization.contact.address.extension:position.extension:longitude.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Valuelongitude
173. Organization.contact.address.extension:position.extension:longitude.valueDecimal
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Control0..1
Typedecimal
174. Organization.contact.address.extension:position.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Valuehttp://hl7.org/fhir/StructureDefinition/geolocation
175. Organization.contact.address.extension:position.value[x]
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Control0..0
TypeChoice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage
[x] NoteSee Choice of Data Types for further information about how to use [x]
176. Organization.contact.address.use
Definition

The purpose of this address.

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

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

Comments

Applications can assume that an address is current unless it explicitly says that it is temporary or old.

Example
General:home
177. 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.

Control0..1
BindingThe type of an address (physical / postal).
The codes SHALL be taken from AddressType
Typecode
Must Supporttrue
Comments

The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource).

Example
General:both
178. Organization.contact.address.text
Definition

Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.

Control0..1
Typestring
Must Supporttrue
Requirements

A renderable, unencoded form.

Comments

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

Example
General:137 Nowhere Street, Erewhon 9132
179. 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.

Control0..*
Typestring
Must Supporttrue
Example
General:137 Nowhere Street
180. Organization.contact.address.city
Definition

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

Control0..1
Typestring
Must Supporttrue
Alternate NamesMunicpality
Example
General:Erewhon
181. Organization.contact.address.district
Definition

The name of the administrative area (county).

Control0..1
Typestring
Must Supporttrue
Alternate NamesCounty
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.

Example
General:Madison
182. 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 (e.g. US 2 letter state codes).

Control0..1
Typestring
Must Supporttrue
Alternate NamesProvince, Territory
183. Organization.contact.address.postalCode
Definition

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

Control0..1
Typestring
Must Supporttrue
Alternate NamesZip
Example
General:9132
184. Organization.contact.address.country
Definition

Country - a nation as commonly understood or generally accepted.

Control0..1
Typestring
Must Supporttrue
Comments

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

185. Organization.contact.address.period
Definition

Time period when address was/is in use.

Control0..1
TypePeriod
Must Supporttrue
Requirements

Allows addresses to be placed in historical context.

Example
General:<valuePeriod xmlns="http://hl7.org/fhir">
  <start value="2010-03-23T00:00:00+00:00"/>
  <end value="2010-07-01T00:00:00+00:00"/>
</valuePeriod>
186. Organization.endpoint
Definition

Technical endpoints providing access to services operated for the organization.

Control0..*
TypeReference(VhdirEndpoint)
Must Supporttrue
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.

Terminology Bindings

PathConformanceValueSet
Organization.languagepreferredCommonLanguages
Max Binding: AllLanguages
Organization.identifier.extension:status.value[x]:valueCoderequiredVhDirIdentifierStatus
Organization.identifier.userequiredIdentifierUse
Organization.identifier.typeextensibleIdentifier Type Codes
Organization.typeexampleOrganizationType
Organization.telecom.extension:availabletime.extension:daysOfWeek.value[x]:valueCoderequiredDaysOfWeek
Organization.telecom.systemrequiredContactPointSystem
Organization.telecom.userequiredContactPointUse
Organization.address.userequiredAddressUse
Organization.address.typerequiredAddressType
Organization.contact.purposeextensibleContactEntityType
Organization.contact.name.userequiredNameUse
Organization.contact.telecom.extension:availabletime.extension:daysOfWeek.value[x]:valueCoderequiredDaysOfWeek
Organization.contact.telecom.systemrequiredContactPointSystem
Organization.contact.telecom.userequiredContactPointUse
Organization.contact.address.userequiredAddressUse
Organization.contact.address.typerequiredAddressType