BC Provider Location Registry FHIR Implementation Guide
1.0.0 - fhirVersion-4.0; BCPLRVersion=1
BC Provider Location Registry FHIR Implementation Guide - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Official URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-address | Version: 1.0.0 | |||
Active as of 2024-04-28 | Computable Name: BCAddress |
Adds an end reason, communication purpose and validation status to the address.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Address
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Address | 0..* | Address | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |
endReason | S | 0..1 | CodeableConcept | BC End Reason Extension URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-end-reason-extension Binding: BC End Reason Value Set (required) |
owner | S | 0..1 | Identifier | BC Owner Extension URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-owner-extension |
commPurposeExtension | S | 0..1 | CodeableConcept | BC Communication Purpose Extension URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-communication-purpose-code-extension Binding: BC Communication Purpose Value Set (required) |
validationStatus | S | 0..1 | CodeableConcept | BC Address Validation Extension URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-address-validation-status-extension Binding: BC Address Validation Status Value Set (required) |
use | 0..0 | |||
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Address | 0..* | Address | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |
endReason | S | 0..1 | CodeableConcept | BC End Reason Extension URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-end-reason-extension Binding: BC End Reason Value Set (required) |
owner | S | 0..1 | Identifier | BC Owner Extension URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-owner-extension |
commPurposeExtension | S | 0..1 | CodeableConcept | BC Communication Purpose Extension URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-communication-purpose-code-extension Binding: BC Communication Purpose Value Set (required) |
validationStatus | S | 0..1 | CodeableConcept | BC Address Validation Extension URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-address-validation-status-extension Binding: BC Address Validation Status Value Set (required) |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Address | 0..* | Address | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
endReason | S | 0..1 | CodeableConcept | BC End Reason Extension URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-end-reason-extension Binding: BC End Reason Value Set (required) |
owner | S | 0..1 | Identifier | BC Owner Extension URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-owner-extension |
commPurposeExtension | S | 0..1 | CodeableConcept | BC Communication Purpose Extension URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-communication-purpose-code-extension Binding: BC Communication Purpose Value Set (required) |
validationStatus | S | 0..1 | CodeableConcept | BC Address Validation Extension URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-address-validation-status-extension Binding: BC Address Validation Status Value Set (required) |
type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). 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"} |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Address.type | required | AddressTypehttp://hl7.org/fhir/ValueSet/address-type|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Address
Differential View
This structure is derived from Address
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Address | 0..* | Address | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |
endReason | S | 0..1 | CodeableConcept | BC End Reason Extension URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-end-reason-extension Binding: BC End Reason Value Set (required) |
owner | S | 0..1 | Identifier | BC Owner Extension URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-owner-extension |
commPurposeExtension | S | 0..1 | CodeableConcept | BC Communication Purpose Extension URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-communication-purpose-code-extension Binding: BC Communication Purpose Value Set (required) |
validationStatus | S | 0..1 | CodeableConcept | BC Address Validation Extension URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-address-validation-status-extension Binding: BC Address Validation Status Value Set (required) |
use | 0..0 | |||
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Address | 0..* | Address | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |
endReason | S | 0..1 | CodeableConcept | BC End Reason Extension URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-end-reason-extension Binding: BC End Reason Value Set (required) |
owner | S | 0..1 | Identifier | BC Owner Extension URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-owner-extension |
commPurposeExtension | S | 0..1 | CodeableConcept | BC Communication Purpose Extension URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-communication-purpose-code-extension Binding: BC Communication Purpose Value Set (required) |
validationStatus | S | 0..1 | CodeableConcept | BC Address Validation Extension URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-address-validation-status-extension Binding: BC Address Validation Status Value Set (required) |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Address | 0..* | Address | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
endReason | S | 0..1 | CodeableConcept | BC End Reason Extension URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-end-reason-extension Binding: BC End Reason Value Set (required) |
owner | S | 0..1 | Identifier | BC Owner Extension URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-owner-extension |
commPurposeExtension | S | 0..1 | CodeableConcept | BC Communication Purpose Extension URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-communication-purpose-code-extension Binding: BC Communication Purpose Value Set (required) |
validationStatus | S | 0..1 | CodeableConcept | BC Address Validation Extension URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-address-validation-status-extension Binding: BC Address Validation Status Value Set (required) |
type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). 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"} |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Address.type | required | AddressTypehttp://hl7.org/fhir/ValueSet/address-type|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Address
Cannot invoke "Object.hashCode()" because "key" is null
Other representations of profile: CSV, Excel, Schematron