VhDir Implementation Guide CI Build

This is the Continuous Integration Build of the VhDir Implementation Guide, based on FHIR Version 4.0.0. 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 (example)
.... 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..1
... 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..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: CommonLanguages (preferred)
Max Binding: AllLanguages
... 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 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
.... 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 (example)
..... id 0..1stringUnique id for inter-element referencing
..... 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 S1..1codeactive|inactive|issued in error|revoked|pending
Binding: VhDir Identifier Status Value Set (example)
.... use ?!SΣ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type SΣ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... 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)
... 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)
.... 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..1Primitive value for string
Max Length: 1048576
... telecom SI0..*ContactPointA contact detail for the organization
.... id 0..1stringUnique id for inter-element referencing
.... 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
..... id 0..1stringUnique id for inter-element referencing
..... 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 S1..1Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location)Via intermediary
.... contactpoint-availabletime S0..*(Complex)Available time
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... extension S0..*ExtensionDays of week
...... id 0..1stringUnique id for inter-element referencing
...... 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 S0..1ExtensionAll day
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1"allDay"
...... valueBoolean 1..1booleanAll day
..... extension S0..1ExtensionAvailable start time
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1"availableStartTime"
...... valueTime 1..1timeAvailable start time
..... extension S0..1ExtensionAvailable end time
...... id 0..1stringUnique id for inter-element referencing
...... 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 SΣI1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
.... value SΣ1..1stringThe actual contact point details
.... use ?!SΣ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... 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
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... geolocation S0..1(Complex)The absolute geographic location
URL: http://hl7.org/fhir/StructureDefinition/geolocation
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... extension 1..1ExtensionLatitude with WGS84 datum
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..0
...... url 1..1uri"latitude"
...... valueDecimal 0..1decimalValue of extension
..... extension 1..1ExtensionLongitude with WGS84 datum
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..0
...... url 1..1uri"longitude"
...... valueDecimal 0..1decimalValue of extension
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/geolocation"
.... use ?!SΣ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required)
Example General': home
.... type SΣ0..1codepostal | physical | both
Binding: AddressType (required)
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-23T00:00:00+00:00","end":"2010-07-01T00:00:00+00:00"}
... partOf SΣ0..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 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)
.... name S0..1HumanNameA name associated with the contact
..... id 0..1stringUnique id for inter-element referencing
..... 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)
..... 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
..... 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
...... id 0..1stringUnique id for inter-element referencing
...... 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 S1..1Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location)Via intermediary
..... contactpoint-availabletime S0..*(Complex)Available time
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... extension S0..*ExtensionDays of week
....... id 0..1stringUnique id for inter-element referencing
....... 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 S0..1ExtensionAll day
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1"allDay"
....... valueBoolean 1..1booleanAll day
...... extension S0..1ExtensionAvailable start time
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1"availableStartTime"
....... valueTime 1..1timeAvailable start time
...... extension S0..1ExtensionAvailable end time
....... id 0..1stringUnique id for inter-element referencing
....... 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 SΣI1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
..... value SΣ1..1stringThe actual contact point details
..... use ?!SΣ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
..... 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
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... geolocation S0..1(Complex)The absolute geographic location
URL: http://hl7.org/fhir/StructureDefinition/geolocation
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... extension 1..1ExtensionLatitude with WGS84 datum
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..0
....... url 1..1uri"latitude"
....... valueDecimal 0..1decimalValue of extension
...... extension 1..1ExtensionLongitude with WGS84 datum
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..0
....... url 1..1uri"longitude"
....... valueDecimal 0..1decimalValue of extension
...... url 1..1uri"http://hl7.org/fhir/StructureDefinition/geolocation"
..... use ?!SΣ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required)
Example General': home
..... type SΣ0..1codepostal | physical | both
Binding: AddressType (required)
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-23T00:00:00+00:00","end":"2010-07-01T00:00:00+00:00"}
... endpoint S0..*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 (example)
.... 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..1
... 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..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: CommonLanguages (preferred)
Max Binding: AllLanguages
... 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 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
.... 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 (example)
..... id 0..1stringUnique id for inter-element referencing
..... 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 S1..1codeactive|inactive|issued in error|revoked|pending
Binding: VhDir Identifier Status Value Set (example)
.... use ?!SΣ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type SΣ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... 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)
... 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)
.... 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..1Primitive value for string
Max Length: 1048576
... telecom SI0..*ContactPointA contact detail for the organization
.... id 0..1stringUnique id for inter-element referencing
.... 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
..... id 0..1stringUnique id for inter-element referencing
..... 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 S1..1Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location)Via intermediary
.... contactpoint-availabletime S0..*(Complex)Available time
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... extension S0..*ExtensionDays of week
...... id 0..1stringUnique id for inter-element referencing
...... 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 S0..1ExtensionAll day
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1"allDay"
...... valueBoolean 1..1booleanAll day
..... extension S0..1ExtensionAvailable start time
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1"availableStartTime"
...... valueTime 1..1timeAvailable start time
..... extension S0..1ExtensionAvailable end time
...... id 0..1stringUnique id for inter-element referencing
...... 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 SΣI1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
.... value SΣ1..1stringThe actual contact point details
.... use ?!SΣ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... 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
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... geolocation S0..1(Complex)The absolute geographic location
URL: http://hl7.org/fhir/StructureDefinition/geolocation
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... extension 1..1ExtensionLatitude with WGS84 datum
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..0
...... url 1..1uri"latitude"
...... valueDecimal 0..1decimalValue of extension
..... extension 1..1ExtensionLongitude with WGS84 datum
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..0
...... url 1..1uri"longitude"
...... valueDecimal 0..1decimalValue of extension
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/geolocation"
.... use ?!SΣ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required)
Example General': home
.... type SΣ0..1codepostal | physical | both
Binding: AddressType (required)
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-23T00:00:00+00:00","end":"2010-07-01T00:00:00+00:00"}
... partOf SΣ0..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 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)
.... name S0..1HumanNameA name associated with the contact
..... id 0..1stringUnique id for inter-element referencing
..... 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)
..... 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
..... 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
...... id 0..1stringUnique id for inter-element referencing
...... 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 S1..1Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location)Via intermediary
..... contactpoint-availabletime S0..*(Complex)Available time
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... extension S0..*ExtensionDays of week
....... id 0..1stringUnique id for inter-element referencing
....... 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 S0..1ExtensionAll day
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1"allDay"
....... valueBoolean 1..1booleanAll day
...... extension S0..1ExtensionAvailable start time
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1"availableStartTime"
....... valueTime 1..1timeAvailable start time
...... extension S0..1ExtensionAvailable end time
....... id 0..1stringUnique id for inter-element referencing
....... 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 SΣI1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
..... value SΣ1..1stringThe actual contact point details
..... use ?!SΣ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
..... 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
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... geolocation S0..1(Complex)The absolute geographic location
URL: http://hl7.org/fhir/StructureDefinition/geolocation
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... extension 1..1ExtensionLatitude with WGS84 datum
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..0
....... url 1..1uri"latitude"
....... valueDecimal 0..1decimalValue of extension
...... extension 1..1ExtensionLongitude with WGS84 datum
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..0
....... url 1..1uri"longitude"
....... valueDecimal 0..1decimalValue of extension
...... url 1..1uri"http://hl7.org/fhir/StructureDefinition/geolocation"
..... use ?!SΣ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required)
Example General': home
..... type SΣ0..1codepostal | physical | both
Binding: AddressType (required)
Example General': both
..... text SΣ0..1stringText representation of the address
Example General': 137 Nowhere Street, Erewhon 9132