Validated Healthcare Directory IG STU1 Draft for Comment

This page is part of the Validated Healthcare Directory FHIR IG (v0.1.0: STU 1 Draft) based on FHIR v3.2.0. . For a full list of available versions, see the Directory of published versions

1.0 - StructureDefinition: vhdir-organization - Content

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 constrains the cardinality of organization.name, organization.type, and organization.active (all are required). It also adds optional extensions to represent more information about an organization’s alias(es), a description of the organization, the organization’s qualifications (e.g. accreditations), and digital certificates for the organization.

Examples:

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

  • TBD

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
  4. For each alias, a name in organization.alias.name

Profile specific implementation guidance:

  • TBD

Extensions:

  1. Restriction (0..*) - indicates restrictions on the use/release of information associated with the organization
  2. Alias (0..*) - a list of other names the organization is known by, consisting of:
    1. Name (1..1) - the alias
    2. Type (0..1) - indicates the type of alias
    3. Period (0..1) - indicates the period during which the alias is in use
  3. Description (0..1) - a friendly description of the organization
  4. Qualification (0..*) - indicates whether the organization has any formal qualifications
  5. DigitalCertificate (0..*) - a digital certificate associated with the organization

Terminology

TBD

1.2 - Formal Views of Profile Content

The official URL for this profile is: 

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

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

This profile builds on Organization.

This profile was published on Fri Sep 01 06:26:52 AEST 2017 as a draft by HL7 International.

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

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
  4. For each alias, a name in organization.alias.name
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization 0..*
... id 0..1id
... implicitRules 0..0
... language 0..0
... contained 0..0
... identifier 0..*Identifier
.... identifier-status 0..1codeStatus
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/identifier-status
... active 1..1boolean
... type 1..1CodeableConcept
... name 1..1string
... alias 0..*string
.... org-alias-type 0..1codeType
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/org-alias-type
.... org-alias-period 0..1PeriodPeriod
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/org-alias-period
... telecom 0..*ContactPoint
.... contactPoint-viaIntermediary 0..1Reference(vhdir-practitioner), Reference(vhdir-organization), Reference(vhdir-location)viaIntermediary
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/contactPoint-viaIntermediary
.... contactPoint-availableTime 0..*(Complex)Available time
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/contactPoint-availableTime
... address 0..*Address
.... geolocation 0..1(Complex)The absolute geographic location
URL: http://hl7.org/fhir/StructureDefinition/geolocation
... contact 0..*BackboneElement
.... name 0..1HumanName
..... family 1..1string
..... given 1..1string
.... telecom 0..*ContactPoint
..... contactPoint-viaIntermediary 0..*Reference(vhdir-practitioner), Reference(vhdir-organization), Reference(vhdir-location)viaIntermediary
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/contactPoint-viaIntermediary
..... contactPoint-availableTime 0..*(Complex)Available time
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/contactPoint-availableTime
.... address 0..1Address
..... address-position 0..*(Complex)Position
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/address-position
... org-description 0..1stringDescription
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/org-description
... digitalCertificate 0..*(Complex)digitalCertificate
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/digitalCertificate
... qualification 0..*(Complex)Qualification
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/qualification
... usage-restriction 0..*Reference(vhdir-restriction)Restriction
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/usage-restriction

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
... text I0..1NarrativeText summary of the resource, for human interpretation
... org-description 0..1stringExtension
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/org-description
... digitalCertificate 0..*(Complex)Extension
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/digitalCertificate
... qualification 0..*(Complex)Qualification
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/qualification
... usage-restriction 0..*Reference(vhdir-restriction)Restriction
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/usage-restriction
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*IdentifierIdentifies this organization across multiple systems
.... id 0..1stringxml:id (or equivalent in JSON)
.... identifier-status 0..1codeExtension
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/identifier-status
..... id 0..1stringxml:id (or equivalent in JSON)
..... url 1..1uri"http://hl7.org/fhir/ig/vhdir/StructureDefinition/identifier-status"
..... valueCode 0..1codeStatus
.... 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 or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri
.... value Σ0..1stringThe value that is unique
Example General': 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... active ?!Σ1..1booleanWhether the organization's record is still in active use
... type Σ1..1CodeableConceptKind 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)
.... org-alias-type 0..1codeExtension
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/org-alias-type
.... org-alias-period 0..1PeriodExtension
URL: http://hl7.org/fhir/ig/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)
.... contactPoint-viaIntermediary 0..1Reference(vhdir-practitioner), Reference(vhdir-organization), Reference(vhdir-location)Extension
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/contactPoint-viaIntermediary
..... id 0..1stringxml:id (or equivalent in JSON)
..... url 1..1uri"http://hl7.org/fhir/ig/vhdir/StructureDefinition/contactPoint-viaIntermediary"
..... value[x] 0..1Reference(vhdir-practitioner), Reference(vhdir-organization), Reference(vhdir-location)Via intermediary
.... contactPoint-availableTime 0..*(Complex)Extension
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/contactPoint-availableTime
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionDays of week
...... id 0..1stringxml:id (or equivalent in JSON)
...... url 1..1uri"daysOfWeek"
...... valueCode 0..1codeDays of week
..... extension 0..1ExtensionAll day
...... id 0..1stringxml:id (or equivalent in JSON)
...... url 1..1uri"allDay"
...... valueBoolean 0..1booleanAll day
..... extension 0..1ExtensionAvailable start time
...... id 0..1stringxml:id (or equivalent in JSON)
...... url 1..1uri"availableStartTime"
...... valueTime 0..1timeAvailable start time
..... extension 0..1ExtensionAvailable end time
...... id 0..1stringxml:id (or equivalent in JSON)
...... url 1..1uri"availableEndTime"
...... valueTime 0..1timeAvailable end time
..... url 1..1uri"http://hl7.org/fhir/ig/vhdir/StructureDefinition/contactPoint-availableTime"
.... system ΣI0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
.... value Σ0..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)
.... geolocation 0..1(Complex)Extension
URL: http://hl7.org/fhir/StructureDefinition/geolocation
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 1..1ExtensionLatitude with WGS84 datum
...... id 0..1stringxml:id (or equivalent in JSON)
...... url 1..1uri"latitude"
...... valueDecimal 0..1decimalValue of extension
..... extension 1..1ExtensionLongitude with WGS84 datum
...... id 0..1stringxml:id (or equivalent in JSON)
...... 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(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
.... 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)
..... 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..1stringGiven 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)
..... contactPoint-viaIntermediary 0..*Reference(vhdir-practitioner), Reference(vhdir-organization), Reference(vhdir-location)Extension
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/contactPoint-viaIntermediary
...... id 0..1stringxml:id (or equivalent in JSON)
...... url 1..1uri"http://hl7.org/fhir/ig/vhdir/StructureDefinition/contactPoint-viaIntermediary"
...... value[x] 0..1Reference(vhdir-practitioner), Reference(vhdir-organization), Reference(vhdir-location)Via intermediary
..... contactPoint-availableTime 0..*(Complex)Extension
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/contactPoint-availableTime
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionDays of week
....... id 0..1stringxml:id (or equivalent in JSON)
....... url 1..1uri"daysOfWeek"
....... valueCode 0..1codeDays of week
...... extension 0..1ExtensionAll day
....... id 0..1stringxml:id (or equivalent in JSON)
....... url 1..1uri"allDay"
....... valueBoolean 0..1booleanAll day
...... extension 0..1ExtensionAvailable start time
....... id 0..1stringxml:id (or equivalent in JSON)
....... url 1..1uri"availableStartTime"
....... valueTime 0..1timeAvailable start time
...... extension 0..1ExtensionAvailable end time
....... id 0..1stringxml:id (or equivalent in JSON)
....... url 1..1uri"availableEndTime"
....... valueTime 0..1timeAvailable end time
...... url 1..1uri"http://hl7.org/fhir/ig/vhdir/StructureDefinition/contactPoint-availableTime"
..... system ΣI0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
..... value Σ0..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)
..... address-position 0..*(Complex)Extension
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/address-position
..... 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(Endpoint)Technical endpoints providing access to services operated for the organization

doco Documentation for this format

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
  4. For each alias, a name in organization.alias.name

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization 0..*
... id 0..1id
... implicitRules 0..0
... language 0..0
... contained 0..0
... identifier 0..*Identifier
.... identifier-status 0..1codeStatus
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/identifier-status
... active 1..1boolean
... type 1..1CodeableConcept
... name 1..1string
... alias 0..*string
.... org-alias-type 0..1codeType
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/org-alias-type
.... org-alias-period 0..1PeriodPeriod
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/org-alias-period
... telecom 0..*ContactPoint
.... contactPoint-viaIntermediary 0..1Reference(vhdir-practitioner), Reference(vhdir-organization), Reference(vhdir-location)viaIntermediary
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/contactPoint-viaIntermediary
.... contactPoint-availableTime 0..*(Complex)Available time
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/contactPoint-availableTime
... address 0..*Address
.... geolocation 0..1(Complex)The absolute geographic location
URL: http://hl7.org/fhir/StructureDefinition/geolocation
... contact 0..*BackboneElement
.... name 0..1HumanName
..... family 1..1string
..... given 1..1string
.... telecom 0..*ContactPoint
..... contactPoint-viaIntermediary 0..*Reference(vhdir-practitioner), Reference(vhdir-organization), Reference(vhdir-location)viaIntermediary
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/contactPoint-viaIntermediary
..... contactPoint-availableTime 0..*(Complex)Available time
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/contactPoint-availableTime
.... address 0..1Address
..... address-position 0..*(Complex)Position
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/address-position
... org-description 0..1stringDescription
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/org-description
... digitalCertificate 0..*(Complex)digitalCertificate
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/digitalCertificate
... qualification 0..*(Complex)Qualification
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/qualification
... usage-restriction 0..*Reference(vhdir-restriction)Restriction
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/usage-restriction

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
... text I0..1NarrativeText summary of the resource, for human interpretation
... org-description 0..1stringExtension
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/org-description
... digitalCertificate 0..*(Complex)Extension
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/digitalCertificate
... qualification 0..*(Complex)Qualification
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/qualification
... usage-restriction 0..*Reference(vhdir-restriction)Restriction
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/usage-restriction
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*IdentifierIdentifies this organization across multiple systems
.... id 0..1stringxml:id (or equivalent in JSON)
.... identifier-status 0..1codeExtension
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/identifier-status
..... id 0..1stringxml:id (or equivalent in JSON)
..... url 1..1uri"http://hl7.org/fhir/ig/vhdir/StructureDefinition/identifier-status"
..... valueCode 0..1codeStatus
.... 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 or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri
.... value Σ0..1stringThe value that is unique
Example General': 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... active ?!Σ1..1booleanWhether the organization's record is still in active use
... type Σ1..1CodeableConceptKind 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)
.... org-alias-type 0..1codeExtension
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/org-alias-type
.... org-alias-period 0..1PeriodExtension
URL: http://hl7.org/fhir/ig/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)
.... contactPoint-viaIntermediary 0..1Reference(vhdir-practitioner), Reference(vhdir-organization), Reference(vhdir-location)Extension
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/contactPoint-viaIntermediary
..... id 0..1stringxml:id (or equivalent in JSON)
..... url 1..1uri"http://hl7.org/fhir/ig/vhdir/StructureDefinition/contactPoint-viaIntermediary"
..... value[x] 0..1Reference(vhdir-practitioner), Reference(vhdir-organization), Reference(vhdir-location)Via intermediary
.... contactPoint-availableTime 0..*(Complex)Extension
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/contactPoint-availableTime
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionDays of week
...... id 0..1stringxml:id (or equivalent in JSON)
...... url 1..1uri"daysOfWeek"
...... valueCode 0..1codeDays of week
..... extension 0..1ExtensionAll day
...... id 0..1stringxml:id (or equivalent in JSON)
...... url 1..1uri"allDay"
...... valueBoolean 0..1booleanAll day
..... extension 0..1ExtensionAvailable start time
...... id 0..1stringxml:id (or equivalent in JSON)
...... url 1..1uri"availableStartTime"
...... valueTime 0..1timeAvailable start time
..... extension 0..1ExtensionAvailable end time
...... id 0..1stringxml:id (or equivalent in JSON)
...... url 1..1uri"availableEndTime"
...... valueTime 0..1timeAvailable end time
..... url 1..1uri"http://hl7.org/fhir/ig/vhdir/StructureDefinition/contactPoint-availableTime"
.... system ΣI0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
.... value Σ0..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)
.... geolocation 0..1(Complex)Extension
URL: http://hl7.org/fhir/StructureDefinition/geolocation
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 1..1ExtensionLatitude with WGS84 datum
...... id 0..1stringxml:id (or equivalent in JSON)
...... url 1..1uri"latitude"
...... valueDecimal 0..1decimalValue of extension
..... extension 1..1ExtensionLongitude with WGS84 datum
...... id 0..1stringxml:id (or equivalent in JSON)
...... 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(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
.... 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)
..... 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..1stringGiven 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)
..... contactPoint-viaIntermediary 0..*Reference(vhdir-practitioner), Reference(vhdir-organization), Reference(vhdir-location)Extension
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/contactPoint-viaIntermediary
...... id 0..1stringxml:id (or equivalent in JSON)
...... url 1..1uri"http://hl7.org/fhir/ig/vhdir/StructureDefinition/contactPoint-viaIntermediary"
...... value[x] 0..1Reference(vhdir-practitioner), Reference(vhdir-organization), Reference(vhdir-location)Via intermediary
..... contactPoint-availableTime 0..*(Complex)Extension
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/contactPoint-availableTime
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionDays of week
....... id 0..1stringxml:id (or equivalent in JSON)
....... url 1..1uri"daysOfWeek"
....... valueCode 0..1codeDays of week
...... extension 0..1ExtensionAll day
....... id 0..1stringxml:id (or equivalent in JSON)
....... url 1..1uri"allDay"
....... valueBoolean 0..1booleanAll day
...... extension 0..1ExtensionAvailable start time
....... id 0..1stringxml:id (or equivalent in JSON)
....... url 1..1uri"availableStartTime"
....... valueTime 0..1timeAvailable start time
...... extension 0..1ExtensionAvailable end time
....... id 0..1stringxml:id (or equivalent in JSON)
....... url 1..1uri"availableEndTime"
....... valueTime 0..1timeAvailable end time
...... url 1..1uri"http://hl7.org/fhir/ig/vhdir/StructureDefinition/contactPoint-availableTime"
..... system ΣI0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
..... value Σ0..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)
..... address-position 0..*(Complex)Extension
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/address-position
..... 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(Endpoint)Technical endpoints providing access to services operated for the organization

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON, CSV), Schema: XML Schematron

 

1.3 - Quick Start

Below is an overview of the required search and read operations for this profile. See the Conformance requirements for the US Core Server for a complete list of supported RESTful operations and search parameters for this IG.

GET [base]/Organization?identifier=[system]|[code]

Example: GET [base]/Organization?identifier=12354

Support: Mandatory

Implementation Notes: Search based on Organization identifier (how to search by token).

Response Class:

  • (Status 200): successful operation
  • (Status 400): invalid parameter
  • (Status 401/4xx): unauthorized request
  • (Status 403): insufficient scope

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

Example: GET [base]/Organization?name=Health

Support: Mandatory

Implementation Notes: Search based on text name (how to search by string). May also support:

  • address-city
  • address-state
  • address-postalcode

Response Class:

  • (Status 200): successful operation
  • (Status 400): invalid parameter
  • (Status 401/4xx): unauthorized request
  • (Status 403): insufficient scope

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

Example: GET [base]/Organization?address=Arbor

Example: GET [base]/Organization?address-postalcode=48104

Support: Mandatory

Implementation Notes: Search based on text address (how to search by string).

Response Class:

  • (Status 200): successful operation
  • (Status 400): invalid parameter
  • (Status 401/4xx): unauthorized request
  • (Status 403): insufficient scope