JohnMoehrke PHR FHIR API
0.5.2 - ci-build
JohnMoehrke PHR FHIR API
0.5.2 - ci-build
JohnMoehrke PHR FHIR API, published by John Moehrke (himself). This guide is not an authorized publication; it is the continuous build for version 0.5.2 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/JohnMoehrke/phr/ and changes regularly. See the Directory of published versions
| Official URL: http://johnmoehrke.github.io/phr/StructureDefinition/JFM.PHR.location | Version: 0.5.2 | |||
| Standards status: Trial-use | Maturity Level: 3 | Computable Name: JFMlocation | ||
A profile on the Location resource for MHV PHR exposing Location using FHIR API.
identifier
name is the name as knownNOT USING Mapping to VIA HospitalLocationTO.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Location |
0..* | USCoreLocation | Details and position information for a physical place dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
 Slices for identifier |
Σ | 1..* | Identifier | Unique code or number identifying the location to its users Slice: Unordered, Open by value:use ele-1: All FHIR elements must have a @value or children |
   identifier:TOid |
Σ | 1..1 | Identifier | Unique code or number identifying the location to its users ele-1: All FHIR elements must have a @value or children |
  use |
?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children Required Pattern: usual |
| system |
ΣC | 0..1 | uri | urn:oid:2.16.840.1.113883.4.349.4.{stationNbr} ele-1: All FHIR elements must have a @value or children TOid-startswithoid: ID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr} Example General: http://www.acme.com/identifiers/patient |
 value |
Σ | 0..1 | string | `HospitalLocationTO` | `.` | {HospitalLocationTO.id} ele-1: All FHIR elements must have a @value or children Example General: 123456 |
| name |
SΣ | 1..1 | string | Name of the location as used by humans ele-1: All FHIR elements must have a @value or children |
 alias |
0..1 | string | A list of alternate names that the location is known as, or was known as, in the past ele-1: All FHIR elements must have a @value or children | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Location.identifier:TOid.use | required | Pattern: usualhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| Location.address.use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1from the FHIR Standard | |
| Location.address.state | extensible | UspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state |
| Id | Grade | Path(s) | Details | Requirements |
| TOid-startswithoid | error | Location.identifier:TOid.system | ID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr} : value.startsWith('urn:oid:2.16.840.1.113883.4.349.4.') |
This structure is derived from USCoreLocation
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Location |
0..* | USCoreLocation | Details and position information for a physical place | |
| Slices for identifier |
1..* | Identifier | Unique code or number identifying the location to its users Slice: Unordered, Open by value:use | |
| identifier:TOid |
1..1 | Identifier | Unique code or number identifying the location to its users | |
 use |
1..1 | code | usual | official | temp | secondary | old (If known) Required Pattern: usual | |
| system |
C | 0..1 | uri | urn:oid:2.16.840.1.113883.4.349.4.{stationNbr} TOid-startswithoid: ID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr} |
| value |
0..1 | string | `HospitalLocationTO` | `.` | {HospitalLocationTO.id} | |
| status |
0..0 | |||
| operationalStatus |
0..0 | |||
| name |
1..1 | string | Name of the location as used by humans | |
| alias |
0..1 | string | A list of alternate names that the location is known as, or was known as, in the past | |
| description |
0..0 | |||
| mode |
0..0 | |||
| type |
0..0 | |||
| telecom |
0..0 | |||
| address |
0..0 | |||
| physicalType |
0..0 | |||
| position |
0..0 | |||
| managingOrganization |
0..0 | |||
| partOf |
0..0 | |||
| hoursOfOperation |
0..0 | |||
| availabilityExceptions |
0..0 | |||
| endpoint |
0..0 | |||
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| TOid-startswithoid | error | Location.identifier:TOid.system | ID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr} : value.startsWith('urn:oid:2.16.840.1.113883.4.349.4.') |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Location |
0..* | USCoreLocation | Details and position information for a physical place | |||||
| 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: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
 extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| Slices for identifier |
Σ | 1..* | Identifier | Unique code or number identifying the location to its users Slice: Unordered, Open by value:use | ||||
| identifier:TOid |
Σ | 1..1 | Identifier | Unique code or number identifying the location to its users | ||||
| 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 |
?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: usual | ||||
| type |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system |
ΣC | 0..1 | uri | urn:oid:2.16.840.1.113883.4.349.4.{stationNbr} TOid-startswithoid: ID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr} Example General: http://www.acme.com/identifiers/patient | ||||
| value |
Σ | 0..1 | string | `HospitalLocationTO` | `.` | {HospitalLocationTO.id} Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
 assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| name |
SΣ | 1..1 | string | Name of the location as used by humans | ||||
| alias |
0..1 | string | A list of alternate names that the location is known as, or was known as, in the past | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Location.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| Location.identifier:TOid.use | required | Pattern: usualhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | ||||
| Location.identifier:TOid.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | ||||
| Location.address.use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1from the FHIR Standard | ||||
| Location.address.type | required | AddressTypehttp://hl7.org/fhir/ValueSet/address-type|4.0.1from the FHIR Standard | ||||
| Location.address.state | extensible | UspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state | ||||
| Location.hoursOfOperation.daysOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| TOid-startswithoid | error | Location.identifier:TOid.system | ID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr} : value.startsWith('urn:oid:2.16.840.1.113883.4.349.4.') |
This structure is derived from USCoreLocation
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Location |
0..* | USCoreLocation | Details and position information for a physical place dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| Slices for identifier |
Σ | 1..* | Identifier | Unique code or number identifying the location to its users Slice: Unordered, Open by value:use ele-1: All FHIR elements must have a @value or children |
| identifier:TOid |
Σ | 1..1 | Identifier | Unique code or number identifying the location to its users ele-1: All FHIR elements must have a @value or children |
| use |
?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children Required Pattern: usual |
| system |
ΣC | 0..1 | uri | urn:oid:2.16.840.1.113883.4.349.4.{stationNbr} ele-1: All FHIR elements must have a @value or children TOid-startswithoid: ID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr} Example General: http://www.acme.com/identifiers/patient |
| value |
Σ | 0..1 | string | `HospitalLocationTO` | `.` | {HospitalLocationTO.id} ele-1: All FHIR elements must have a @value or children Example General: 123456 |
| name |
SΣ | 1..1 | string | Name of the location as used by humans ele-1: All FHIR elements must have a @value or children |
| alias |
0..1 | string | A list of alternate names that the location is known as, or was known as, in the past ele-1: All FHIR elements must have a @value or children | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Location.identifier:TOid.use | required | Pattern: usualhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| Location.address.use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1from the FHIR Standard | |
| Location.address.state | extensible | UspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state |
| Id | Grade | Path(s) | Details | Requirements |
| TOid-startswithoid | error | Location.identifier:TOid.system | ID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr} : value.startsWith('urn:oid:2.16.840.1.113883.4.349.4.') |
Differential View
This structure is derived from USCoreLocation
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Location |
0..* | USCoreLocation | Details and position information for a physical place | |
| Slices for identifier |
1..* | Identifier | Unique code or number identifying the location to its users Slice: Unordered, Open by value:use | |
| identifier:TOid |
1..1 | Identifier | Unique code or number identifying the location to its users | |
| use |
1..1 | code | usual | official | temp | secondary | old (If known) Required Pattern: usual | |
| system |
C | 0..1 | uri | urn:oid:2.16.840.1.113883.4.349.4.{stationNbr} TOid-startswithoid: ID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr} |
| value |
0..1 | string | `HospitalLocationTO` | `.` | {HospitalLocationTO.id} | |
| status |
0..0 | |||
| operationalStatus |
0..0 | |||
| name |
1..1 | string | Name of the location as used by humans | |
| alias |
0..1 | string | A list of alternate names that the location is known as, or was known as, in the past | |
| description |
0..0 | |||
| mode |
0..0 | |||
| type |
0..0 | |||
| telecom |
0..0 | |||
| address |
0..0 | |||
| physicalType |
0..0 | |||
| position |
0..0 | |||
| managingOrganization |
0..0 | |||
| partOf |
0..0 | |||
| hoursOfOperation |
0..0 | |||
| availabilityExceptions |
0..0 | |||
| endpoint |
0..0 | |||
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| TOid-startswithoid | error | Location.identifier:TOid.system | ID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr} : value.startsWith('urn:oid:2.16.840.1.113883.4.349.4.') |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Location |
0..* | USCoreLocation | Details and position information for a physical place | |||||
| 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: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| Slices for identifier |
Σ | 1..* | Identifier | Unique code or number identifying the location to its users Slice: Unordered, Open by value:use | ||||
| identifier:TOid |
Σ | 1..1 | Identifier | Unique code or number identifying the location to its users | ||||
| 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 |
?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: usual | ||||
| type |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system |
ΣC | 0..1 | uri | urn:oid:2.16.840.1.113883.4.349.4.{stationNbr} TOid-startswithoid: ID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr} Example General: http://www.acme.com/identifiers/patient | ||||
| value |
Σ | 0..1 | string | `HospitalLocationTO` | `.` | {HospitalLocationTO.id} Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| name |
SΣ | 1..1 | string | Name of the location as used by humans | ||||
| alias |
0..1 | string | A list of alternate names that the location is known as, or was known as, in the past | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Location.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| Location.identifier:TOid.use | required | Pattern: usualhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | ||||
| Location.identifier:TOid.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | ||||
| Location.address.use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1from the FHIR Standard | ||||
| Location.address.type | required | AddressTypehttp://hl7.org/fhir/ValueSet/address-type|4.0.1from the FHIR Standard | ||||
| Location.address.state | extensible | UspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state | ||||
| Location.hoursOfOperation.daysOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| TOid-startswithoid | error | Location.identifier:TOid.system | ID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr} : value.startsWith('urn:oid:2.16.840.1.113883.4.349.4.') |
This structure is derived from USCoreLocation
Other representations of profile: CSV, Excel, Schematron