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-organizationRole - Content

This profile sets minimum expectations for searching for and fetching information associated with an organization role. It identifies which core elements, extensions, vocabularies and value sets SHALL be present in the organizationRole resource when using this profile.

Background & Scope

We propose the creation of a new organizationRole resource to describe relationships between two or more organizations. OrganizationRole describes the role an organization plays at an organization, including the services they provide, the location(s) where they provide services, and their availability, electronic endpoints, and other relevant information.

OrganizationRole addresses the need to define a non-hierarchical relationship between two or more organizations. For example:

  • One organization may provide services to another organization
  • Two or more organizations may form a partnership or joint venture
  • An organization may be a member of another organization, but not owned by it (e.g. a hospital is a member the American Hospital Association, a hospital is a member of a health information exchange network)

OrganizationRole is similar in form and function to practitionerRole. Instead of references to practitioner and organization (as in practitionerRole), organizationRole includes references to a participatingOrg and a primaryOrg. The participating organization provides “services” to the primary organization (much like a practitioner provides services to an organization). Using the three examples above:

  • The participating organization provides services to the primary organization
  • The joint venture is considered the primary organization, and partners within the joint venture are considered participating organizations
  • An association is the primary organization, and its members are participating organizations.

As with practitionerRole, organizationRole provides the link between an organization and a health insurance provider network.

Examples:

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

  • TBD

Mandatory Data Elements

No mandatory elements in the proposed organizationRole Resource. The Formal Profile Definition below provides the formal summary, definitions, and terminology requirements.

Profile specific implementation guidance:

  • TBD

Extensions:

  1. Restriction (0..*) - indicates restrictions on the use/release of information associated with an organization role

Terminology

TBD

1.2 - Formal Views of Profile Content

The official URL for this profile is: 

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

Details about the role a participating organization plays in relation to a primary organization

This profile builds on OrganizationRole.

This profile was published on Sat Dec 09 07:32:24 AEDT 2017 as a draft by null.

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

Complete Summary of the Mandatory Requirements

  1. A boolean value in practitionerRole.active
  2. At least one value describing the role the practitioner performs in practitionerRole.code
  3. For each indication of whether the practitioner is accepting new patients in thier role, one boolean value in practitionerRole.newPatients.acceptingPatients (extension)
NameFlagsCard.TypeDescription & Constraintsdoco
.. OrganizationRole I0..*Roles/organizations the practitioner is associated with
... id SΣ0..1idLogical id of this artifact
... meta SΣ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text SI0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness Identifiers that are specific to a role/location
.... 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 Σ0..1booleanWhether this practitioner role record is in active use
... period Σ0..1PeriodThe period during which the practitioner is authorized to perform in these role(s)
... organization Σ0..1Reference(Organization)Organization where the roles are available
... participatingOrganization Σ0..1Reference(Organization)Practitioner that is able to provide the defined services for the organization
... network Σ0..*Reference(Organization)The network(s) this association applies to
... code Σ0..*CodeableConceptRoles which this practitioner may perform
Binding: OrganizationRole (example)
... specialty Σ0..*CodeableConceptSpecific specialty of the practitioner
Binding: Practice Setting Code Value Set (preferred)
... location Σ0..*Reference(Location)The location(s) at which this practitioner provides care
... healthcareService 0..*Reference(HealthcareService)The list of healthcare services that this worker provides for this role's Organization/Location(s)
... telecom Σ0..*ContactPointContact details that are specific to the role/location/service
.... id 0..1stringxml:id (or equivalent in JSON)
.... 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"
.... contactPoint-viaIntermediary 0..1Reference(vhdir-practitioner), Reference(vhdir-organization), Reference(vhdir-location)Extension
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/contactPoint-viaIntermediary
.... 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
... availableTime I0..*BackboneElementTimes the Service Site is available
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... daysOfWeek 0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required)
.... allDay 0..1booleanAlways available? e.g. 24 hour service
.... availableStartTime 0..1timeOpening time of day (ignored if allDay = true)
.... availableEndTime 0..1timeClosing time of day (ignored if allDay = true)
... notAvailable I0..*BackboneElementNot available during this time due to provided reason
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... description 1..1stringReason presented to the user explaining why time not available
.... during 0..1PeriodService not available from this date
... availabilityExceptions 0..1stringDescription of availability exceptions
... endpoint 0..*Reference(Endpoint)Technical endpoints providing access to services operated for the practitioner with this role

doco Documentation for this format

Complete Summary of the Mandatory Requirements

  1. A boolean value in practitionerRole.active
  2. At least one value describing the role the practitioner performs in practitionerRole.code
  3. For each indication of whether the practitioner is accepting new patients in thier role, one boolean value in practitionerRole.newPatients.acceptingPatients (extension)

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. OrganizationRole I0..*Roles/organizations the practitioner is associated with
... id SΣ0..1idLogical id of this artifact
... meta SΣ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text SI0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness Identifiers that are specific to a role/location
.... 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 Σ0..1booleanWhether this practitioner role record is in active use
... period Σ0..1PeriodThe period during which the practitioner is authorized to perform in these role(s)
... organization Σ0..1Reference(Organization)Organization where the roles are available
... participatingOrganization Σ0..1Reference(Organization)Practitioner that is able to provide the defined services for the organization
... network Σ0..*Reference(Organization)The network(s) this association applies to
... code Σ0..*CodeableConceptRoles which this practitioner may perform
Binding: OrganizationRole (example)
... specialty Σ0..*CodeableConceptSpecific specialty of the practitioner
Binding: Practice Setting Code Value Set (preferred)
... location Σ0..*Reference(Location)The location(s) at which this practitioner provides care
... healthcareService 0..*Reference(HealthcareService)The list of healthcare services that this worker provides for this role's Organization/Location(s)
... telecom Σ0..*ContactPointContact details that are specific to the role/location/service
.... id 0..1stringxml:id (or equivalent in JSON)
.... 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"
.... contactPoint-viaIntermediary 0..1Reference(vhdir-practitioner), Reference(vhdir-organization), Reference(vhdir-location)Extension
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/contactPoint-viaIntermediary
.... 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
... availableTime I0..*BackboneElementTimes the Service Site is available
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... daysOfWeek 0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required)
.... allDay 0..1booleanAlways available? e.g. 24 hour service
.... availableStartTime 0..1timeOpening time of day (ignored if allDay = true)
.... availableEndTime 0..1timeClosing time of day (ignored if allDay = true)
... notAvailable I0..*BackboneElementNot available during this time due to provided reason
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... description 1..1stringReason presented to the user explaining why time not available
.... during 0..1PeriodService not available from this date
... availabilityExceptions 0..1stringDescription of availability exceptions
... endpoint 0..*Reference(Endpoint)Technical endpoints providing access to services operated for the practitioner with this role

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.

TBD