Medtech ALEX® Implementation Guide
0.0.1 - draft
Medtech ALEX® Implementation Guide
0.0.1 - draft
Medtech ALEX® Implementation Guide - Local Development build (v0.0.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/alex-address | Version: 0.0.1 | |||
| Active as of 2025-01-20 | Computable Name: AlexAddress | |||
The address that conforms to Medtech PMS address structure
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Address |
0..* | Address | An address expressed using postal conventions (as opposed to GPS or other location definition formats) ele-1: All FHIR elements must have a @value or children | |
  use |
?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. ele-1: All FHIR elements must have a @value or children Example General: home |
| type |
SΣ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). ele-1: All FHIR elements must have a @value or children Example General: both |
| line |
SΣ | 1..3 | string | Street name, number, direction & P.O. Box etc. ele-1: All FHIR elements must have a @value or children This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street |
| state |
SΣ | 0..1 | string | Sub-unit of country (abbreviations ok) ele-1: All FHIR elements must have a @value or children |
| postalCode |
SΣ | 0..1 | string | Postal code for area ele-1: All FHIR elements must have a @value or children Example General: 9132 |
 country |
SΣ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) ele-1: All FHIR elements must have a @value or children |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Address.use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1from the FHIR Standard | |
| Address.type | required | AddressTypehttp://hl7.org/fhir/ValueSet/address-type|4.0.1from 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()) |
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) | |
| type |
S | 0..1 | code | postal | physical | both |
| line |
S | 1..3 | string | Street name, number, direction & P.O. Box etc. |
| state |
S | 0..1 | string | Sub-unit of country (abbreviations ok) |
| postalCode |
S | 0..1 | string | Postal code for area |
| country |
S | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) |
| 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) | |
| id |
0..1 | string | Unique id for inter-element referencing | |
 extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| use |
?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
| type |
SΣ | 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 |
SΣ | 1..3 | 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 |
SΣ | 0..1 | string | Sub-unit of country (abbreviations ok) |
| postalCode |
SΣ | 0..1 | string | Postal code for area Example General: 9132 |
| country |
SΣ | 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.use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1from the FHIR Standard | |
| Address.type | required | AddressTypehttp://hl7.org/fhir/ValueSet/address-type|4.0.1from 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
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) ele-1: All FHIR elements must have a @value or children | |
| use |
?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. ele-1: All FHIR elements must have a @value or children Example General: home |
| type |
SΣ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). ele-1: All FHIR elements must have a @value or children Example General: both |
| line |
SΣ | 1..3 | string | Street name, number, direction & P.O. Box etc. ele-1: All FHIR elements must have a @value or children This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street |
| state |
SΣ | 0..1 | string | Sub-unit of country (abbreviations ok) ele-1: All FHIR elements must have a @value or children |
| postalCode |
SΣ | 0..1 | string | Postal code for area ele-1: All FHIR elements must have a @value or children Example General: 9132 |
| country |
SΣ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) ele-1: All FHIR elements must have a @value or children |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Address.use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1from the FHIR Standard | |
| Address.type | required | AddressTypehttp://hl7.org/fhir/ValueSet/address-type|4.0.1from 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()) |
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) | |
| type |
S | 0..1 | code | postal | physical | both |
| line |
S | 1..3 | string | Street name, number, direction & P.O. Box etc. |
| state |
S | 0..1 | string | Sub-unit of country (abbreviations ok) |
| postalCode |
S | 0..1 | string | Postal code for area |
| country |
S | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) |
| Documentation for this format | ||||
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 | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| use |
?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
| type |
SΣ | 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 |
SΣ | 1..3 | 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 |
SΣ | 0..1 | string | Sub-unit of country (abbreviations ok) |
| postalCode |
SΣ | 0..1 | string | Postal code for area Example General: 9132 |
| country |
SΣ | 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.use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1from the FHIR Standard | |
| Address.type | required | AddressTypehttp://hl7.org/fhir/ValueSet/address-type|4.0.1from 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
Other representations of profile: CSV, Excel, Schematron