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), andorganization.contact.telecom.value
(1..1) -
All references SHALL conform to the appropriate Validated Healthcare Directory Implementation Guide profile
-
Adds extensions:
- Identifier status (1..1) - indicates the status of an organization’s identifier
- Via intermediary (0..1) - a reference to an alternative point of contact for this organization
- Available time (0..*) - indicates when an organization is available for contact
- Geolocation (0..1) - indicates the absolute geographic location of an organization’s address
- Alias type (0..1) - indicates whether an organization’s alias is a historical name or legal alternative name
- Alias period (0..1) - indicates a period of time for which an organization used an alias
- Description (0..1) - a friendly description of the organization
- Qualification (0..*) - indicates whether the organization has any formal qualifications
- DigitalCertificate (0..*) - a digital certificate associated with the organization
- InsurancePlan (0..*) - indicates the health insurance products the organization offers to its employees
- 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:
- A boolean value in
organization.active
- A name in
organization.name
- 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
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Organization | I | 0..* | A grouping of people or organizations with a common purpose | |
id | Σ | 0..1 | id | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: Common Languages (preferred) | |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
org-description | 0..1 | string | Extension 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..* | Extension | Extensions that cannot be ignored |
identifier | ΣI | 0..* | Identifier | Identifies this organization across multiple systems |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
identifier-status | 1..1 | code | Extension URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status Binding: VhDir Identifier Status Value Set (example) | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
url | 1..1 | "http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status" | ||
valueCode | 1..1 | code | active|inactive|issued in error|revoked|pending Binding: VhDir Identifier Status Value Set (example) | |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
system | Σ | 0..1 | uri | The namespace for the identifier value Example General': http://www.acme.com/identifiers/patient |
value | Σ | 0..1 | string | The value that is unique Example General': 123456 |
period | Σ | 0..1 | Period | Time period when id is/was valid for use |
assigner | Σ | 0..1 | Reference(VhDir Organization) | Organization that issued id (may be just text) |
active | ?!Σ | 1..1 | boolean | Whether the organization's record is still in active use |
type | Σ | 1..* | CodeableConcept | Kind of organization Binding: OrganizationType (example) |
name | ΣI | 1..1 | string | Name used for the organization |
alias | 0..* | string | A list of alternate names that the organization is known as, or was known as in the past | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
org-alias-type | 0..1 | Coding | Extension URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/org-alias-type Binding: VhDir Alias Type Value Set (example) | |
org-alias-period | 0..1 | Period | Extension URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/org-alias-period | |
value | 0..1 | Primitive value for string Max Length: 1048576 | ||
telecom | I | 0..* | ContactPoint | A contact detail for the organization |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
contactpoint-viaintermediary | 0..1 | Reference(VhDir Practitionerrole | VhDir Organization | VhDir OrganizationAffiliation | VhDir Location) | Extension URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
url | 1..1 | "http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary" | ||
valueReference | 1..1 | Reference(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..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
extension | 0..* | Extension | Days of week | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
url | 1..1 | "daysOfWeek" | ||
valueCode | 1..1 | code | Days of the week - mon|tue|wed|thu|fri|sat|sun Binding: DaysOfWeek (required) | |
extension | 0..1 | Extension | All day | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
url | 1..1 | "allDay" | ||
valueBoolean | 1..1 | boolean | All day | |
extension | 0..1 | Extension | Available start time | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
url | 1..1 | "availableStartTime" | ||
valueTime | 1..1 | time | Available start time | |
extension | 0..1 | Extension | Available end time | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
url | 1..1 | "availableEndTime" | ||
valueTime | 1..1 | time | Available end time | |
url | 1..1 | "http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime" | ||
system | ΣI | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) |
value | Σ | 1..1 | string | The actual contact point details |
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) |
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
period | Σ | 0..1 | Period | Time period when the contact point was/is in use |
address | I | 0..* | Address | An address for the organization |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
geolocation | 0..1 | (Complex) | Extension URL: http://hl7.org/fhir/StructureDefinition/geolocation | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
extension | 1..1 | Extension | Latitude with WGS84 datum | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..0 | |||
url | 1..1 | uri | "latitude" | |
valueDecimal | 0..1 | decimal | Value of extension | |
extension | 1..1 | Extension | Longitude with WGS84 datum | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..0 | |||
url | 1..1 | uri | "longitude" | |
valueDecimal | 0..1 | decimal | Value of extension | |
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/geolocation" | |
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required) Example General': home |
type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required) Example General': both |
text | Σ | 0..1 | string | Text representation of the address Example General': 137 Nowhere Street, Erewhon 9132 |
line | Σ | 0..* | string | Street 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..1 | string | Name of city, town etc. Example General': Erewhon |
district | Σ | 0..1 | string | District name (aka county) Example General': Madison |
state | Σ | 0..1 | string | Sub-unit of country (abbreviations ok) |
postalCode | Σ | 0..1 | string | Postal code for area Example General': 9132 |
country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) |
period | Σ | 0..1 | Period | Time period when address was/is in use Example General': {"start":"2010-03-23","end":"2010-07-01"} |
partOf | Σ | 0..1 | Reference(VhDir Organization) | The organization of which this organization forms a part |
contact | I | 0..* | BackboneElement | Contact for the organization for a certain purpose |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored if unrecognized |
purpose | 0..1 | CodeableConcept | The type of contact Binding: ContactEntityType (extensible) | |
name | 0..1 | HumanName | A name associated with the contact | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required) |
text | Σ | 0..1 | string | Text representation of the full name |
family | Σ | 1..1 | string | Family name (often called 'Surname') |
given | Σ | 1..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name |
prefix | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name |
suffix | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name |
period | Σ | 0..1 | Period | Time period when name was/is in use |
telecom | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
contactpoint-viaintermediary | 0..1 | Reference(VhDir Practitionerrole | VhDir Organization | VhDir OrganizationAffiliation | VhDir Location) | Extension URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
url | 1..1 | "http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary" | ||
valueReference | 1..1 | Reference(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..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
extension | 0..* | Extension | Days of week | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
url | 1..1 | "daysOfWeek" | ||
valueCode | 1..1 | code | Days of the week - mon|tue|wed|thu|fri|sat|sun Binding: DaysOfWeek (required) | |
extension | 0..1 | Extension | All day | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
url | 1..1 | "allDay" | ||
valueBoolean | 1..1 | boolean | All day | |
extension | 0..1 | Extension | Available start time | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
url | 1..1 | "availableStartTime" | ||
valueTime | 1..1 | time | Available start time | |
extension | 0..1 | Extension | Available end time | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
url | 1..1 | "availableEndTime" | ||
valueTime | 1..1 | time | Available end time | |
url | 1..1 | "http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime" | ||
system | ΣI | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) |
value | Σ | 1..1 | string | The actual contact point details |
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) |
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
period | Σ | 0..1 | Period | Time period when the contact point was/is in use |
address | 0..1 | Address | Visiting or postal addresses for the contact | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
geolocation | 0..1 | (Complex) | Extension URL: http://hl7.org/fhir/StructureDefinition/geolocation | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
extension | 1..1 | Extension | Latitude with WGS84 datum | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..0 | |||
url | 1..1 | uri | "latitude" | |
valueDecimal | 0..1 | decimal | Value of extension | |
extension | 1..1 | Extension | Longitude with WGS84 datum | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..0 | |||
url | 1..1 | uri | "longitude" | |
valueDecimal | 0..1 | decimal | Value of extension | |
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/geolocation" | |
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required) Example General': home |
type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required) Example General': both |
text | Σ | 0..1 | string | Text representation of the address Example General': 137 Nowhere Street, Erewhon 9132 |
line | Σ | 0..* | string | Street 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..1 | string | Name of city, town etc. Example General': Erewhon |
district | Σ | 0..1 | string | District name (aka county) Example General': Madison |
state | Σ | 0..1 | string | Sub-unit of country (abbreviations ok) |
postalCode | Σ | 0..1 | string | Postal code for area Example General': 9132 |
country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) |
period | Σ | 0..1 | Period | Time 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 | |
Documentation for this format |
Summary
Mandatory: 3 elements (7 nested mandatory elements)
Structures
This structure refers to these other structures:
- http://hl7.org/fhir/uv/vhdir/StructureDefinition/vhdir-organization
- http://hl7.org/fhir/uv/vhdir/StructureDefinition/vhdir-endpoint
Extensions
This structure refers to these extensions:
- http://hl7.org/fhir/uv/vhdir/StructureDefinition/org-description
- http://hl7.org/fhir/uv/vhdir/StructureDefinition/digitalcertificate
- http://hl7.org/fhir/uv/vhdir/StructureDefinition/qualification
- http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction
- http://hl7.org/fhir/uv/vhdir/StructureDefinition/insuranceplan-reference
- http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status
- http://hl7.org/fhir/uv/vhdir/StructureDefinition/org-alias-type
- http://hl7.org/fhir/uv/vhdir/StructureDefinition/org-alias-period
- http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary
- http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
- http://hl7.org/fhir/StructureDefinition/geolocation
Differential View
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Organization | I | 0..* | A grouping of people or organizations with a common purpose | |
id | Σ | 0..1 | id | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: Common Languages (preferred) | |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
org-description | 0..1 | string | Extension 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..* | Extension | Extensions that cannot be ignored |
identifier | ΣI | 0..* | Identifier | Identifies this organization across multiple systems |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
identifier-status | 1..1 | code | Extension URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status Binding: VhDir Identifier Status Value Set (example) | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
url | 1..1 | "http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status" | ||
valueCode | 1..1 | code | active|inactive|issued in error|revoked|pending Binding: VhDir Identifier Status Value Set (example) | |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
system | Σ | 0..1 | uri | The namespace for the identifier value Example General': http://www.acme.com/identifiers/patient |
value | Σ | 0..1 | string | The value that is unique Example General': 123456 |
period | Σ | 0..1 | Period | Time period when id is/was valid for use |
assigner | Σ | 0..1 | Reference(VhDir Organization) | Organization that issued id (may be just text) |
active | ?!Σ | 1..1 | boolean | Whether the organization's record is still in active use |
type | Σ | 1..* | CodeableConcept | Kind of organization Binding: OrganizationType (example) |
name | ΣI | 1..1 | string | Name used for the organization |
alias | 0..* | string | A list of alternate names that the organization is known as, or was known as in the past | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
org-alias-type | 0..1 | Coding | Extension URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/org-alias-type Binding: VhDir Alias Type Value Set (example) | |
org-alias-period | 0..1 | Period | Extension URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/org-alias-period | |
value | 0..1 | Primitive value for string Max Length: 1048576 | ||
telecom | I | 0..* | ContactPoint | A contact detail for the organization |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
contactpoint-viaintermediary | 0..1 | Reference(VhDir Practitionerrole | VhDir Organization | VhDir OrganizationAffiliation | VhDir Location) | Extension URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
url | 1..1 | "http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary" | ||
valueReference | 1..1 | Reference(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..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
extension | 0..* | Extension | Days of week | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
url | 1..1 | "daysOfWeek" | ||
valueCode | 1..1 | code | Days of the week - mon|tue|wed|thu|fri|sat|sun Binding: DaysOfWeek (required) | |
extension | 0..1 | Extension | All day | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
url | 1..1 | "allDay" | ||
valueBoolean | 1..1 | boolean | All day | |
extension | 0..1 | Extension | Available start time | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
url | 1..1 | "availableStartTime" | ||
valueTime | 1..1 | time | Available start time | |
extension | 0..1 | Extension | Available end time | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
url | 1..1 | "availableEndTime" | ||
valueTime | 1..1 | time | Available end time | |
url | 1..1 | "http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime" | ||
system | ΣI | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) |
value | Σ | 1..1 | string | The actual contact point details |
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) |
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
period | Σ | 0..1 | Period | Time period when the contact point was/is in use |
address | I | 0..* | Address | An address for the organization |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
geolocation | 0..1 | (Complex) | Extension URL: http://hl7.org/fhir/StructureDefinition/geolocation | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
extension | 1..1 | Extension | Latitude with WGS84 datum | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..0 | |||
url | 1..1 | uri | "latitude" | |
valueDecimal | 0..1 | decimal | Value of extension | |
extension | 1..1 | Extension | Longitude with WGS84 datum | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..0 | |||
url | 1..1 | uri | "longitude" | |
valueDecimal | 0..1 | decimal | Value of extension | |
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/geolocation" | |
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required) Example General': home |
type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required) Example General': both |
text | Σ | 0..1 | string | Text representation of the address Example General': 137 Nowhere Street, Erewhon 9132 |
line | Σ | 0..* | string | Street 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..1 | string | Name of city, town etc. Example General': Erewhon |
district | Σ | 0..1 | string | District name (aka county) Example General': Madison |
state | Σ | 0..1 | string | Sub-unit of country (abbreviations ok) |
postalCode | Σ | 0..1 | string | Postal code for area Example General': 9132 |
country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) |
period | Σ | 0..1 | Period | Time period when address was/is in use Example General': {"start":"2010-03-23","end":"2010-07-01"} |
partOf | Σ | 0..1 | Reference(VhDir Organization) | The organization of which this organization forms a part |
contact | I | 0..* | BackboneElement | Contact for the organization for a certain purpose |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored if unrecognized |
purpose | 0..1 | CodeableConcept | The type of contact Binding: ContactEntityType (extensible) | |
name | 0..1 | HumanName | A name associated with the contact | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required) |
text | Σ | 0..1 | string | Text representation of the full name |
family | Σ | 1..1 | string | Family name (often called 'Surname') |
given | Σ | 1..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name |
prefix | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name |
suffix | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name |
period | Σ | 0..1 | Period | Time period when name was/is in use |
telecom | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
contactpoint-viaintermediary | 0..1 | Reference(VhDir Practitionerrole | VhDir Organization | VhDir OrganizationAffiliation | VhDir Location) | Extension URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
url | 1..1 | "http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary" | ||
valueReference | 1..1 | Reference(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..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
extension | 0..* | Extension | Days of week | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
url | 1..1 | "daysOfWeek" | ||
valueCode | 1..1 | code | Days of the week - mon|tue|wed|thu|fri|sat|sun Binding: DaysOfWeek (required) | |
extension | 0..1 | Extension | All day | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
url | 1..1 | "allDay" | ||
valueBoolean | 1..1 | boolean | All day | |
extension | 0..1 | Extension | Available start time | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
url | 1..1 | "availableStartTime" | ||
valueTime | 1..1 | time | Available start time | |
extension | 0..1 | Extension | Available end time | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
url | 1..1 | "availableEndTime" | ||
valueTime | 1..1 | time | Available end time | |
url | 1..1 | "http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime" | ||
system | ΣI | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) |
value | Σ | 1..1 | string | The actual contact point details |
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) |
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
period | Σ | 0..1 | Period | Time period when the contact point was/is in use |
address | 0..1 | Address | Visiting or postal addresses for the contact | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
geolocation | 0..1 | (Complex) | Extension URL: http://hl7.org/fhir/StructureDefinition/geolocation | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
extension | 1..1 | Extension | Latitude with WGS84 datum | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..0 | |||
url | 1..1 | uri | "latitude" | |
valueDecimal | 0..1 | decimal | Value of extension | |
extension | 1..1 | Extension | Longitude with WGS84 datum | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..0 | |||
url | 1..1 | uri | "longitude" | |
valueDecimal | 0..1 | decimal | Value of extension | |
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/geolocation" | |
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required) Example General': home |
type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required) Example General': both |
text | Σ | 0..1 | string | Text representation of the address Example General': 137 Nowhere Street, Erewhon 9132 |
line | Σ | 0..* | string | Street 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..1 | string | Name of city, town etc. Example General': Erewhon |
district | Σ | 0..1 | string | District name (aka county) Example General': Madison |
state | Σ | 0..1 | string | Sub-unit of country (abbreviations ok) |
postalCode | Σ | 0..1 | string | Postal code for area Example General': 9132 |
country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) |
period | Σ | 0..1 | Period | Time 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 | |
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
-
GET [base]/Organization?active=[code]
Support: SHALL support search by the
active
parameter:http://hl7.org/fhir/SearchParameter/Organization-active
-
GET [base]/Organization?address-use=[code]
Support: MAY support search by the
address-use
parameter:http://hl7.org/fhir/SearchParameter/Organization-address-use
-
GET [base]/Organization?organization-address=[string]
Support: SHALL support search by the
organization-address
parameter- including the modifiers:
contains
,exact
- including the modifiers:
-
GET [base]/Organization?organiztion-address-city=[string]
Support: SHOULD support search by the
organization-address-city
parameter- including the modifiers:
exact
- including the modifiers:
-
GET [base]/Organization?organization-address-country=[string]
Support: SHOULD support search by the
organization-address-country
parameter- including the modifiers:
exact
- including the modifiers:
-
GET [base]/Organization?organization-address-postalcode=[string]
Support: SHOULD support search by the
organization-address-postalcode
parameter- including the modifiers:
exact
- including the modifiers:
-
GET [base]/Organization?organization-address-state=[string]
Support: SHOULD support search by the
organization-address-state
parameter- including the modifiers:
exact
- including the modifiers:
-
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
- with a target type:
-
GET [base]/Organization?organization-identifier=[code]
Support: SHALL support search by the
organization-identifier
parameter- including the modifiers:
text
,ofType
- including the modifiers:
-
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
- with a target type:
-
GET [base]/Organization?organization-name=[string]
Support: SHALL support search by the
organization-name
parameter- including the modifiers:
exact
,contains
- including the modifiers:
-
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
- with a target type:
-
GET [base]/Organization?organization-qualification-code=[code]
Support: SHOULD support search by the
organization-qualification-code
parameter- including the modifiers:
text
- including the modifiers:
-
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
- with a target type:
-
GET [base]/Organization?organization-qualification-status=[code]
Support: SHOULD support search by the
organization-qualification-status
parameter
-
GET [base]/Organization?organization-qualification-wherevalid-code=[code]
Support: SHOULD support search by the
organization-qualification-wherevalid-code
parameter- including the modifiers:
text
- including the modifiers:
-
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
- with a target type:
-
GET [base]/Organization?organization-type=[code]
Support: SHALL support search by the
type
parameter- including the modifiers:
text
- including the modifiers:
-
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
- with a target type: