ARCHETYPE Address (openEHR-EHR-CLUSTER.address.v0)

ARCHETYPE IDopenEHR-EHR-CLUSTER.address.v0
ConceptAddress
DescriptionA physical or postal address for use within a health record.
UseUse to record details about a physical or postal address required as part of clinical recording within a health record. Examples include: - the address of an attending home care organisation in a referral to another healthcare provider; or - the address of a person or organisation that holds a physical copy of an advance care directive; or - the address of a location of a fall or accident. The scope of this archetype has been constrained to carry only the most common components for a simple address. More detailed address components are included in the CLUSTER.structured_address archetype, designed to nest in the 'Structured address' SLOT within this archetype. In most common use cases where an address needs to be included within a health record, free text entry within one or more 'Unstructured address' elements will be sufficient to record a simple address. In situations when finer-grained detail about one or more address components is required, use the additional structured data elements in the CLUSTER.structured address archetype. If the CLUSTER.structured_address archetype is nested within the 'Structured address' SLOT, any or all of the structured name elements can be concatenated and represented in the 'Unstructured address' element. This archetype could also be used as a proxy for formal demographic data when reviewing a template with domain experts - for example, an assessment where reviewers would expect to see an address within an assessment form. This CLUSTER.address could also be used as a proxy for an address in formal demographic address data when reviewing a template with clinicians - for example, an assessment where reviewers would expect to see the individual's full contact details at the top of the assessment form.
MisuseNot to be used to record an address as part of maintaining an official demographic register or index. Use a formal Master Patient Index or Health Provider Index for this purpose, or archetypes based on the openEHR Demographic Information Model.
PurposeTo record details about a physical or postal address for use within a health record.
ReferencesHealth Care Client Identification - AS 5017-2006. New South Wales (AU): Standards Australia; 2006.

Health Care Provider Identification - AS 4846-2006. New South Wales (AU): Standards Australia; 2006.

Health informatics — Identification of subjects of health care - ISO/TS 22220:2007. Geneva: International Organization for Standardization; 2007.

HL7 FHIR Resource - Person v4.0.1: R4 [Internet]. Health Level Seven International; [accessed 2021 05 04]. Available from: http://hl7.org/fhir/2021May/person.html.

HL7 FHIR Resource - Organization v4.0.1: R4 [Internet]. Health Level Seven International; [accessed 2021 05 04]. Available from: http://hl7.org/fhir/2021May/organization.html
AuthorsAuthor name: Heather Leslie
Organisation: Atomica Informatics
Email: heather.leslie@atomicainformatics.com
Date originally authored: 2021-04-14
Other Details LanguageAuthor name: Heather Leslie
Organisation: Atomica Informatics
Email: heather.leslie@atomicainformatics.com
Date originally authored: 2021-04-14
OtherDetails Language Independent{licence=This work is licensed under the Creative Commons Attribution-ShareAlike 4.0 International License. To view a copy of this license, visit http://creativecommons.org/licenses/by-sa/4.0/., custodian_organisation=openEHR Foundation, references=Health Care Client Identification - AS 5017-2006. New South Wales (AU): Standards Australia; 2006. Health Care Provider Identification - AS 4846-2006. New South Wales (AU): Standards Australia; 2006. Health informatics — Identification of subjects of health care - ISO/TS 22220:2007. Geneva: International Organization for Standardization; 2007. HL7 FHIR Resource - Person v4.0.1: R4 [Internet]. Health Level Seven International; [accessed 2021 05 04]. Available from: http://hl7.org/fhir/2021May/person.html. HL7 FHIR Resource - Organization v4.0.1: R4 [Internet]. Health Level Seven International; [accessed 2021 05 04]. Available from: http://hl7.org/fhir/2021May/organization.html, original_namespace=org.openehr, original_publisher=openEHR Foundation, custodian_namespace=org.openehr, MD5-CAM-1.0.1=8C2C056384179DB2FC5B1660934B5B12, build_uid=72566cf8-2fa4-4ab5-9bd0-522bba720d8f, revision=0.0.1-alpha}
Keywordsaddress, postal, mailing, home, business, physical
Lifecyclein_development
UID2790f093-d7dc-4ee8-8236-881f853ec9b7
Language useden
Citeable Identifier1013.1.273
Revision Number0.0.1-alpha
AllArchetype [runtimeNameConstraintForConceptName=null, archetypeConceptBinding=null, archetypeConceptDescription=A physical or postal address for use within a health record., archetypeConceptComment=null, otherContributors=, originalLanguage=en, translators=German: Natalia Strauch, Medizinische Hochschule Hannover, Strauch.Natalia@mh-hannover.de
Norwegian Bokmål: Liv Laugen, John Tore Valand, ​Oslo University Hospital, Norway, Helse Bergen, liv.laugen@ous-hf.no, john.tore.valand@helse-bergen.no, john.tore.valand@helse-vest-ikt.no
, subjectOfData=unconstrained, archetypeTranslationTree=null, topLevelToAshis={credentials=[], details=[], source=[], description=[], protocol=[], content=[], state=[], identities=[], events=[], relationships=[], data=[], contacts=[], capabilities=[], target=[], ism_transition=[], items=[ResourceSimplifiedHierarchyItem [path=/items[at0001], code=at0001, itemType=ELEMENT, level=1, text=Type, description=The type of address., comment=For example: physical or postal., uncommonOntologyItems=null, occurencesFormal=0..1, occurencesText=Optional, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=DV_CODED_TEXT, bindings=null, values=
  • Physical [A physical location that can be visited.]
  • Postal [Address used as a destination for mailing letters or parcels.]
  • Both [Address of a physical location, also used as a destination for mail.]
, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/items[at0005], code=at0005, itemType=ELEMENT, level=1, text=Use, description=The primary purpose or use for the address., comment=null, uncommonOntologyItems=null, occurencesFormal=0..1, occurencesText=Optional, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=CHOICE, bindings=null, values=Choice of:
  •  Coded Text
    • Business [Address of the physical location of a business or office.]
    • Residential [Address of where a person is living on a regular basis.]
    • Temporary accommodation [Address of where a person is living on a temporary basis.]
  •  Text
, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/items[at0009], code=at0009, itemType=ELEMENT, level=1, text=Address, description=The unstructured address of the person or organisation., comment=This address line represents a low level of geographical/physical description of a location that, used in conjunction with the other high-level address components i.e. ‘Suburb/Town/Locality’, ‘Postcode’, and ‘State/Territory/Province’, forms a complete geographical/physical address. This data element can be used to represent a landmark, such as "The second house north of the general store" or "At the corner of Smith & Brown Streets. The content of this data element may be derived from a concatenation of one or more components from CLUSTER.structured_address. Multiple occurrences allow for as many 'Address' lines, as required. For example: 4 address lines represented as Apartment 7A, 52 Davis Street, Carlton North, Victoria, AUSTRALIA 3042., uncommonOntologyItems=null, occurencesFormal=0..*, occurencesText=Optional, repeating, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=DV_TEXT, bindings=null, values=, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/items[at0014], code=at0014, itemType=SLOT, level=1, text=Structured address details, description=Additional structured low level geographical/physical details about a location that can be concatenated to form one or more 'Unstructured address' lines., comment=null, uncommonOntologyItems=null, occurencesFormal=0..*, occurencesText=Optional, repeating, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=CLUSTER, bindings=null, values=Include:
openEHR-EHR-CLUSTER.structured_address.v0 or
openEHR-EHR-CLUSTER.structured_address.v1 and specialisations, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/items[at0015], code=at0015, itemType=ELEMENT, level=1, text=Town, description=The name of the suburb, town, city, village, community or lowest level locality of the address., comment=Coding with an external terminology is preferred, where possible. For example: Fitzroy, Calgary, Bergen., uncommonOntologyItems=null, occurencesFormal=0..*, occurencesText=Optional, repeating, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=DV_TEXT, bindings=null, values=, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/items[at0016], code=at0016, itemType=ELEMENT, level=1, text=District/County, description=The name of an internal political or geographic district or area within a state, territory or province containing the address., comment=Coding with an external terminology is preferred, where possible., uncommonOntologyItems=null, occurencesFormal=0..*, occurencesText=Optional, repeating, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=DV_TEXT, bindings=null, values=, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/items[at0017], code=at0017, itemType=ELEMENT, level=1, text=State/Territory/Province, description=The name of an internal political or geographic division of a country containing the address., comment=Coding with an external terminology is preferred, where possible. For example: Victoria; Alberta., uncommonOntologyItems=null, occurencesFormal=0..1, occurencesText=Optional, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=DV_TEXT, bindings=null, values=, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/items[at0018], code=at0018, itemType=ELEMENT, level=1, text=Postcode, description=The code for a postal delivery area containing the address, aligned with locality, suburb or place for an address, as defined by the relevant postal delivery service., comment=Also known as ZIP code. , uncommonOntologyItems=null, occurencesFormal=0..1, occurencesText=Optional, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=DV_TEXT, bindings=null, values=, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/items[at0019], code=at0019, itemType=ELEMENT, level=1, text=Country, description=The name of the country containing the address., comment=Coding with an external terminology is preferred, where possible. For example: Australia; Canada, uncommonOntologyItems=null, occurencesFormal=0..1, occurencesText=Optional, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=DV_TEXT, bindings=null, values=, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/items[at0020], code=at0020, itemType=ELEMENT, level=1, text=Postal delivery point, description=A unique number assigned to a postal delivery point, as defined by the relevant postal delivery service., comment=null, uncommonOntologyItems=null, occurencesFormal=0..1, occurencesText=Optional, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=DV_IDENTIFIER, bindings=null, values=, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/items[at0024], code=at0024, itemType=SLOT, level=1, text=Additional details, description=Additional details about the address., comment=For example: Geolocation., uncommonOntologyItems=null, occurencesFormal=0..*, occurencesText=Optional, repeating, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=CLUSTER, bindings=null, values=Include:
All not explicitly excluded archetypes, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/items[at0023], code=at0023, itemType=ELEMENT, level=1, text=Comment, description=Additional narrative about the address not captured in other fields., comment=null, uncommonOntologyItems=null, occurencesFormal=0..1, occurencesText=Optional, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=DV_TEXT, bindings=null, values=, extendedValues=null]], activities=[], context=[], provider=[], other_participations=[]}, topLevelItems={items=ResourceSimplifiedHierarchyItem [path=ROOT_/, code=at0000, itemType=CLUSTER, level=0, text=null, description=null, comment=null, uncommonOntologyItems=null, occurencesFormal=1..1, occurencesText=Mandatory, cardinalityFormal=1..*, cardinalityText=, subCardinalityFormal=null, subCardinalityText=null, dataType=CLUSTER, bindings=null, values=null, extendedValues=null]}, addHierarchyItemsTo=items, currentHierarchyItemsForAdding=[ResourceSimplifiedHierarchyItem [path=/items[at0001], code=at0001, itemType=ELEMENT, level=1, text=Type, description=The type of address., comment=For example: physical or postal., uncommonOntologyItems=null, occurencesFormal=0..1, occurencesText=Optional, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=DV_CODED_TEXT, bindings=null, values=
  • Physical [A physical location that can be visited.]
  • Postal [Address used as a destination for mailing letters or parcels.]
  • Both [Address of a physical location, also used as a destination for mail.]
, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/items[at0005], code=at0005, itemType=ELEMENT, level=1, text=Use, description=The primary purpose or use for the address., comment=null, uncommonOntologyItems=null, occurencesFormal=0..1, occurencesText=Optional, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=CHOICE, bindings=null, values=Choice of:
  •  Coded Text
    • Business [Address of the physical location of a business or office.]
    • Residential [Address of where a person is living on a regular basis.]
    • Temporary accommodation [Address of where a person is living on a temporary basis.]
  •  Text
, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/items[at0009], code=at0009, itemType=ELEMENT, level=1, text=Address, description=The unstructured address of the person or organisation., comment=This address line represents a low level of geographical/physical description of a location that, used in conjunction with the other high-level address components i.e. ‘Suburb/Town/Locality’, ‘Postcode’, and ‘State/Territory/Province’, forms a complete geographical/physical address. This data element can be used to represent a landmark, such as "The second house north of the general store" or "At the corner of Smith & Brown Streets. The content of this data element may be derived from a concatenation of one or more components from CLUSTER.structured_address. Multiple occurrences allow for as many 'Address' lines, as required. For example: 4 address lines represented as Apartment 7A, 52 Davis Street, Carlton North, Victoria, AUSTRALIA 3042., uncommonOntologyItems=null, occurencesFormal=0..*, occurencesText=Optional, repeating, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=DV_TEXT, bindings=null, values=, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/items[at0014], code=at0014, itemType=SLOT, level=1, text=Structured address details, description=Additional structured low level geographical/physical details about a location that can be concatenated to form one or more 'Unstructured address' lines., comment=null, uncommonOntologyItems=null, occurencesFormal=0..*, occurencesText=Optional, repeating, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=CLUSTER, bindings=null, values=Include:
openEHR-EHR-CLUSTER.structured_address.v0 or
openEHR-EHR-CLUSTER.structured_address.v1 and specialisations, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/items[at0015], code=at0015, itemType=ELEMENT, level=1, text=Town, description=The name of the suburb, town, city, village, community or lowest level locality of the address., comment=Coding with an external terminology is preferred, where possible. For example: Fitzroy, Calgary, Bergen., uncommonOntologyItems=null, occurencesFormal=0..*, occurencesText=Optional, repeating, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=DV_TEXT, bindings=null, values=, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/items[at0016], code=at0016, itemType=ELEMENT, level=1, text=District/County, description=The name of an internal political or geographic district or area within a state, territory or province containing the address., comment=Coding with an external terminology is preferred, where possible., uncommonOntologyItems=null, occurencesFormal=0..*, occurencesText=Optional, repeating, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=DV_TEXT, bindings=null, values=, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/items[at0017], code=at0017, itemType=ELEMENT, level=1, text=State/Territory/Province, description=The name of an internal political or geographic division of a country containing the address., comment=Coding with an external terminology is preferred, where possible. For example: Victoria; Alberta., uncommonOntologyItems=null, occurencesFormal=0..1, occurencesText=Optional, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=DV_TEXT, bindings=null, values=, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/items[at0018], code=at0018, itemType=ELEMENT, level=1, text=Postcode, description=The code for a postal delivery area containing the address, aligned with locality, suburb or place for an address, as defined by the relevant postal delivery service., comment=Also known as ZIP code. , uncommonOntologyItems=null, occurencesFormal=0..1, occurencesText=Optional, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=DV_TEXT, bindings=null, values=, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/items[at0019], code=at0019, itemType=ELEMENT, level=1, text=Country, description=The name of the country containing the address., comment=Coding with an external terminology is preferred, where possible. For example: Australia; Canada, uncommonOntologyItems=null, occurencesFormal=0..1, occurencesText=Optional, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=DV_TEXT, bindings=null, values=, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/items[at0020], code=at0020, itemType=ELEMENT, level=1, text=Postal delivery point, description=A unique number assigned to a postal delivery point, as defined by the relevant postal delivery service., comment=null, uncommonOntologyItems=null, occurencesFormal=0..1, occurencesText=Optional, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=DV_IDENTIFIER, bindings=null, values=, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/items[at0024], code=at0024, itemType=SLOT, level=1, text=Additional details, description=Additional details about the address., comment=For example: Geolocation., uncommonOntologyItems=null, occurencesFormal=0..*, occurencesText=Optional, repeating, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=CLUSTER, bindings=null, values=Include:
All not explicitly excluded archetypes, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/items[at0023], code=at0023, itemType=ELEMENT, level=1, text=Comment, description=Additional narrative about the address not captured in other fields., comment=null, uncommonOntologyItems=null, occurencesFormal=0..1, occurencesText=Optional, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=DV_TEXT, bindings=null, values=, extendedValues=null]], minIndents={}, termBindingRetrievalErrorMessage=null]