HL7 FHIR® Validated Healthcare Directory Implementation Guide STU 1

Validated Healthcare Directory, published by HL7 International - Patient Admistration Working 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

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, and Snapshots.

The official URL for this profile is: http://hl7.org/fhir/uv/vhdir/StructureDefinition/vhdir-organization

Published on Thu Aug 31 20:26:52 UTC 2017 as a active by HL7 International.

This profile builds on Organization


NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization 0..*
... extension 0..*ExtensionSlice: 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
.... extension 0..*ExtensionSlice: 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..1code
.... type S0..1CodeableConcept
.... system S0..1uri
.... value S0..1string
.... period S0..1Period
.... assigner S0..1Reference(VhDir Organization)
... 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
.... extension 0..*ExtensionSlice: 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..1string
... telecom S0..*ContactPoint
.... extension 0..*ExtensionSlice: 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..1code
.... value S1..1string
.... use S0..1code
.... rank S0..1positiveInt
.... period S0..1Period
... address S0..*AddressAn address for the organization
.... extension 0..*ExtensionSlice: Unordered, Open by value:url
.... geolocation S0..1(Complex)The absolute geographic location
URL: http://hl7.org/fhir/StructureDefinition/geolocation
.... use S0..1code
.... type S0..1code
.... text S0..1string
.... line S0..*string
.... city S0..1string
.... district S0..1string
.... state S0..1string
.... postalCode S0..1string
.... country S0..1string
.... period S0..1Period
... 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..1CodeableConcept
.... name S0..1HumanName
..... use S0..1code
..... text S0..1string
..... family S1..1string
..... given S1..*string
..... prefix S0..*string
..... suffix S0..*string
..... period S0..1Period
.... telecom S0..*ContactPoint
..... extension 0..*ExtensionSlice: 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..1code
..... value S1..1string
..... use S0..1code
..... rank S0..1positiveInt
..... period S0..1Period
.... address S0..1Address
..... extension 0..*ExtensionSlice: Unordered, Open by value:url
..... geolocation S0..1(Complex)The absolute geographic location
URL: http://hl7.org/fhir/StructureDefinition/geolocation
..... use S0..1code
..... type S0..1code
..... text S0..1string
..... line S0..*string
..... city S0..1string
..... district S0..1string
..... state S0..1string
..... postalCode S0..1string
..... country S0..1string
..... period S0..1Period
... 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..*A grouping of people or organizations with a common purpose
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
... org-description SI0..1stringDescription of the organization
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/org-description
... digitalcertificate SI0..*(Complex)Organization's digital certificate
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/digitalcertificate
... qualification SI0..*(Complex)The organization's qualifications
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/qualification
... usage-restriction SI0..*Reference(VhDir Restriction)Restriction
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction
... insuranceplan-reference SI0..*Reference(VhDir Insurance Plan)Insurance plan(s) offered to the organization's employees
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/insuranceplan-reference
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier SΣI0..*IdentifierIdentifies this organization across multiple systems
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... identifier-status SI1..1codeStatus
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status
Binding: VhDir Identifier Status Value Set (required)
.... use ?!SΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type SΣI0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system SΣI0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣI0..1stringThe value that is unique
Example General: 123456
.... period SΣI0..1PeriodTime period when id is/was valid for use
.... assigner SΣI0..1Reference(VhDir Organization)Organization that issued id (may be just text)
... active ?!SΣI1..1booleanWhether the organization's record is still in active use
... type SΣI1..*CodeableConceptKind of organization
Binding: OrganizationType (example)
... name SΣI1..1stringName used for the organization
... alias SI0..*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)
.... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... org-alias-type SI0..1CodeableConceptType of alias
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/org-alias-type
Binding: VhDir Alias Type Value Set (example)
.... org-alias-period SI0..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
.... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... contactpoint-viaintermediary SI0..1Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location)viaintermediary
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary
.... contactpoint-availabletime SI0..*(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)
.... value SΣI1..1stringThe actual contact point details
.... use ?!SΣI0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... rank SΣI0..1positiveIntSpecify preferred order of use (1 = highest)
.... period SΣI0..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
.... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... geolocation SI0..1(Complex)The absolute geographic location
URL: http://hl7.org/fhir/StructureDefinition/geolocation
.... use ?!SΣI0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required)
Example General: home
.... type SΣI0..1codepostal | physical | both
Binding: AddressType (required)
Example General: both
.... text SΣI0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line SΣI0..*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ΣI0..1stringName of city, town etc.
Example General: Erewhon
.... district SΣI0..1stringDistrict name (aka county)
Example General: Madison
.... state SΣI0..1stringSub-unit of country (abbreviations ok)
.... postalCode SΣI0..1stringPostal code for area
Example General: 9132
.... country SΣI0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
.... period SΣI0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23T00:00:00+00:00","end":"2010-07-01T00:00:00+00:00"}
... partOf SΣI0..1Reference(VhDir Organization)The organization of which this organization forms a part
... contact SI0..*BackboneElementContact for the organization for a certain purpose
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... purpose SI0..1CodeableConceptThe type of contact
Binding: ContactEntityType (extensible)
.... name SI0..1HumanNameA name associated with the contact
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!SΣI0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required)
..... text SΣI0..1stringText representation of the full name
..... family SΣI1..1stringFamily name (often called 'Surname')
..... given SΣI1..*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ΣI0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
..... suffix SΣI0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
..... period SΣI0..1PeriodTime period when name was/is in use
.... telecom SI0..*ContactPointContact details (telephone, email, etc.) for a contact
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... contactpoint-viaintermediary SI0..1Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location)viaintermediary
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary
..... contactpoint-availabletime SI0..*(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)
..... value SΣI1..1stringThe actual contact point details
..... use ?!SΣI0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
..... rank SΣI0..1positiveIntSpecify preferred order of use (1 = highest)
..... period SΣI0..1PeriodTime period when the contact point was/is in use
.... address SI0..1AddressVisiting or postal addresses for the contact
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... geolocation SI0..1(Complex)The absolute geographic location
URL: http://hl7.org/fhir/StructureDefinition/geolocation
..... use ?!SΣI0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required)
Example General: home
..... type SΣI0..1codepostal | physical | both
Binding: AddressType (required)
Example General: both
..... text SΣI0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
..... line SΣI0..*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ΣI0..1stringName of city, town etc.
Example General: Erewhon
..... district SΣI0..1stringDistrict name (aka county)
Example General: Madison
..... state SΣI0..1stringSub-unit of country (abbreviations ok)
..... postalCode SΣI0..1stringPostal code for area
Example General: 9132
..... country SΣI0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
..... period SΣI0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23T00:00:00+00:00","end":"2010-07-01T00:00:00+00:00"}
... endpoint SI0..*Reference(VhDir Endpoint)Technical endpoints providing access to services operated for the organization

doco Documentation for this format

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization 0..*
... extension 0..*ExtensionSlice: 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
.... extension 0..*ExtensionSlice: 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..1code
.... type S0..1CodeableConcept
.... system S0..1uri
.... value S0..1string
.... period S0..1Period
.... assigner S0..1Reference(VhDir Organization)
... 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
.... extension 0..*ExtensionSlice: 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..1string
... telecom S0..*ContactPoint
.... extension 0..*ExtensionSlice: 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..1code
.... value S1..1string
.... use S0..1code
.... rank S0..1positiveInt
.... period S0..1Period
... address S0..*AddressAn address for the organization
.... extension 0..*ExtensionSlice: Unordered, Open by value:url
.... geolocation S0..1(Complex)The absolute geographic location
URL: http://hl7.org/fhir/StructureDefinition/geolocation
.... use S0..1code
.... type S0..1code
.... text S0..1string
.... line S0..*string
.... city S0..1string
.... district S0..1string
.... state S0..1string
.... postalCode S0..1string
.... country S0..1string
.... period S0..1Period
... 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..1CodeableConcept
.... name S0..1HumanName
..... use S0..1code
..... text S0..1string
..... family S1..1string
..... given S1..*string
..... prefix S0..*string
..... suffix S0..*string
..... period S0..1Period
.... telecom S0..*ContactPoint
..... extension 0..*ExtensionSlice: 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..1code
..... value S1..1string
..... use S0..1code
..... rank S0..1positiveInt
..... period S0..1Period
.... address S0..1Address
..... extension 0..*ExtensionSlice: Unordered, Open by value:url
..... geolocation S0..1(Complex)The absolute geographic location
URL: http://hl7.org/fhir/StructureDefinition/geolocation
..... use S0..1code
..... type S0..1code
..... text S0..1string
..... line S0..*string
..... city S0..1string
..... district S0..1string
..... state S0..1string
..... postalCode S0..1string
..... country S0..1string
..... period S0..1Period
... 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..*A grouping of people or organizations with a common purpose
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
... org-description SI0..1stringDescription of the organization
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/org-description
... digitalcertificate SI0..*(Complex)Organization's digital certificate
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/digitalcertificate
... qualification SI0..*(Complex)The organization's qualifications
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/qualification
... usage-restriction SI0..*Reference(VhDir Restriction)Restriction
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction
... insuranceplan-reference SI0..*Reference(VhDir Insurance Plan)Insurance plan(s) offered to the organization's employees
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/insuranceplan-reference
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier SΣI0..*IdentifierIdentifies this organization across multiple systems
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... identifier-status SI1..1codeStatus
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status
Binding: VhDir Identifier Status Value Set (required)
.... use ?!SΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type SΣI0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system SΣI0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣI0..1stringThe value that is unique
Example General: 123456
.... period SΣI0..1PeriodTime period when id is/was valid for use
.... assigner SΣI0..1Reference(VhDir Organization)Organization that issued id (may be just text)
... active ?!SΣI1..1booleanWhether the organization's record is still in active use
... type SΣI1..*CodeableConceptKind of organization
Binding: OrganizationType (example)
... name SΣI1..1stringName used for the organization
... alias SI0..*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)
.... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... org-alias-type SI0..1CodeableConceptType of alias
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/org-alias-type
Binding: VhDir Alias Type Value Set (example)
.... org-alias-period SI0..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
.... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... contactpoint-viaintermediary SI0..1Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location)viaintermediary
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary
.... contactpoint-availabletime SI0..*(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)
.... value SΣI1..1stringThe actual contact point details
.... use ?!SΣI0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... rank SΣI0..1positiveIntSpecify preferred order of use (1 = highest)
.... period SΣI0..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
.... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... geolocation SI0..1(Complex)The absolute geographic location
URL: http://hl7.org/fhir/StructureDefinition/geolocation
.... use ?!SΣI0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required)
Example General: home
.... type SΣI0..1codepostal | physical | both
Binding: AddressType (required)
Example General: both
.... text SΣI0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line SΣI0..*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ΣI0..1stringName of city, town etc.
Example General: Erewhon
.... district SΣI0..1stringDistrict name (aka county)
Example General: Madison
.... state SΣI0..1stringSub-unit of country (abbreviations ok)
.... postalCode SΣI0..1stringPostal code for area
Example General: 9132
.... country SΣI0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
.... period SΣI0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23T00:00:00+00:00","end":"2010-07-01T00:00:00+00:00"}
... partOf SΣI0..1Reference(VhDir Organization)The organization of which this organization forms a part
... contact SI0..*BackboneElementContact for the organization for a certain purpose
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... purpose SI0..1CodeableConceptThe type of contact
Binding: ContactEntityType (extensible)
.... name SI0..1HumanNameA name associated with the contact
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!SΣI0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required)
..... text SΣI0..1stringText representation of the full name
..... family SΣI1..1stringFamily name (often called 'Surname')
..... given SΣI1..*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ΣI0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
..... suffix SΣI0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
..... period SΣI0..1PeriodTime period when name was/is in use
.... telecom SI0..*ContactPointContact details (telephone, email, etc.) for a contact
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... contactpoint-viaintermediary SI0..1Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location)viaintermediary
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary
..... contactpoint-availabletime SI0..*(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)
..... value SΣI1..1stringThe actual contact point details
..... use ?!SΣI0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
..... rank SΣI0..1positiveIntSpecify preferred order of use (1 = highest)
..... period SΣI0..1PeriodTime period when the contact point was/is in use
.... address SI0..1AddressVisiting or postal addresses for the contact
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... geolocation SI0..1(Complex)The absolute geographic location
URL: http://hl7.org/fhir/StructureDefinition/geolocation
..... use ?!SΣI0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required)
Example General: home
..... type SΣI0..1codepostal | physical | both
Binding: AddressType (required)
Example General: both
..... text SΣI0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
..... line SΣI0..*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ΣI0..1stringName of city, town etc.
Example General: Erewhon
..... district SΣI0..1stringDistrict name (aka county)
Example General: Madison
..... state SΣI0..1stringSub-unit of country (abbreviations ok)
..... postalCode SΣI0..1stringPostal code for area
Example General: 9132
..... country SΣI0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
..... period SΣI0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23T00:00:00+00:00","end":"2010-07-01T00:00:00+00:00"}
... endpoint SI0..*Reference(VhDir Endpoint)Technical endpoints providing access to services operated for the organization

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON), Schema: XML 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

Quick Start

Below is an overview of the required set of RESTful FHIR interactions - for example, search and read operations - for this profile. See the Conformance requirements for a complete list of supported RESTful interactions for this IG.

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