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: boundary - Content

An extension to describe a custom area or region. Provides the ability to represent shapes/polygons rather than a geographic point.

Consists of a URI pointing to a KML or GeoJSON file and/or the colloquial name of the region (e.g. “Down East Maine”).

Boundary is an extension to the location and healthcareService resources.

1.2 - Formal Views of Profile Content

The official URL for this profile is: 

http://hl7.org/fhir/ig/vhdir/StructureDefinition/boundary

Representation of a custom area or region

This profile builds on Extension.

This profile was published on Thu Nov 09 01:55:55 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. One URI for a KML or GeoJSON file in boundary.region
  2. boundary.localName should only be used to provide the colloquial name(s)/description(s) of the identified region, if applicable
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*Boundary
... url 1..1uri"http://hl7.org/fhir/ig/vhdir/StructureDefinition/boundary"
... value[x] 0..0
... extension 1..1ExtensionRepresents a custom area or region
.... url 1..1uri"region"
.... valueUri 0..1uriCustom area or region
... extension 0..*ExtensionFriendly description
.... url 1..1uri"localName"
.... valueString 0..1stringDescription

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension I0..*Boundary
... id 0..1stringxml:id (or equivalent in JSON)
... extension 1..1ExtensionRepresents a custom area or region
.... id 0..1stringxml:id (or equivalent in JSON)
.... url 1..1uri"region"
.... valueUri 0..1uriCustom area or region
... extension 0..*ExtensionFriendly description
.... id 0..1stringxml:id (or equivalent in JSON)
.... url 1..1uri"localName"
.... valueString 0..1stringDescription
... url 1..1uri"http://hl7.org/fhir/ig/vhdir/StructureDefinition/boundary"

doco Documentation for this format

Complete Summary of the Mandatory Requirements

  1. One URI for a KML or GeoJSON file in boundary.region
  2. boundary.localName should only be used to provide the colloquial name(s)/description(s) of the identified region, if applicable

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*Boundary
... url 1..1uri"http://hl7.org/fhir/ig/vhdir/StructureDefinition/boundary"
... value[x] 0..0
... extension 1..1ExtensionRepresents a custom area or region
.... url 1..1uri"region"
.... valueUri 0..1uriCustom area or region
... extension 0..*ExtensionFriendly description
.... url 1..1uri"localName"
.... valueString 0..1stringDescription

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension I0..*Boundary
... id 0..1stringxml:id (or equivalent in JSON)
... extension 1..1ExtensionRepresents a custom area or region
.... id 0..1stringxml:id (or equivalent in JSON)
.... url 1..1uri"region"
.... valueUri 0..1uriCustom area or region
... extension 0..*ExtensionFriendly description
.... id 0..1stringxml:id (or equivalent in JSON)
.... url 1..1uri"localName"
.... valueString 0..1stringDescription
... url 1..1uri"http://hl7.org/fhir/ig/vhdir/StructureDefinition/boundary"

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.

No Search criteria for boundary extension.