Validated Healthcare Directory
0.2.0 - CI Build

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

Resource Profile: VhDir Organization

Defining URL:http://hl7.org/fhir/uv/vhdir/StructureDefinition/vhdir-organization
Version:0.2.0
Name:VhdirOrganization
Title:VhDir Organization
Status:Active as of 2017-09-01 06:26:52+1000
Definition:

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

Publisher:HL7 International - Patient Administration Work Group
Copyright:

HL7 International

Source Resource:XML / JSON / Turtle

The official URL for this profile is:

http://hl7.org/fhir/uv/vhdir/StructureDefinition/vhdir-organization

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

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..*OrganizationA grouping of people or organizations with a common purpose
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... org-description S0..1stringDescription of the organization
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/org-description
... digitalcertificate S0..*(Complex)Organization's digital certificate
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/digitalcertificate
... qualification S0..*(Complex)The organization's qualifications
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/qualification
... usage-restriction S0..*Reference(VhDir Restriction)Restriction
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction
... insuranceplan-reference S0..*Reference(VhDir Insurance Plan)Insurance plan(s) offered to the organization's employees
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/insuranceplan-reference
... identifier S0..*IdentifierIdentifies this organization across multiple systems
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... identifier-status S1..1codeStatus
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status
Binding: VhDir Identifier Status Value Set (required)
.... use S0..1codeusual | official | temp | secondary | old (If known)
.... type S0..1CodeableConceptDescription of identifier
.... system S0..1uriThe namespace for the identifier value
.... value S0..1stringThe value that is unique
.... period S0..1PeriodTime period when id is/was valid for use
.... assigner S0..1Reference(VhDir Organization)Organization that issued id (may be just text)
... active S1..1booleanWhether the organization's record is still in active use
... type S1..*CodeableConceptKind of organization
... name S1..1stringName used for the organization
... alias S0..*stringA list of alternate names that the organization is known as, or was known as in the past
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... org-alias-type S0..1CodeableConceptType of alias
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/org-alias-type
Binding: VhDir Alias Type Value Set (example)
.... org-alias-period S0..1PeriodTime period for alias
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/org-alias-period
.... value S0..1stringPrimitive value for string
... telecom S0..*ContactPointA contact detail for the organization
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... contactpoint-viaintermediary S0..1Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location)viaintermediary
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary
.... contactpoint-availabletime S0..*(Complex)Available time
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
.... system S1..1codephone | fax | email | pager | url | sms | other
.... value S1..1stringThe actual contact point details
.... use S0..1codehome | work | temp | old | mobile - purpose of this contact point
.... rank S0..1positiveIntSpecify preferred order of use (1 = highest)
.... period S0..1PeriodTime period when the contact point was/is in use
... address S0..*AddressAn address for the organization
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... geolocation S0..1(Complex)The absolute geographic location
URL: http://hl7.org/fhir/StructureDefinition/geolocation
.... use S0..1codehome | work | temp | old | billing - purpose of this address
.... type S0..1codepostal | physical | both
.... text S0..1stringText representation of the address
.... line S0..*stringStreet name, number, direction & P.O. Box etc.
.... city S0..1stringName of city, town etc.
.... district S0..1stringDistrict name (aka county)
.... state S0..1stringSub-unit of country (abbreviations ok)
.... postalCode S0..1stringPostal code for area
.... country S0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
.... period S0..1PeriodTime period when address was/is in use
... partOf S0..1Reference(VhDir Organization)The organization of which this organization forms a part
... contact S0..*BackboneElementContact for the organization for a certain purpose
.... purpose S0..1CodeableConceptThe type of contact
.... name S0..1HumanNameA name associated with the contact
..... use S0..1codeusual | official | temp | nickname | anonymous | old | maiden
..... text S0..1stringText representation of the full name
..... family S1..1stringFamily name (often called 'Surname')
..... given S1..*stringGiven names (not always 'first'). Includes middle names
..... prefix S0..*stringParts that come before the name
..... suffix S0..*stringParts that come after the name
..... period S0..1PeriodTime period when name was/is in use
.... telecom S0..*ContactPointContact details (telephone, email, etc.) for a contact
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... contactpoint-viaintermediary S0..1Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location)viaintermediary
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary
..... contactpoint-availabletime S0..*(Complex)Available time
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
..... system S1..1codephone | fax | email | pager | url | sms | other
..... value S1..1stringThe actual contact point details
..... use S0..1codehome | work | temp | old | mobile - purpose of this contact point
..... rank S0..1positiveIntSpecify preferred order of use (1 = highest)
..... period S0..1PeriodTime period when the contact point was/is in use
.... address S0..1AddressVisiting or postal addresses for the contact
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... geolocation S0..1(Complex)The absolute geographic location
URL: http://hl7.org/fhir/StructureDefinition/geolocation
..... use S0..1codehome | work | temp | old | billing - purpose of this address
..... type S0..1codepostal | physical | both
..... text S0..1stringText representation of the address
..... line S0..*stringStreet name, number, direction & P.O. Box etc.
..... city S0..1stringName of city, town etc.
..... district S0..1stringDistrict name (aka county)
..... state S0..1stringSub-unit of country (abbreviations ok)
..... postalCode S0..1stringPostal code for area
..... country S0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
..... period S0..1PeriodTime period when address was/is in use
... endpoint S0..*Reference(VhDir Endpoint)Technical endpoints providing access to services operated for the organization

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization I0..*OrganizationA grouping of people or organizations with a common purpose
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... org-description S0..1stringDescription of the organization
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/org-description
... digitalcertificate S0..*(Complex)Organization's digital certificate
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/digitalcertificate
... qualification S0..*(Complex)The organization's qualifications
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/qualification
... usage-restriction S0..*Reference(VhDir Restriction)Restriction
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction
... insuranceplan-reference S0..*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..*ExtensionExtensions that cannot be ignored
... identifier SΣI0..*IdentifierIdentifies this organization across multiple systems
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... identifier-status S1..1codeStatus
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status
Binding: VhDir Identifier Status Value Set (required)
.... use ?!SΣ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type SΣ0..1CodeableConceptDescription 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..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ0..1stringThe value that is unique
Example General: 123456
.... period SΣ0..1PeriodTime period when id is/was valid for use
.... assigner SΣ0..1Reference(VhDir Organization)Organization that issued id (may be just text)
... active ?!SΣ1..1booleanWhether the organization's record is still in active use
... type SΣ1..*CodeableConceptKind of organization
Binding: OrganizationType (example): Used to categorize the organization.


... name SΣI1..1stringName used for the organization
... alias S0..*stringA list of alternate names that the organization is known as, or was known as in the past
.... id 0..1stringxml:id (or equivalent in JSON)
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... org-alias-type S0..1CodeableConceptType of alias
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/org-alias-type
Binding: VhDir Alias Type Value Set (example)
.... org-alias-period S0..1PeriodTime period for alias
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/org-alias-period
.... value S0..1stringPrimitive value for string
Max Length: 1048576
... telecom SI0..*ContactPointA contact detail for the organization
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... contactpoint-viaintermediary S0..1Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location)viaintermediary
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary
.... contactpoint-availabletime S0..*(Complex)Available time
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
.... system SΣI1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

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

.... rank SΣ0..1positiveIntSpecify preferred order of use (1 = highest)
.... period SΣ0..1PeriodTime period when the contact point was/is in use
... address SI0..*AddressAn address for the organization
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... geolocation S0..1(Complex)The absolute geographic location
URL: http://hl7.org/fhir/StructureDefinition/geolocation
.... use ?!SΣ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


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


Example General: both
.... text SΣ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line SΣ0..*stringStreet 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..1stringName of city, town etc.
Example General: Erewhon
.... district SΣ0..1stringDistrict name (aka county)
Example General: Madison
.... state SΣ0..1stringSub-unit of country (abbreviations ok)
.... postalCode SΣ0..1stringPostal code for area
Example General: 9132
.... country SΣ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
.... period SΣ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... partOf SΣ0..1Reference(VhDir Organization)The organization of which this organization forms a part
... contact S0..*BackboneElementContact for the organization for a certain purpose
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... purpose S0..1CodeableConceptThe type of contact
Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.

.... name S0..1HumanNameA name associated with the contact
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!SΣ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

..... text SΣ0..1stringText representation of the full name
..... family SΣ1..1stringFamily name (often called 'Surname')
..... given SΣ1..*stringGiven 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..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
..... suffix SΣ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
..... period SΣ0..1PeriodTime period when name was/is in use
.... telecom S0..*ContactPointContact details (telephone, email, etc.) for a contact
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... contactpoint-viaintermediary S0..1Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location)viaintermediary
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary
..... contactpoint-availabletime S0..*(Complex)Available time
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
..... system SΣI1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

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

..... rank SΣ0..1positiveIntSpecify preferred order of use (1 = highest)
..... period SΣ0..1PeriodTime period when the contact point was/is in use
.... address S0..1AddressVisiting or postal addresses for the contact
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... geolocation S0..1(Complex)The absolute geographic location
URL: http://hl7.org/fhir/StructureDefinition/geolocation
..... use ?!SΣ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


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


Example General: both
..... text SΣ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
..... line SΣ0..*stringStreet 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..1stringName of city, town etc.
Example General: Erewhon
..... district SΣ0..1stringDistrict name (aka county)
Example General: Madison
..... state SΣ0..1stringSub-unit of country (abbreviations ok)
..... postalCode SΣ0..1stringPostal code for area
Example General: 9132
..... country SΣ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
..... period SΣ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... endpoint S0..*Reference(VhDir Endpoint)Technical endpoints providing access to services operated for the organization

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization I0..*OrganizationA grouping of people or organizations with a common purpose
... org-description 0..1stringDescription of the organization
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/org-description
... digitalcertificate 0..*(Complex)Organization's digital certificate
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/digitalcertificate
... qualification 0..*(Complex)The organization's qualifications
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/qualification
... usage-restriction 0..*Reference(VhDir Restriction)Restriction
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction
... insuranceplan-reference 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 ΣI0..*IdentifierIdentifies this organization across multiple systems
.... identifier-status 1..1codeStatus
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status
Binding: VhDir Identifier Status Value Set (required)
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ0..1CodeableConceptDescription 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 Σ0..1uriThe namespace for the identifier value
.... value Σ0..1stringThe value that is unique
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(VhDir Organization)Organization that issued id (may be just text)
... active ?!Σ1..1booleanWhether the organization's record is still in active use
... type Σ1..*CodeableConceptKind of organization
Binding: OrganizationType (example): Used to categorize the organization.


... name ΣI1..1stringName used for the organization
... alias 0..*stringA list of alternate names that the organization is known as, or was known as in the past
.... org-alias-type 0..1CodeableConceptType of alias
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/org-alias-type
Binding: VhDir Alias Type Value Set (example)
.... org-alias-period 0..1PeriodTime period for alias
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/org-alias-period
.... value 0..1stringPrimitive value for string
Max Length: 1048576
... telecom I0..*ContactPointA contact detail for the organization
.... contactpoint-viaintermediary 0..1Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location)viaintermediary
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary
.... contactpoint-availabletime 0..*(Complex)Available time
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
.... system ΣI1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

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

.... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
.... period Σ0..1PeriodTime period when the contact point was/is in use
... address I0..*AddressAn address for the organization
.... geolocation 0..1(Complex)The absolute geographic location
URL: http://hl7.org/fhir/StructureDefinition/geolocation
.... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.

.... type Σ0..1codepostal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).

.... text Σ0..1stringText representation of the address
.... line Σ0..*stringStreet name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
.... city Σ0..1stringName of city, town etc.
.... district Σ0..1stringDistrict name (aka county)
.... state Σ0..1stringSub-unit of country (abbreviations ok)
.... postalCode Σ0..1stringPostal code for area
.... country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
.... period Σ0..1PeriodTime period when address was/is in use
... partOf Σ0..1Reference(VhDir Organization)The organization of which this organization forms a part
... contact 0..*BackboneElementContact for the organization for a certain purpose
.... purpose 0..1CodeableConceptThe type of contact
Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.

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

..... text Σ0..1stringText representation of the full name
..... family Σ1..1stringFamily name (often called 'Surname')
..... given Σ1..*stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
..... prefix Σ0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
..... suffix Σ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
..... period Σ0..1PeriodTime period when name was/is in use
.... telecom 0..*ContactPointContact details (telephone, email, etc.) for a contact
..... contactpoint-viaintermediary 0..1Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location)viaintermediary
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary
..... contactpoint-availabletime 0..*(Complex)Available time
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
..... system ΣI1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

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

..... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
..... period Σ0..1PeriodTime period when the contact point was/is in use
.... address 0..1AddressVisiting or postal addresses for the contact
..... geolocation 0..1(Complex)The absolute geographic location
URL: http://hl7.org/fhir/StructureDefinition/geolocation
..... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.

..... type Σ0..1codepostal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).

..... text Σ0..1stringText representation of the address
..... line Σ0..*stringStreet name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
..... city Σ0..1stringName of city, town etc.
..... district Σ0..1stringDistrict name (aka county)
..... state Σ0..1stringSub-unit of country (abbreviations ok)
..... postalCode Σ0..1stringPostal code for area
..... country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
..... period Σ0..1PeriodTime period when address was/is in use
... endpoint 0..*Reference(VhDir Endpoint)Technical endpoints providing access to services operated for the organization

doco Documentation for this format

Differential View

This structure is derived from Organization

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization 0..*OrganizationA grouping of people or organizations with a common purpose
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... org-description S0..1stringDescription of the organization
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/org-description
... digitalcertificate S0..*(Complex)Organization's digital certificate
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/digitalcertificate
... qualification S0..*(Complex)The organization's qualifications
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/qualification
... usage-restriction S0..*Reference(VhDir Restriction)Restriction
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction
... insuranceplan-reference S0..*Reference(VhDir Insurance Plan)Insurance plan(s) offered to the organization's employees
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/insuranceplan-reference
... identifier S0..*IdentifierIdentifies this organization across multiple systems
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... identifier-status S1..1codeStatus
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status
Binding: VhDir Identifier Status Value Set (required)
.... use S0..1codeusual | official | temp | secondary | old (If known)
.... type S0..1CodeableConceptDescription of identifier
.... system S0..1uriThe namespace for the identifier value
.... value S0..1stringThe value that is unique
.... period S0..1PeriodTime period when id is/was valid for use
.... assigner S0..1Reference(VhDir Organization)Organization that issued id (may be just text)
... active S1..1booleanWhether the organization's record is still in active use
... type S1..*CodeableConceptKind of organization
... name S1..1stringName used for the organization
... alias S0..*stringA list of alternate names that the organization is known as, or was known as in the past
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... org-alias-type S0..1CodeableConceptType of alias
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/org-alias-type
Binding: VhDir Alias Type Value Set (example)
.... org-alias-period S0..1PeriodTime period for alias
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/org-alias-period
.... value S0..1stringPrimitive value for string
... telecom S0..*ContactPointA contact detail for the organization
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... contactpoint-viaintermediary S0..1Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location)viaintermediary
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary
.... contactpoint-availabletime S0..*(Complex)Available time
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
.... system S1..1codephone | fax | email | pager | url | sms | other
.... value S1..1stringThe actual contact point details
.... use S0..1codehome | work | temp | old | mobile - purpose of this contact point
.... rank S0..1positiveIntSpecify preferred order of use (1 = highest)
.... period S0..1PeriodTime period when the contact point was/is in use
... address S0..*AddressAn address for the organization
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... geolocation S0..1(Complex)The absolute geographic location
URL: http://hl7.org/fhir/StructureDefinition/geolocation
.... use S0..1codehome | work | temp | old | billing - purpose of this address
.... type S0..1codepostal | physical | both
.... text S0..1stringText representation of the address
.... line S0..*stringStreet name, number, direction & P.O. Box etc.
.... city S0..1stringName of city, town etc.
.... district S0..1stringDistrict name (aka county)
.... state S0..1stringSub-unit of country (abbreviations ok)
.... postalCode S0..1stringPostal code for area
.... country S0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
.... period S0..1PeriodTime period when address was/is in use
... partOf S0..1Reference(VhDir Organization)The organization of which this organization forms a part
... contact S0..*BackboneElementContact for the organization for a certain purpose
.... purpose S0..1CodeableConceptThe type of contact
.... name S0..1HumanNameA name associated with the contact
..... use S0..1codeusual | official | temp | nickname | anonymous | old | maiden
..... text S0..1stringText representation of the full name
..... family S1..1stringFamily name (often called 'Surname')
..... given S1..*stringGiven names (not always 'first'). Includes middle names
..... prefix S0..*stringParts that come before the name
..... suffix S0..*stringParts that come after the name
..... period S0..1PeriodTime period when name was/is in use
.... telecom S0..*ContactPointContact details (telephone, email, etc.) for a contact
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... contactpoint-viaintermediary S0..1Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location)viaintermediary
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary
..... contactpoint-availabletime S0..*(Complex)Available time
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
..... system S1..1codephone | fax | email | pager | url | sms | other
..... value S1..1stringThe actual contact point details
..... use S0..1codehome | work | temp | old | mobile - purpose of this contact point
..... rank S0..1positiveIntSpecify preferred order of use (1 = highest)
..... period S0..1PeriodTime period when the contact point was/is in use
.... address S0..1AddressVisiting or postal addresses for the contact
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... geolocation S0..1(Complex)The absolute geographic location
URL: http://hl7.org/fhir/StructureDefinition/geolocation
..... use S0..1codehome | work | temp | old | billing - purpose of this address
..... type S0..1codepostal | physical | both
..... text S0..1stringText representation of the address
..... line S0..*stringStreet name, number, direction & P.O. Box etc.
..... city S0..1stringName of city, town etc.
..... district S0..1stringDistrict name (aka county)
..... state S0..1stringSub-unit of country (abbreviations ok)
..... postalCode S0..1stringPostal code for area
..... country S0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
..... period S0..1PeriodTime period when address was/is in use
... endpoint S0..*Reference(VhDir Endpoint)Technical endpoints providing access to services operated for the organization

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization I0..*OrganizationA grouping of people or organizations with a common purpose
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... org-description S0..1stringDescription of the organization
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/org-description
... digitalcertificate S0..*(Complex)Organization's digital certificate
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/digitalcertificate
... qualification S0..*(Complex)The organization's qualifications
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/qualification
... usage-restriction S0..*Reference(VhDir Restriction)Restriction
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction
... insuranceplan-reference S0..*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..*ExtensionExtensions that cannot be ignored
... identifier SΣI0..*IdentifierIdentifies this organization across multiple systems
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... identifier-status S1..1codeStatus
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status
Binding: VhDir Identifier Status Value Set (required)
.... use ?!SΣ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type SΣ0..1CodeableConceptDescription 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..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ0..1stringThe value that is unique
Example General: 123456
.... period SΣ0..1PeriodTime period when id is/was valid for use
.... assigner SΣ0..1Reference(VhDir Organization)Organization that issued id (may be just text)
... active ?!SΣ1..1booleanWhether the organization's record is still in active use
... type SΣ1..*CodeableConceptKind of organization
Binding: OrganizationType (example): Used to categorize the organization.


... name SΣI1..1stringName used for the organization
... alias S0..*stringA list of alternate names that the organization is known as, or was known as in the past
.... id 0..1stringxml:id (or equivalent in JSON)
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... org-alias-type S0..1CodeableConceptType of alias
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/org-alias-type
Binding: VhDir Alias Type Value Set (example)
.... org-alias-period S0..1PeriodTime period for alias
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/org-alias-period
.... value S0..1stringPrimitive value for string
Max Length: 1048576
... telecom SI0..*ContactPointA contact detail for the organization
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... contactpoint-viaintermediary S0..1Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location)viaintermediary
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary
.... contactpoint-availabletime S0..*(Complex)Available time
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
.... system SΣI1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

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

.... rank SΣ0..1positiveIntSpecify preferred order of use (1 = highest)
.... period SΣ0..1PeriodTime period when the contact point was/is in use
... address SI0..*AddressAn address for the organization
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... geolocation S0..1(Complex)The absolute geographic location
URL: http://hl7.org/fhir/StructureDefinition/geolocation
.... use ?!SΣ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


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


Example General: both
.... text SΣ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line SΣ0..*stringStreet 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..1stringName of city, town etc.
Example General: Erewhon
.... district SΣ0..1stringDistrict name (aka county)
Example General: Madison
.... state SΣ0..1stringSub-unit of country (abbreviations ok)
.... postalCode SΣ0..1stringPostal code for area
Example General: 9132
.... country SΣ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
.... period SΣ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... partOf SΣ0..1Reference(VhDir Organization)The organization of which this organization forms a part
... contact S0..*BackboneElementContact for the organization for a certain purpose
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... purpose S0..1CodeableConceptThe type of contact
Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.

.... name S0..1HumanNameA name associated with the contact
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!SΣ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

..... text SΣ0..1stringText representation of the full name
..... family SΣ1..1stringFamily name (often called 'Surname')
..... given SΣ1..*stringGiven 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..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
..... suffix SΣ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
..... period SΣ0..1PeriodTime period when name was/is in use
.... telecom S0..*ContactPointContact details (telephone, email, etc.) for a contact
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... contactpoint-viaintermediary S0..1Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location)viaintermediary
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary
..... contactpoint-availabletime S0..*(Complex)Available time
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
..... system SΣI1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

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

..... rank SΣ0..1positiveIntSpecify preferred order of use (1 = highest)
..... period SΣ0..1PeriodTime period when the contact point was/is in use
.... address S0..1AddressVisiting or postal addresses for the contact
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... geolocation S0..1(Complex)The absolute geographic location
URL: http://hl7.org/fhir/StructureDefinition/geolocation
..... use ?!SΣ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


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


Example General: both
..... text SΣ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
..... line SΣ0..*stringStreet 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..1stringName of city, town etc.
Example General: Erewhon
..... district SΣ0..1stringDistrict name (aka county)
Example General: Madison
..... state SΣ0..1stringSub-unit of country (abbreviations ok)
..... postalCode SΣ0..1stringPostal code for area
Example General: 9132
..... country SΣ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
..... period SΣ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... endpoint S0..*Reference(VhDir Endpoint)Technical endpoints providing access to services operated for the organization

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
Organization.languagepreferredCommonLanguages
Max Binding: AllLanguages
Organization.identifier.userequiredIdentifierUse
Organization.identifier.typeextensibleIdentifier Type Codes
Organization.typeexampleOrganizationType
Organization.telecom.systemrequiredContactPointSystem
Organization.telecom.userequiredContactPointUse
Organization.address.userequiredAddressUse
Organization.address.typerequiredAddressType
Organization.contact.purposeextensibleContactEntityType
Organization.contact.name.userequiredNameUse
Organization.contact.telecom.systemrequiredContactPointSystem
Organization.contact.telecom.userequiredContactPointUse
Organization.contact.address.userequiredAddressUse
Organization.contact.address.typerequiredAddressType

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