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 guide is not an authorized publication; it is the continuous build for version 0.2.0 built by the FHIR (HL7® FHIR® Standard) CI Build. 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: VhDir Organization

Official URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/vhdir-organization Version: 0.2.0
Active as of 2017-09-01 Computable Name: VhdirOrganization

Copyright/Legal: HL7 International

Defines the basic constraints and extensions on the Organization resource for use in a Validated Healthcare Directory

This profile sets minimum expectations for searching for and fetching information associated with an organization. It identifies which core elements, extensions, vocabularies and value sets SHALL be present in the Organization resource when using this profile.

Background & Scope

An organization is a formal or informal grouping of people or organizations with a common purpose, such as a company, institution, corporation, community group, or healthcare practice.

This profile modifies the base Organization resource in the following manner:

  • Constrains the cardinality of organization.active (1..1), organization.type (1..), organization.name (1..1), organization.telecom.system (1..1), organization.telecom.value (1..1), organization.contact.name.family (1..1), organization.contact.name.given (1..), organization.contact.telecom.system (1..1), and organization.contact.telecom.value (1..1)

  • All references SHALL conform to the appropriate Validated Healthcare Directory Implementation Guide profile

  • Adds extensions:

  1. Identifier status (1..1) - indicates the status of an organization’s identifier
  2. Via intermediary (0..1) - a reference to an alternative point of contact for this organization
  3. Available time (0..*) - indicates when an organization is available for contact
  4. Geolocation (0..1) - indicates the absolute geographic location of an organization’s address
  5. Alias type (0..1) - indicates whether an organization’s alias is a historical name or legal alternative name
  6. Alias period (0..1) - indicates a period of time for which an organization used an alias
  7. Description (0..1) - a friendly description of the organization
  8. Qualification (0..*) - indicates whether the organization has any formal qualifications
  9. DigitalCertificate (0..*) - a digital certificate associated with the organization
  10. InsurancePlan (0..*) - indicates the health insurance products the organization offers to its employees
  11. Restriction (0..*) - indicates whether disclosure of any data associated with an organization is restricted

Examples:

The following are example uses for the vhdir-organization profile:

Mandatory Data Elements

The following data-elements are mandatory (i.e data MUST be present). These are presented below in a simple human-readable explanation. The Formal Profile Definition below provides the formal summary, definitions, and terminology requirements.

Each organization must have:

  1. A boolean value in organization.active
  2. A name in organization.name
  3. A type in organization.type

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Organization

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization 0..* Organization A grouping of people or organizations with a common purpose
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
... description S 0..1 string Description of the organization
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/org-description
... digitalcertificate S 0..* (Complex) Organization's digital certificate
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/digitalcertificate
... qualification S 0..* (Complex) The organization's qualifications
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/qualification
... restriction S 0..* Reference(VhDir Restriction) Restriction
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction
... insurancePlan S 0..* Reference(VhDir Insurance Plan) Insurance plan(s) offered to the organization's employees
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/insuranceplan-reference
... identifier S 0..* Identifier Identifies this organization across multiple systems
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... status S 1..1 code Status
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status
Binding: VhDir Identifier Status Value Set (required)
.... use S 0..1 code usual | official | temp | secondary | old (If known)
.... type S 0..1 CodeableConcept Description of identifier
.... system S 0..1 uri The namespace for the identifier value
.... value S 0..1 string The value that is unique
.... period S 0..1 Period Time period when id is/was valid for use
.... assigner S 0..1 Reference(VhDir Organization) Organization that issued id (may be just text)
... active S 1..1 boolean Whether the organization's record is still in active use
... type S 1..* CodeableConcept Kind of organization
... name S 1..1 string Name used for the organization
... alias S 0..* string A list of alternate names that the organization is known as, or was known as in the past
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... type S 0..1 CodeableConcept Type of alias
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/org-alias-type
Binding: VhDir Alias Type Value Set (example)
.... period S 0..1 Period Time period for alias
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/org-alias-period
.... value S 0..1 string Primitive value for string
... telecom S 0..* ContactPoint A contact detail for the organization
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... viaintermediary S 0..1 Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location) viaintermediary
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary
.... availabletime S 0..* (Complex) Available time
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
.... system S 1..1 code phone | fax | email | pager | url | sms | other
.... value S 1..1 string The actual contact point details
.... use S 0..1 code home | work | temp | old | mobile - purpose of this contact point
.... rank S 0..1 positiveInt Specify preferred order of use (1 = highest)
.... period S 0..1 Period Time period when the contact point was/is in use
... address S 0..* Address An address for the organization
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... geolocation S 0..1 (Complex) The absolute geographic location
URL: http://hl7.org/fhir/StructureDefinition/geolocation
.... use S 0..1 code home | work | temp | old | billing - purpose of this address
.... type S 0..1 code postal | physical | both
.... text S 0..1 string Text representation of the address
.... line S 0..* string Street name, number, direction & P.O. Box etc.
.... city S 0..1 string Name of city, town etc.
.... district S 0..1 string District name (aka county)
.... state S 0..1 string Sub-unit of country (abbreviations ok)
.... postalCode S 0..1 string Postal code for area
.... country S 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
.... period S 0..1 Period Time period when address was/is in use
... partOf S 0..1 Reference(VhDir Organization) The organization of which this organization forms a part
... contact S 0..* BackboneElement Contact for the organization for a certain purpose
.... purpose S 0..1 CodeableConcept The type of contact
.... name S 0..1 HumanName A name associated with the contact
..... use S 0..1 code usual | official | temp | nickname | anonymous | old | maiden
..... text S 0..1 string Text representation of the full name
..... family S 1..1 string Family name (often called 'Surname')
..... given S 1..* string Given names (not always 'first'). Includes middle names
..... prefix S 0..* string Parts that come before the name
..... suffix S 0..* string Parts that come after the name
..... period S 0..1 Period Time period when name was/is in use
.... telecom S 0..* ContactPoint Contact details (telephone, email, etc.) for a contact
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... viaintermediary S 0..1 Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location) viaintermediary
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary
..... availabletime S 0..* (Complex) Available time
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
..... system S 1..1 code phone | fax | email | pager | url | sms | other
..... value S 1..1 string The actual contact point details
..... use S 0..1 code home | work | temp | old | mobile - purpose of this contact point
..... rank S 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period S 0..1 Period Time period when the contact point was/is in use
.... address S 0..1 Address Visiting or postal addresses for the contact
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... position S 0..1 (Complex) The absolute geographic location
URL: http://hl7.org/fhir/StructureDefinition/geolocation
..... use S 0..1 code home | work | temp | old | billing - purpose of this address
..... type S 0..1 code postal | physical | both
..... text S 0..1 string Text representation of the address
..... line S 0..* string Street name, number, direction & P.O. Box etc.
..... city S 0..1 string Name of city, town etc.
..... district S 0..1 string District name (aka county)
..... state S 0..1 string Sub-unit of country (abbreviations ok)
..... postalCode S 0..1 string Postal code for area
..... country S 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
..... period S 0..1 Period Time period when address was/is in use
... endpoint S 0..* Reference(VhDir Endpoint) Technical endpoints providing access to services operated for the organization

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C 0..* Organization A grouping of people or organizations with a common purpose
org-1: The organization SHALL at least have a name or an identifier, and possibly more than one
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
... description S 0..1 string Description of the organization
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/org-description
... digitalcertificate S 0..* (Complex) Organization's digital certificate
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/digitalcertificate
... qualification S 0..* (Complex) The organization's qualifications
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/qualification
... restriction S 0..* Reference(VhDir Restriction) Restriction
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction
... insurancePlan S 0..* Reference(VhDir Insurance Plan) Insurance plan(s) offered to the organization's employees
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/insuranceplan-reference
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣC 0..* Identifier Identifies this organization across multiple systems
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... status S 1..1 code Status
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status
Binding: VhDir Identifier Status Value Set (required)
.... use ?!SΣ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type SΣ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

.... system SΣ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 0..1 string The value that is unique
Example General: 123456
.... period SΣ 0..1 Period Time period when id is/was valid for use
.... assigner SΣ 0..1 Reference(VhDir Organization) Organization that issued id (may be just text)
... active ?!SΣ 1..1 boolean Whether the organization's record is still in active use
... type SΣ 1..* CodeableConcept Kind of organization
Binding: OrganizationType (example): Used to categorize the organization.


... name SΣC 1..1 string Name used for the organization
... alias S 0..* string A list of alternate names that the organization is known as, or was known as in the past
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... type S 0..1 CodeableConcept Type of alias
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/org-alias-type
Binding: VhDir Alias Type Value Set (example)
.... period S 0..1 Period Time period for alias
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/org-alias-period
.... value S 0..1 string Primitive value for string
Max Length: 1048576
... telecom SC 0..* ContactPoint A contact detail for the organization
org-3: The telecom of an organization can never be of use 'home'
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... viaintermediary S 0..1 Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location) viaintermediary
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary
.... availabletime S 0..* (Complex) Available time
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
.... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value SΣ 1..1 string The actual contact point details
.... use ?!SΣ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

.... rank SΣ 0..1 positiveInt Specify preferred order of use (1 = highest)
.... period SΣ 0..1 Period Time period when the contact point was/is in use
... address SC 0..* Address An address for the organization
org-2: An address of an organization can never be of use 'home'
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... geolocation S 0..1 (Complex) The absolute geographic location
URL: http://hl7.org/fhir/StructureDefinition/geolocation
.... use ?!SΣ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... type SΣ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
.... text SΣ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line SΣ 0..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city SΣ 0..1 string Name of city, town etc.
Example General: Erewhon
.... district SΣ 0..1 string District name (aka county)
Example General: Madison
.... state SΣ 0..1 string Sub-unit of country (abbreviations ok)
.... postalCode SΣ 0..1 string Postal code for area
Example General: 9132
.... country SΣ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
.... period SΣ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... partOf SΣ 0..1 Reference(VhDir Organization) The organization of which this organization forms a part
... contact S 0..* BackboneElement Contact for the organization for a certain purpose
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... purpose S 0..1 CodeableConcept The type of contact
Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.

.... name S 0..1 HumanName A name associated with the contact
..... use ?!SΣ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

..... text SΣ 0..1 string Text representation of the full name
..... family SΣ 1..1 string Family name (often called 'Surname')
..... given SΣ 1..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
..... prefix SΣ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
..... suffix SΣ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
..... period SΣ 0..1 Period Time period when name was/is in use
.... telecom S 0..* ContactPoint Contact details (telephone, email, etc.) for a contact
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... viaintermediary S 0..1 Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location) viaintermediary
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary
..... availabletime S 0..* (Complex) Available time
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
..... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

..... value SΣ 1..1 string The actual contact point details
..... use ?!SΣ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

..... rank SΣ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period SΣ 0..1 Period Time period when the contact point was/is in use
.... address S 0..1 Address Visiting or postal addresses for the contact
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... position S 0..1 (Complex) The absolute geographic location
URL: http://hl7.org/fhir/StructureDefinition/geolocation
..... use ?!SΣ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
..... type SΣ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
..... text SΣ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
..... line SΣ 0..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
..... city SΣ 0..1 string Name of city, town etc.
Example General: Erewhon
..... district SΣ 0..1 string District name (aka county)
Example General: Madison
..... state SΣ 0..1 string Sub-unit of country (abbreviations ok)
..... postalCode SΣ 0..1 string Postal code for area
Example General: 9132
..... country SΣ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
..... period SΣ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... endpoint S 0..* Reference(VhDir Endpoint) Technical endpoints providing access to services operated for the organization

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Organization.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Organization.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Organization.typeexampleOrganizationType
http://hl7.org/fhir/ValueSet/organization-type
from the FHIR Standard
Organization.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Organization.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Organization.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Organization.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Organization.contact.purposeextensibleContactEntityType
http://hl7.org/fhir/ValueSet/contactentity-type
from the FHIR Standard
Organization.contact.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Organization.contact.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Organization.contact.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Organization.contact.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Organization.contact.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C 0..* Organization A grouping of people or organizations with a common purpose
org-1: The organization SHALL at least have a name or an identifier, and possibly more than one
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
... description S 0..1 string Description of the organization
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/org-description
... digitalcertificate S 0..* (Complex) Organization's digital certificate
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/digitalcertificate
... qualification S 0..* (Complex) The organization's qualifications
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/qualification
... restriction S 0..* Reference(VhDir Restriction) Restriction
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction
... insurancePlan S 0..* Reference(VhDir Insurance Plan) Insurance plan(s) offered to the organization's employees
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/insuranceplan-reference
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣC 0..* Identifier Identifies this organization across multiple systems
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... status S 1..1 code Status
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status
Binding: VhDir Identifier Status Value Set (required)
.... use ?!SΣ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type SΣ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

.... system SΣ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 0..1 string The value that is unique
Example General: 123456
.... period SΣ 0..1 Period Time period when id is/was valid for use
.... assigner SΣ 0..1 Reference(VhDir Organization) Organization that issued id (may be just text)
... active ?!SΣ 1..1 boolean Whether the organization's record is still in active use
... type SΣ 1..* CodeableConcept Kind of organization
Binding: OrganizationType (example): Used to categorize the organization.


... name SΣC 1..1 string Name used for the organization
... alias S 0..* string A list of alternate names that the organization is known as, or was known as in the past
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... type S 0..1 CodeableConcept Type of alias
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/org-alias-type
Binding: VhDir Alias Type Value Set (example)
.... period S 0..1 Period Time period for alias
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/org-alias-period
.... value S 0..1 string Primitive value for string
Max Length: 1048576
... telecom SC 0..* ContactPoint A contact detail for the organization
org-3: The telecom of an organization can never be of use 'home'
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... viaintermediary S 0..1 Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location) viaintermediary
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary
.... availabletime S 0..* (Complex) Available time
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
.... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value SΣ 1..1 string The actual contact point details
.... use ?!SΣ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

.... rank SΣ 0..1 positiveInt Specify preferred order of use (1 = highest)
.... period SΣ 0..1 Period Time period when the contact point was/is in use
... address SC 0..* Address An address for the organization
org-2: An address of an organization can never be of use 'home'
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... geolocation S 0..1 (Complex) The absolute geographic location
URL: http://hl7.org/fhir/StructureDefinition/geolocation
.... use ?!SΣ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... type SΣ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
.... text SΣ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line SΣ 0..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city SΣ 0..1 string Name of city, town etc.
Example General: Erewhon
.... district SΣ 0..1 string District name (aka county)
Example General: Madison
.... state SΣ 0..1 string Sub-unit of country (abbreviations ok)
.... postalCode SΣ 0..1 string Postal code for area
Example General: 9132
.... country SΣ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
.... period SΣ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... partOf SΣ 0..1 Reference(VhDir Organization) The organization of which this organization forms a part
... contact S 0..* BackboneElement Contact for the organization for a certain purpose
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... purpose S 0..1 CodeableConcept The type of contact
Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.

.... name S 0..1 HumanName A name associated with the contact
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!SΣ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

..... text SΣ 0..1 string Text representation of the full name
..... family SΣ 1..1 string Family name (often called 'Surname')
..... given SΣ 1..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
..... prefix SΣ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
..... suffix SΣ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
..... period SΣ 0..1 Period Time period when name was/is in use
.... telecom S 0..* ContactPoint Contact details (telephone, email, etc.) for a contact
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... viaintermediary S 0..1 Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location) viaintermediary
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary
..... availabletime S 0..* (Complex) Available time
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
..... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

..... value SΣ 1..1 string The actual contact point details
..... use ?!SΣ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

..... rank SΣ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period SΣ 0..1 Period Time period when the contact point was/is in use
.... address S 0..1 Address Visiting or postal addresses for the contact
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... position S 0..1 (Complex) The absolute geographic location
URL: http://hl7.org/fhir/StructureDefinition/geolocation
..... use ?!SΣ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
..... type SΣ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
..... text SΣ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
..... line SΣ 0..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
..... city SΣ 0..1 string Name of city, town etc.
Example General: Erewhon
..... district SΣ 0..1 string District name (aka county)
Example General: Madison
..... state SΣ 0..1 string Sub-unit of country (abbreviations ok)
..... postalCode SΣ 0..1 string Postal code for area
Example General: 9132
..... country SΣ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
..... period SΣ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... endpoint S 0..* Reference(VhDir Endpoint) Technical endpoints providing access to services operated for the organization

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Organization.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Organization.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Organization.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Organization.typeexampleOrganizationType
http://hl7.org/fhir/ValueSet/organization-type
from the FHIR Standard
Organization.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Organization.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Organization.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Organization.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Organization.contact.purposeextensibleContactEntityType
http://hl7.org/fhir/ValueSet/contactentity-type
from the FHIR Standard
Organization.contact.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Organization.contact.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Organization.contact.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Organization.contact.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Organization.contact.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard

Differential View

This structure is derived from Organization

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization 0..* Organization A grouping of people or organizations with a common purpose
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
... description S 0..1 string Description of the organization
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/org-description
... digitalcertificate S 0..* (Complex) Organization's digital certificate
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/digitalcertificate
... qualification S 0..* (Complex) The organization's qualifications
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/qualification
... restriction S 0..* Reference(VhDir Restriction) Restriction
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction
... insurancePlan S 0..* Reference(VhDir Insurance Plan) Insurance plan(s) offered to the organization's employees
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/insuranceplan-reference
... identifier S 0..* Identifier Identifies this organization across multiple systems
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... status S 1..1 code Status
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status
Binding: VhDir Identifier Status Value Set (required)
.... use S 0..1 code usual | official | temp | secondary | old (If known)
.... type S 0..1 CodeableConcept Description of identifier
.... system S 0..1 uri The namespace for the identifier value
.... value S 0..1 string The value that is unique
.... period S 0..1 Period Time period when id is/was valid for use
.... assigner S 0..1 Reference(VhDir Organization) Organization that issued id (may be just text)
... active S 1..1 boolean Whether the organization's record is still in active use
... type S 1..* CodeableConcept Kind of organization
... name S 1..1 string Name used for the organization
... alias S 0..* string A list of alternate names that the organization is known as, or was known as in the past
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... type S 0..1 CodeableConcept Type of alias
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/org-alias-type
Binding: VhDir Alias Type Value Set (example)
.... period S 0..1 Period Time period for alias
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/org-alias-period
.... value S 0..1 string Primitive value for string
... telecom S 0..* ContactPoint A contact detail for the organization
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... viaintermediary S 0..1 Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location) viaintermediary
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary
.... availabletime S 0..* (Complex) Available time
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
.... system S 1..1 code phone | fax | email | pager | url | sms | other
.... value S 1..1 string The actual contact point details
.... use S 0..1 code home | work | temp | old | mobile - purpose of this contact point
.... rank S 0..1 positiveInt Specify preferred order of use (1 = highest)
.... period S 0..1 Period Time period when the contact point was/is in use
... address S 0..* Address An address for the organization
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... geolocation S 0..1 (Complex) The absolute geographic location
URL: http://hl7.org/fhir/StructureDefinition/geolocation
.... use S 0..1 code home | work | temp | old | billing - purpose of this address
.... type S 0..1 code postal | physical | both
.... text S 0..1 string Text representation of the address
.... line S 0..* string Street name, number, direction & P.O. Box etc.
.... city S 0..1 string Name of city, town etc.
.... district S 0..1 string District name (aka county)
.... state S 0..1 string Sub-unit of country (abbreviations ok)
.... postalCode S 0..1 string Postal code for area
.... country S 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
.... period S 0..1 Period Time period when address was/is in use
... partOf S 0..1 Reference(VhDir Organization) The organization of which this organization forms a part
... contact S 0..* BackboneElement Contact for the organization for a certain purpose
.... purpose S 0..1 CodeableConcept The type of contact
.... name S 0..1 HumanName A name associated with the contact
..... use S 0..1 code usual | official | temp | nickname | anonymous | old | maiden
..... text S 0..1 string Text representation of the full name
..... family S 1..1 string Family name (often called 'Surname')
..... given S 1..* string Given names (not always 'first'). Includes middle names
..... prefix S 0..* string Parts that come before the name
..... suffix S 0..* string Parts that come after the name
..... period S 0..1 Period Time period when name was/is in use
.... telecom S 0..* ContactPoint Contact details (telephone, email, etc.) for a contact
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... viaintermediary S 0..1 Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location) viaintermediary
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary
..... availabletime S 0..* (Complex) Available time
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
..... system S 1..1 code phone | fax | email | pager | url | sms | other
..... value S 1..1 string The actual contact point details
..... use S 0..1 code home | work | temp | old | mobile - purpose of this contact point
..... rank S 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period S 0..1 Period Time period when the contact point was/is in use
.... address S 0..1 Address Visiting or postal addresses for the contact
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... position S 0..1 (Complex) The absolute geographic location
URL: http://hl7.org/fhir/StructureDefinition/geolocation
..... use S 0..1 code home | work | temp | old | billing - purpose of this address
..... type S 0..1 code postal | physical | both
..... text S 0..1 string Text representation of the address
..... line S 0..* string Street name, number, direction & P.O. Box etc.
..... city S 0..1 string Name of city, town etc.
..... district S 0..1 string District name (aka county)
..... state S 0..1 string Sub-unit of country (abbreviations ok)
..... postalCode S 0..1 string Postal code for area
..... country S 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
..... period S 0..1 Period Time period when address was/is in use
... endpoint S 0..* Reference(VhDir Endpoint) Technical endpoints providing access to services operated for the organization

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C 0..* Organization A grouping of people or organizations with a common purpose
org-1: The organization SHALL at least have a name or an identifier, and possibly more than one
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
... description S 0..1 string Description of the organization
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/org-description
... digitalcertificate S 0..* (Complex) Organization's digital certificate
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/digitalcertificate
... qualification S 0..* (Complex) The organization's qualifications
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/qualification
... restriction S 0..* Reference(VhDir Restriction) Restriction
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction
... insurancePlan S 0..* Reference(VhDir Insurance Plan) Insurance plan(s) offered to the organization's employees
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/insuranceplan-reference
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣC 0..* Identifier Identifies this organization across multiple systems
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... status S 1..1 code Status
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status
Binding: VhDir Identifier Status Value Set (required)
.... use ?!SΣ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type SΣ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

.... system SΣ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 0..1 string The value that is unique
Example General: 123456
.... period SΣ 0..1 Period Time period when id is/was valid for use
.... assigner SΣ 0..1 Reference(VhDir Organization) Organization that issued id (may be just text)
... active ?!SΣ 1..1 boolean Whether the organization's record is still in active use
... type SΣ 1..* CodeableConcept Kind of organization
Binding: OrganizationType (example): Used to categorize the organization.


... name SΣC 1..1 string Name used for the organization
... alias S 0..* string A list of alternate names that the organization is known as, or was known as in the past
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... type S 0..1 CodeableConcept Type of alias
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/org-alias-type
Binding: VhDir Alias Type Value Set (example)
.... period S 0..1 Period Time period for alias
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/org-alias-period
.... value S 0..1 string Primitive value for string
Max Length: 1048576
... telecom SC 0..* ContactPoint A contact detail for the organization
org-3: The telecom of an organization can never be of use 'home'
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... viaintermediary S 0..1 Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location) viaintermediary
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary
.... availabletime S 0..* (Complex) Available time
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
.... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value SΣ 1..1 string The actual contact point details
.... use ?!SΣ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

.... rank SΣ 0..1 positiveInt Specify preferred order of use (1 = highest)
.... period SΣ 0..1 Period Time period when the contact point was/is in use
... address SC 0..* Address An address for the organization
org-2: An address of an organization can never be of use 'home'
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... geolocation S 0..1 (Complex) The absolute geographic location
URL: http://hl7.org/fhir/StructureDefinition/geolocation
.... use ?!SΣ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... type SΣ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
.... text SΣ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line SΣ 0..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city SΣ 0..1 string Name of city, town etc.
Example General: Erewhon
.... district SΣ 0..1 string District name (aka county)
Example General: Madison
.... state SΣ 0..1 string Sub-unit of country (abbreviations ok)
.... postalCode SΣ 0..1 string Postal code for area
Example General: 9132
.... country SΣ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
.... period SΣ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... partOf SΣ 0..1 Reference(VhDir Organization) The organization of which this organization forms a part
... contact S 0..* BackboneElement Contact for the organization for a certain purpose
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... purpose S 0..1 CodeableConcept The type of contact
Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.

.... name S 0..1 HumanName A name associated with the contact
..... use ?!SΣ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

..... text SΣ 0..1 string Text representation of the full name
..... family SΣ 1..1 string Family name (often called 'Surname')
..... given SΣ 1..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
..... prefix SΣ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
..... suffix SΣ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
..... period SΣ 0..1 Period Time period when name was/is in use
.... telecom S 0..* ContactPoint Contact details (telephone, email, etc.) for a contact
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... viaintermediary S 0..1 Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location) viaintermediary
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary
..... availabletime S 0..* (Complex) Available time
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
..... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

..... value SΣ 1..1 string The actual contact point details
..... use ?!SΣ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

..... rank SΣ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period SΣ 0..1 Period Time period when the contact point was/is in use
.... address S 0..1 Address Visiting or postal addresses for the contact
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... position S 0..1 (Complex) The absolute geographic location
URL: http://hl7.org/fhir/StructureDefinition/geolocation
..... use ?!SΣ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
..... type SΣ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
..... text SΣ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
..... line SΣ 0..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
..... city SΣ 0..1 string Name of city, town etc.
Example General: Erewhon
..... district SΣ 0..1 string District name (aka county)
Example General: Madison
..... state SΣ 0..1 string Sub-unit of country (abbreviations ok)
..... postalCode SΣ 0..1 string Postal code for area
Example General: 9132
..... country SΣ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
..... period SΣ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... endpoint S 0..* Reference(VhDir Endpoint) Technical endpoints providing access to services operated for the organization

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Organization.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Organization.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Organization.typeexampleOrganizationType
http://hl7.org/fhir/ValueSet/organization-type
from the FHIR Standard
Organization.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Organization.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Organization.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Organization.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Organization.contact.purposeextensibleContactEntityType
http://hl7.org/fhir/ValueSet/contactentity-type
from the FHIR Standard
Organization.contact.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Organization.contact.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Organization.contact.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Organization.contact.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Organization.contact.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C 0..* Organization A grouping of people or organizations with a common purpose
org-1: The organization SHALL at least have a name or an identifier, and possibly more than one
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
... description S 0..1 string Description of the organization
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/org-description
... digitalcertificate S 0..* (Complex) Organization's digital certificate
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/digitalcertificate
... qualification S 0..* (Complex) The organization's qualifications
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/qualification
... restriction S 0..* Reference(VhDir Restriction) Restriction
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction
... insurancePlan S 0..* Reference(VhDir Insurance Plan) Insurance plan(s) offered to the organization's employees
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/insuranceplan-reference
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣC 0..* Identifier Identifies this organization across multiple systems
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... status S 1..1 code Status
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status
Binding: VhDir Identifier Status Value Set (required)
.... use ?!SΣ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type SΣ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

.... system SΣ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 0..1 string The value that is unique
Example General: 123456
.... period SΣ 0..1 Period Time period when id is/was valid for use
.... assigner SΣ 0..1 Reference(VhDir Organization) Organization that issued id (may be just text)
... active ?!SΣ 1..1 boolean Whether the organization's record is still in active use
... type SΣ 1..* CodeableConcept Kind of organization
Binding: OrganizationType (example): Used to categorize the organization.


... name SΣC 1..1 string Name used for the organization
... alias S 0..* string A list of alternate names that the organization is known as, or was known as in the past
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... type S 0..1 CodeableConcept Type of alias
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/org-alias-type
Binding: VhDir Alias Type Value Set (example)
.... period S 0..1 Period Time period for alias
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/org-alias-period
.... value S 0..1 string Primitive value for string
Max Length: 1048576
... telecom SC 0..* ContactPoint A contact detail for the organization
org-3: The telecom of an organization can never be of use 'home'
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... viaintermediary S 0..1 Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location) viaintermediary
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary
.... availabletime S 0..* (Complex) Available time
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
.... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value SΣ 1..1 string The actual contact point details
.... use ?!SΣ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

.... rank SΣ 0..1 positiveInt Specify preferred order of use (1 = highest)
.... period SΣ 0..1 Period Time period when the contact point was/is in use
... address SC 0..* Address An address for the organization
org-2: An address of an organization can never be of use 'home'
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... geolocation S 0..1 (Complex) The absolute geographic location
URL: http://hl7.org/fhir/StructureDefinition/geolocation
.... use ?!SΣ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... type SΣ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
.... text SΣ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line SΣ 0..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city SΣ 0..1 string Name of city, town etc.
Example General: Erewhon
.... district SΣ 0..1 string District name (aka county)
Example General: Madison
.... state SΣ 0..1 string Sub-unit of country (abbreviations ok)
.... postalCode SΣ 0..1 string Postal code for area
Example General: 9132
.... country SΣ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
.... period SΣ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... partOf SΣ 0..1 Reference(VhDir Organization) The organization of which this organization forms a part
... contact S 0..* BackboneElement Contact for the organization for a certain purpose
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... purpose S 0..1 CodeableConcept The type of contact
Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.

.... name S 0..1 HumanName A name associated with the contact
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!SΣ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

..... text SΣ 0..1 string Text representation of the full name
..... family SΣ 1..1 string Family name (often called 'Surname')
..... given SΣ 1..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
..... prefix SΣ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
..... suffix SΣ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
..... period SΣ 0..1 Period Time period when name was/is in use
.... telecom S 0..* ContactPoint Contact details (telephone, email, etc.) for a contact
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... viaintermediary S 0..1 Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location) viaintermediary
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary
..... availabletime S 0..* (Complex) Available time
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
..... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

..... value SΣ 1..1 string The actual contact point details
..... use ?!SΣ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

..... rank SΣ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period SΣ 0..1 Period Time period when the contact point was/is in use
.... address S 0..1 Address Visiting or postal addresses for the contact
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... position S 0..1 (Complex) The absolute geographic location
URL: http://hl7.org/fhir/StructureDefinition/geolocation
..... use ?!SΣ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
..... type SΣ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
..... text SΣ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
..... line SΣ 0..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
..... city SΣ 0..1 string Name of city, town etc.
Example General: Erewhon
..... district SΣ 0..1 string District name (aka county)
Example General: Madison
..... state SΣ 0..1 string Sub-unit of country (abbreviations ok)
..... postalCode SΣ 0..1 string Postal code for area
Example General: 9132
..... country SΣ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
..... period SΣ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... endpoint S 0..* Reference(VhDir Endpoint) Technical endpoints providing access to services operated for the organization

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Organization.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Organization.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Organization.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Organization.typeexampleOrganizationType
http://hl7.org/fhir/ValueSet/organization-type
from the FHIR Standard
Organization.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Organization.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Organization.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Organization.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Organization.contact.purposeextensibleContactEntityType
http://hl7.org/fhir/ValueSet/contactentity-type
from the FHIR Standard
Organization.contact.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Organization.contact.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Organization.contact.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Organization.contact.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Organization.contact.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard

 

Other representations of profile: CSV, Excel, Schematron

Notes:

Supported Searches

  1. GET [base]/Organization?active=[code]

    Support: SHALL support search by the active parameter: http://hl7.org/fhir/SearchParameter/Organization-active


  1. GET [base]/Organization?address-use=[code]

    Support: MAY support search by the address-use parameter: http://hl7.org/fhir/SearchParameter/Organization-address-use


  1. GET [base]/Organization?address=[string]

    Support: SHALL support search by the address parameter

    • including the modifiers: contains, exact

  1. GET [base]/Organization?organiztion-address-city=[string]

    Support: SHOULD support search by the address-city parameter

    • including the modifiers: exact

  1. GET [base]/Organization?address-country=[string]

    Support: SHOULD support search by the address-country parameter

    • including the modifiers: exact

  1. GET [base]/Organization?address-postalcode=[string]

    Support: SHOULD support search by the address-postalcode parameter

    • including the modifiers: exact

  1. GET [base]/Organization?address-state=[string]

    Support: SHOULD support search by the address-state parameter

    • including the modifiers: exact

  1. GET [base]/Organization?endpoint=[id]

    Support: SHALL support search by the endpoint parameter

    • with a target type: Endpoint
    • including these search paramaters which may be chained: endpoint.identifier, endpoint.connection-type, endpoint.organization

  1. GET [base]/Organization?identifier=[code]

    Support: SHALL support search by the identifier parameter

    • including the modifiers: text, ofType

  1. GET [base]/Organization?identifier-assigner=[id]

    Support: MAY support search by the identifier-assigner parameter

    • with a target type: Organization
    • including the modifiers: below
    • including these search paramaters which may be chained: identifier-assigner.identifier, identifier-assigner.name

  1. GET [base]/Organization?name=[string]

    Support: SHALL support search by the name parameter

    • including the modifiers: exact, contains

  1. GET [base]/Organization?partof=[id]

    Support: SHALL support search by the partof parameter

    • with a target type: Organization
    • including the modifiers: above, below
    • including these search paramaters which may be chained: partof.identifier, partof.name, partof.address, partof.type

  1. GET [base]/Organization?qualification-code=[code]

    Support: SHOULD support search by the qualification-code parameter

    • including the modifiers: text

  1. GET [base]/Organization?qualification-issuer=[id]

    Support: MAY support search by the qualification-issuer parameter

    • with a target type: Organization
    • including the modifiers: below
    • including these search paramaters which may be chained: qualification-issuer.identifier, qualification-issuer.name

  1. GET [base]/Organization?qualification-status=[code]

    Support: SHOULD support search by the qualification-status parameter


  1. GET [base]/Organization?qualification-wherevalid-code=[code]

    Support: SHOULD support search by the qualification-wherevalid-code parameter

    • including the modifiers: text

  1. GET [base]/Organization?qualification-wherevalid-location=[id]

    Support: SHOULD support search by the qualification-wherevalid-location parameter

    • with a target type: Location
    • including the modifiers: above, below
    • including these search paramaters which may be chained: qualification-wherevalid-location.identifier, qualification-wherevalid-location.organization

  1. GET [base]/Organization?type=[code]

    Support: SHALL support search by the type parameter

    • including the modifiers: text

  1. GET [base]/Organization?via-intermediary=[id]

    Support: MAY support search by the via-intermediary parameter

    • with a target type: PractitionerRole, Organization, OrganizationAffiliation, Location