VhDir Implementation Guide CI Build: STU2 Ballot

This page is part of the Validated Healthcare Directory FHIR IG (v0.2.0: STU 1 Ballot 2) based on FHIR v3.5.0. . For a full list of available versions, 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
  • Adds new value sets/updates value set bindings:

TBD

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

Profile specific implementation guidance:

  • TBD

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 Fri Sep 01 06:26:52 AEST 2017 as a active by HL7 International.

This profile builds on Organization

Complete Summary of the Mandatory Requirements

  1. A boolean value in organization.active
  2. A name in organization.name
  3. A type in organization.type
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization 0..*
... extension 0..*ExtensionSlice: Unordered, Open by value:url
... org-description 0..1stringDescription
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/org-description
... digitalcertificate 0..*(Complex)digitalcertificate
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/digitalcertificate
... qualification 0..*(Complex)Qualification
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 InsurancePlan)insurancePlan
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/insuranceplan-reference
... identifier 0..*Identifier
.... extension 0..*ExtensionSlice: Unordered, Open by value:url
.... identifier-status 1..1codeStatus
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status
Binding: VhDir Identifier Status Value Set (example)
.... assigner 0..1Reference(VhDir Organization)
... active 1..1boolean
... type 1..*CodeableConcept
... name 1..1string
... alias 0..*string
.... extension 0..*ExtensionSlice: Unordered, Open by value:url
.... org-alias-type 0..1CodingType
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/org-alias-type
Binding: VhDir Alias Type Value Set (example)
.... org-alias-period 0..1PeriodPeriod
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/org-alias-period
... telecom 0..*ContactPoint
.... extension 0..*ExtensionSlice: Unordered, Open by value:url
.... contactpoint-viaintermediary 0..1Reference(VhDir Practitionerrole | VhDir Organization | VhDir OrganizationAffiliation | 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 1..1code
.... value 1..1string
... address 0..*Address
.... extension 0..*ExtensionSlice: Unordered, Open by value:url
.... geolocation 0..1(Complex)The absolute geographic location
URL: http://hl7.org/fhir/StructureDefinition/geolocation
... partOf 0..1Reference(VhDir Organization)
... contact 0..*BackboneElement
.... name 0..1HumanName
..... family 1..1string
..... given 1..*string
.... telecom 0..*ContactPoint
..... extension 0..*ExtensionSlice: Unordered, Open by value:url
..... contactpoint-viaintermediary 0..1Reference(VhDir Practitionerrole | VhDir Organization | VhDir OrganizationAffiliation | 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 1..1code
..... value 1..1string
.... address 0..1Address
..... extension 0..*ExtensionSlice: Unordered, Open by value:url
..... geolocation 0..1(Complex)The absolute geographic location
URL: http://hl7.org/fhir/StructureDefinition/geolocation
... endpoint 0..*Reference(VhDir Endpoint)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization I0..*A grouping of people or organizations with a common purpose
... id Σ0..1idLogical 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: Common Languages (preferred)
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... org-description 0..1stringExtension
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/org-description
... digitalcertificate 0..*(Complex)Extension
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/digitalcertificate
... qualification 0..*(Complex)Qualification
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 InsurancePlan)insurancePlan
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/insuranceplan-reference
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*IdentifierIdentifies this organization across multiple systems
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... identifier-status 1..1codeExtension
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status
Binding: VhDir Identifier Status Value Set (example)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1"http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status"
..... valueCode 1..1codeactive|inactive|issued in error|revoked|pending
Binding: VhDir Identifier Status Value Set (example)
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system Σ0..1uriThe namespace for the identifier value
Example General': http://www.acme.com/identifiers/patient
.... value Σ0..1stringThe value that is unique
Example General': 123456
.... 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)
... 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
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... org-alias-type 0..1CodingExtension
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/org-alias-type
Binding: VhDir Alias Type Value Set (example)
.... org-alias-period 0..1PeriodExtension
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/org-alias-period
.... value 0..1Primitive value for string
Max Length: 1048576
... telecom I0..*ContactPointA contact detail for the organization
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... contactpoint-viaintermediary 0..1Reference(VhDir Practitionerrole | VhDir Organization | VhDir OrganizationAffiliation | VhDir Location)Extension
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1"http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary"
..... valueReference 1..1Reference(VhDir Practitionerrole | VhDir Organization | VhDir OrganizationAffiliation | VhDir Location)Via intermediary
.... contactpoint-availabletime 0..*(Complex)Extension
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... extension 0..*ExtensionDays of week
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1"daysOfWeek"
...... valueCode 1..1codeDays of the week - mon|tue|wed|thu|fri|sat|sun
Binding: DaysOfWeek (required)
..... extension 0..1ExtensionAll day
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1"allDay"
...... valueBoolean 1..1booleanAll day
..... extension 0..1ExtensionAvailable start time
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1"availableStartTime"
...... valueTime 1..1timeAvailable start time
..... extension 0..1ExtensionAvailable end time
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1"availableEndTime"
...... valueTime 1..1timeAvailable end time
..... url 1..1"http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime"
.... system ΣI1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
.... value Σ1..1stringThe actual contact point details
.... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... 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
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... geolocation 0..1(Complex)Extension
URL: http://hl7.org/fhir/StructureDefinition/geolocation
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... extension 1..1ExtensionLatitude with WGS84 datum
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..0
...... url 1..1uri"latitude"
...... valueDecimal 0..1decimalValue of extension
..... extension 1..1ExtensionLongitude with WGS84 datum
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..0
...... url 1..1uri"longitude"
...... valueDecimal 0..1decimalValue of extension
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/geolocation"
.... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required)
Example General': home
.... type Σ0..1codepostal | physical | both
Binding: AddressType (required)
Example General': both
.... text Σ0..1stringText representation of the address
Example General': 137 Nowhere Street, Erewhon 9132
.... 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
Example General': 137 Nowhere Street
.... city Σ0..1stringName of city, town etc.
Example General': Erewhon
.... district Σ0..1stringDistrict name (aka county)
Example General': Madison
.... state Σ0..1stringSub-unit of country (abbreviations ok)
.... postalCode Σ0..1stringPostal code for area
Example General': 9132
.... country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
.... period Σ0..1PeriodTime period when address was/is in use
Example General': {"start":"2010-03-23","end":"2010-07-01"}
... partOf Σ0..1Reference(VhDir Organization)The organization of which this organization forms a part
... contact I0..*BackboneElementContact for the organization for a certain purpose
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored if unrecognized
.... purpose 0..1CodeableConceptThe type of contact
Binding: ContactEntityType (extensible)
.... name 0..1HumanNameA name associated with the contact
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required)
..... 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
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... contactpoint-viaintermediary 0..1Reference(VhDir Practitionerrole | VhDir Organization | VhDir OrganizationAffiliation | VhDir Location)Extension
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1"http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary"
...... valueReference 1..1Reference(VhDir Practitionerrole | VhDir Organization | VhDir OrganizationAffiliation | VhDir Location)Via intermediary
..... contactpoint-availabletime 0..*(Complex)Extension
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... extension 0..*ExtensionDays of week
....... id 0..1stringxml:id (or equivalent in JSON)
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1"daysOfWeek"
....... valueCode 1..1codeDays of the week - mon|tue|wed|thu|fri|sat|sun
Binding: DaysOfWeek (required)
...... extension 0..1ExtensionAll day
....... id 0..1stringxml:id (or equivalent in JSON)
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1"allDay"
....... valueBoolean 1..1booleanAll day
...... extension 0..1ExtensionAvailable start time
....... id 0..1stringxml:id (or equivalent in JSON)
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1"availableStartTime"
....... valueTime 1..1timeAvailable start time
...... extension 0..1ExtensionAvailable end time
....... id 0..1stringxml:id (or equivalent in JSON)
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1"availableEndTime"
....... valueTime 1..1timeAvailable end time
...... url 1..1"http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime"
..... system ΣI1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
..... value Σ1..1stringThe actual contact point details
..... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
..... 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
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... geolocation 0..1(Complex)Extension
URL: http://hl7.org/fhir/StructureDefinition/geolocation
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... extension 1..1ExtensionLatitude with WGS84 datum
....... id 0..1stringxml:id (or equivalent in JSON)
....... extension 0..0
....... url 1..1uri"latitude"
....... valueDecimal 0..1decimalValue of extension
...... extension 1..1ExtensionLongitude with WGS84 datum
....... id 0..1stringxml:id (or equivalent in JSON)
....... extension 0..0
....... url 1..1uri"longitude"
....... valueDecimal 0..1decimalValue of extension
...... url 1..1uri"http://hl7.org/fhir/StructureDefinition/geolocation"
..... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required)
Example General': home
..... type Σ0..1codepostal | physical | both
Binding: AddressType (required)
Example General': both
..... text Σ0..1stringText representation of the address
Example General': 137 Nowhere Street, Erewhon 9132
..... 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
Example General': 137 Nowhere Street
..... city Σ0..1stringName of city, town etc.
Example General': Erewhon
..... district Σ0..1stringDistrict name (aka county)
Example General': Madison
..... state Σ0..1stringSub-unit of country (abbreviations ok)
..... postalCode Σ0..1stringPostal code for area
Example General': 9132
..... country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
..... period Σ0..1PeriodTime period when address was/is in use
Example General': {"start":"2010-03-23","end":"2010-07-01"}
... endpoint 0..*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 0..1stringDescription
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/org-description
... digitalcertificate 0..*(Complex)digitalcertificate
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/digitalcertificate
... qualification 0..*(Complex)Qualification
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 InsurancePlan)insurancePlan
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/insuranceplan-reference
... identifier 0..*Identifier
.... extension 0..*ExtensionSlice: Unordered, Open by value:url
.... identifier-status 1..1codeStatus
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status
Binding: VhDir Identifier Status Value Set (example)
.... assigner 0..1Reference(VhDir Organization)
... active 1..1boolean
... type 1..*CodeableConcept
... name 1..1string
... alias 0..*string
.... extension 0..*ExtensionSlice: Unordered, Open by value:url
.... org-alias-type 0..1CodingType
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/org-alias-type
Binding: VhDir Alias Type Value Set (example)
.... org-alias-period 0..1PeriodPeriod
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/org-alias-period
... telecom 0..*ContactPoint
.... extension 0..*ExtensionSlice: Unordered, Open by value:url
.... contactpoint-viaintermediary 0..1Reference(VhDir Practitionerrole | VhDir Organization | VhDir OrganizationAffiliation | 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 1..1code
.... value 1..1string
... address 0..*Address
.... extension 0..*ExtensionSlice: Unordered, Open by value:url
.... geolocation 0..1(Complex)The absolute geographic location
URL: http://hl7.org/fhir/StructureDefinition/geolocation
... partOf 0..1Reference(VhDir Organization)
... contact 0..*BackboneElement
.... name 0..1HumanName
..... family 1..1string
..... given 1..*string
.... telecom 0..*ContactPoint
..... extension 0..*ExtensionSlice: Unordered, Open by value:url
..... contactpoint-viaintermediary 0..1Reference(VhDir Practitionerrole | VhDir Organization | VhDir OrganizationAffiliation | 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 1..1code
..... value 1..1string
.... address 0..1Address
..... extension 0..*ExtensionSlice: Unordered, Open by value:url
..... geolocation 0..1(Complex)The absolute geographic location
URL: http://hl7.org/fhir/StructureDefinition/geolocation
... endpoint 0..*Reference(VhDir Endpoint)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization I0..*A grouping of people or organizations with a common purpose
... id Σ0..1idLogical 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: Common Languages (preferred)
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... org-description 0..1stringExtension
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/org-description
... digitalcertificate 0..*(Complex)Extension
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/digitalcertificate
... qualification 0..*(Complex)Qualification
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 InsurancePlan)insurancePlan
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/insuranceplan-reference
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*IdentifierIdentifies this organization across multiple systems
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... identifier-status 1..1codeExtension
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status
Binding: VhDir Identifier Status Value Set (example)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1"http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status"
..... valueCode 1..1codeactive|inactive|issued in error|revoked|pending
Binding: VhDir Identifier Status Value Set (example)
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system Σ0..1uriThe namespace for the identifier value
Example General': http://www.acme.com/identifiers/patient
.... value Σ0..1stringThe value that is unique
Example General': 123456
.... 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)
... 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
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... org-alias-type 0..1CodingExtension
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/org-alias-type
Binding: VhDir Alias Type Value Set (example)
.... org-alias-period 0..1PeriodExtension
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/org-alias-period
.... value 0..1Primitive value for string
Max Length: 1048576
... telecom I0..*ContactPointA contact detail for the organization
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... contactpoint-viaintermediary 0..1Reference(VhDir Practitionerrole | VhDir Organization | VhDir OrganizationAffiliation | VhDir Location)Extension
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1"http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary"
..... valueReference 1..1Reference(VhDir Practitionerrole | VhDir Organization | VhDir OrganizationAffiliation | VhDir Location)Via intermediary
.... contactpoint-availabletime 0..*(Complex)Extension
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... extension 0..*ExtensionDays of week
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1"daysOfWeek"
...... valueCode 1..1codeDays of the week - mon|tue|wed|thu|fri|sat|sun
Binding: DaysOfWeek (required)
..... extension 0..1ExtensionAll day
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1"allDay"
...... valueBoolean 1..1booleanAll day
..... extension 0..1ExtensionAvailable start time
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1"availableStartTime"
...... valueTime 1..1timeAvailable start time
..... extension 0..1ExtensionAvailable end time
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1"availableEndTime"
...... valueTime 1..1timeAvailable end time
..... url 1..1"http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime"
.... system ΣI1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
.... value Σ1..1stringThe actual contact point details
.... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... 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
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... geolocation 0..1(Complex)Extension
URL: http://hl7.org/fhir/StructureDefinition/geolocation
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... extension 1..1ExtensionLatitude with WGS84 datum
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..0
...... url 1..1uri"latitude"
...... valueDecimal 0..1decimalValue of extension
..... extension 1..1ExtensionLongitude with WGS84 datum
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..0
...... url 1..1uri"longitude"
...... valueDecimal 0..1decimalValue of extension
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/geolocation"
.... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required)
Example General': home
.... type Σ0..1codepostal | physical | both
Binding: AddressType (required)
Example General': both
.... text Σ0..1stringText representation of the address
Example General': 137 Nowhere Street, Erewhon 9132
.... 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
Example General': 137 Nowhere Street
.... city Σ0..1stringName of city, town etc.
Example General': Erewhon
.... district Σ0..1stringDistrict name (aka county)
Example General': Madison
.... state Σ0..1stringSub-unit of country (abbreviations ok)
.... postalCode Σ0..1stringPostal code for area
Example General': 9132
.... country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
.... period Σ0..1PeriodTime period when address was/is in use
Example General': {"start":"2010-03-23","end":"2010-07-01"}
... partOf Σ0..1Reference(VhDir Organization)The organization of which this organization forms a part
... contact I0..*BackboneElementContact for the organization for a certain purpose
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored if unrecognized
.... purpose 0..1CodeableConceptThe type of contact
Binding: ContactEntityType (extensible)
.... name 0..1HumanNameA name associated with the contact
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required)
..... 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
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... contactpoint-viaintermediary 0..1Reference(VhDir Practitionerrole | VhDir Organization | VhDir OrganizationAffiliation | VhDir Location)Extension
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1"http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary"
...... valueReference 1..1Reference(VhDir Practitionerrole | VhDir Organization | VhDir OrganizationAffiliation | VhDir Location)Via intermediary
..... contactpoint-availabletime 0..*(Complex)Extension
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... extension 0..*ExtensionDays of week
....... id 0..1stringxml:id (or equivalent in JSON)
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1"daysOfWeek"
....... valueCode 1..1codeDays of the week - mon|tue|wed|thu|fri|sat|sun
Binding: DaysOfWeek (required)
...... extension 0..1ExtensionAll day
....... id 0..1stringxml:id (or equivalent in JSON)
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1"allDay"
....... valueBoolean 1..1booleanAll day
...... extension 0..1ExtensionAvailable start time
....... id 0..1stringxml:id (or equivalent in JSON)
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1"availableStartTime"
....... valueTime 1..1timeAvailable start time
...... extension 0..1ExtensionAvailable end time
....... id 0..1stringxml:id (or equivalent in JSON)
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1"availableEndTime"
....... valueTime 1..1timeAvailable end time
...... url 1..1"http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime"
..... system ΣI1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
..... value Σ1..1stringThe actual contact point details
..... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
..... 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
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... geolocation 0..1(Complex)Extension
URL: http://hl7.org/fhir/StructureDefinition/geolocation
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... extension 1..1ExtensionLatitude with WGS84 datum
....... id 0..1stringxml:id (or equivalent in JSON)
....... extension 0..0
....... url 1..1uri"latitude"
....... valueDecimal 0..1decimalValue of extension
...... extension 1..1ExtensionLongitude with WGS84 datum
....... id 0..1stringxml:id (or equivalent in JSON)
....... extension 0..0
....... url 1..1uri"longitude"
....... valueDecimal 0..1decimalValue of extension
...... url 1..1uri"http://hl7.org/fhir/StructureDefinition/geolocation"
..... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required)
Example General': home
..... type Σ0..1codepostal | physical | both
Binding: AddressType (required)
Example General': both
..... text Σ0..1stringText representation of the address
Example General': 137 Nowhere Street, Erewhon 9132
..... 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
Example General': 137 Nowhere Street
..... city Σ0..1stringName of city, town etc.
Example General': Erewhon
..... district Σ0..1stringDistrict name (aka county)
Example General': Madison
..... state Σ0..1stringSub-unit of country (abbreviations ok)
..... postalCode Σ0..1stringPostal code for area
Example General': 9132
..... country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
..... period Σ0..1PeriodTime period when address was/is in use
Example General': {"start":"2010-03-23","end":"2010-07-01"}
... endpoint 0..*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


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?organization-address=[string]

    Support: SHALL support search by the organization-address parameter

    • including the modifiers: contains, exact

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

    Support: SHOULD support search by the organization-address-city parameter

    • including the modifiers: exact

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

    Support: SHOULD support search by the organization-address-country parameter

    • including the modifiers: exact

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

    Support: SHOULD support search by the organization-address-postalcode parameter

    • including the modifiers: exact

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

    Support: SHOULD support search by the organization-address-state parameter

    • including the modifiers: exact

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

    Support: SHALL support search by the organization-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?organization-identifier=[code]

    Support: SHALL support search by the organization-identifier parameter

    • including the modifiers: text, ofType

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

    Support: MAY support search by the organization-identifier-assigner parameter

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

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

    Support: SHALL support search by the organization-name parameter

    • including the modifiers: exact, contains

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

    Support: SHALL support search by the organization-partof parameter

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

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

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

    • including the modifiers: text

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

    Support: MAY support search by the organization-qualification-issuer parameter

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

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

    Support: SHOULD support search by the organization-qualification-status parameter

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

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

    • including the modifiers: text

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

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

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

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

    Support: SHALL support search by the type parameter

    • including the modifiers: text

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

    Support: MAY support search by the organization-via-intermediary parameter

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