OpenEHR Apperta Mirror
Name
Address
Description
Address details aligned with FHIR resource.
Purpose
For the recording of address details aligned with corresponding FHIR resource.
Use
Use to record address details aligned with the corresponding FHIR resources.

This cluster archetype is intended to be used inside FHIR resource aligned archetypes such as CLUSTER.fhir_contact.v0 and CLUSTER.fhir_practitioner.v0.
References
https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Patient-1 cited 30-Jul-2018.
https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Practitioner-1 cited 30-Jul-2018.
Archetype Id
openEHR-EHR-CLUSTER.address_cc.v0
Copyright
© Apperta Foundation
Licencing
This work is licensed under the Creative Commons Attribution-ShareAlike 3.0 License. To view a copy of this license, visit http://creativecommons.org/licenses/by-sa/3.0/.
Original Author
Hildegard McNicoll
freshEHR Clinical Informatics Ltd.
Date Originally Authored
2018-07-20
Name Card Type Description
Use
0..1 DV_CODED_TEXT The purpose of the address.
Constraint for DV_CODED_TEXT
  • Home
    [Home address.]
  • Work
    [Work address.]
  • Temp
    [Temporary address.]
  • Old
    [Old address.]
Type
0..1 DV_CODED_TEXT Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.
Constraint for DV_CODED_TEXT
  • Postal
    [Postal type of address.]
  • Physical
    [Physical type of address.]
  • Both
    [Address which is both physical and postal.]
Text
0..1 DV_TEXT A full text representation of the address.
Line
0..* DV_TEXT This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.
City
0..1 DV_TEXT The name of the city, town, village or other community or delivery center.
District
0..1 DV_TEXT The name of the administrative area (county).
Postal code
0..1 DV_TEXT A postal code designating a region defined by the postal service.
Country
0..1 DV_TEXT Country - a nation as commonly understood or generally accepted.
Valid period start
0..1 DV_DATE_TIME The start of the period. The boundary is inclusive.
Valid period end
0..1 DV_DATE_TIME The end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.
archetype (adl_version=1.4; uid=b71a8755-a93b-4210-a901-df2ae9abcfcc)
	openEHR-EHR-CLUSTER.address_cc.v0

concept
	[at0000]	-- Address
language
	original_language = <[ISO_639-1::en]>
description
	original_author = <
		["name"] = <"Hildegard McNicoll">
		["organisation"] = <"freshEHR Clinical Informatics Ltd.">
		["email"] = <"hildi@freshehr.com">
		["date"] = <"2018-07-20">
	>
	details = <
		["en"] = <
			language = <[ISO_639-1::en]>
			purpose = <"For the recording of address details aligned with corresponding FHIR resource.">
			use = <"Use to record address details aligned with the corresponding FHIR resources.

This cluster archetype is intended to be used inside FHIR resource aligned archetypes such as CLUSTER.fhir_contact.v0 and CLUSTER.fhir_practitioner.v0.">
			misuse = <"">
			copyright = <"© Apperta Foundation">
		>
	>
	lifecycle_state = <"in_development">
	other_contributors = <>
	other_details = <
		["licence"] = <"This work is licensed under the Creative Commons Attribution-ShareAlike 3.0 License. To view a copy of this license, visit http://creativecommons.org/licenses/by-sa/3.0/.">
		["custodian_organisation"] = <"Apperta UK">
		["references"] = <"https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Patient-1 cited 30-Jul-2018.

https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Practitioner-1 cited 30-Jul-2018.">
		["current_contact"] = <"Hildegard McNicoll, freshEHR Clinical Informatics Ltd.<hildi@freshehr.com>">
		["original_namespace"] = <"uk.org.clinicalmodels">
		["original_publisher"] = <"Apperta UK">
		["custodian_namespace"] = <"uk.org.clinicalmodels">
		["MD5-CAM-1.0.1"] = <"27C66E529432847664C60FB687DA1CCC">
		["build_uid"] = <"90992ec0-51e5-459b-9b90-107cfb29fe46">
		["revision"] = <"0.0.1-alpha">
	>

definition
	CLUSTER[at0000] matches {    -- Address
		items cardinality matches {1..*; unordered} matches {
			ELEMENT[at0001] occurrences matches {0..1} matches {    -- Use
				value matches {
					DV_CODED_TEXT matches {
						defining_code matches {
							[local::
							at0002,    -- Home
							at0003,    -- Work
							at0004,    -- Temp
							at0005]    -- Old
						}
					}
				}
			}
			ELEMENT[at0006] occurrences matches {0..1} matches {    -- Type
				value matches {
					DV_CODED_TEXT matches {
						defining_code matches {
							[local::
							at0007,    -- Postal
							at0008,    -- Physical
							at0009]    -- Both
						}
					}
				}
			}
			ELEMENT[at0010] occurrences matches {0..1} matches {    -- Text
				value matches {
					DV_TEXT matches {*}
				}
			}
			ELEMENT[at0011] occurrences matches {0..*} matches {    -- Line
				value matches {
					DV_TEXT matches {*}
				}
			}
			ELEMENT[at0012] occurrences matches {0..1} matches {    -- City
				value matches {
					DV_TEXT matches {*}
				}
			}
			ELEMENT[at0013] occurrences matches {0..1} matches {    -- District
				value matches {
					DV_TEXT matches {*}
				}
			}
			ELEMENT[at0014] occurrences matches {0..1} matches {    -- Postal code
				value matches {
					DV_TEXT matches {*}
				}
			}
			ELEMENT[at0015] occurrences matches {0..1} matches {    -- Country
				value matches {
					DV_TEXT matches {*}
				}
			}
			ELEMENT[at0016] occurrences matches {0..1} matches {    -- Valid period start
				value matches {
					DV_DATE_TIME matches {*}
				}
			}
			ELEMENT[at0017] occurrences matches {0..1} matches {    -- Valid period end
				value matches {
					DV_DATE_TIME matches {*}
				}
			}
		}
	}


ontology
	term_definitions = <
		["en"] = <
			items = <
				["at0000"] = <
					text = <"Address">
					description = <"Address details aligned with FHIR resource.">
				>
				["at0001"] = <
					text = <"Use">
					description = <"The purpose of the address.">
				>
				["at0002"] = <
					text = <"Home">
					description = <"Home address.">
				>
				["at0003"] = <
					text = <"Work">
					description = <"Work address.">
				>
				["at0004"] = <
					text = <"Temp">
					description = <"Temporary address.">
				>
				["at0005"] = <
					text = <"Old">
					description = <"Old address.">
				>
				["at0006"] = <
					text = <"Type">
					description = <"Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.">
				>
				["at0007"] = <
					text = <"Postal">
					description = <"Postal type of address.">
				>
				["at0008"] = <
					text = <"Physical">
					description = <"Physical type of address.">
				>
				["at0009"] = <
					text = <"Both">
					description = <"Address which is both physical and postal.">
				>
				["at0010"] = <
					text = <"Text">
					description = <"A full text representation of the address.">
				>
				["at0011"] = <
					text = <"Line">
					description = <"This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.">
				>
				["at0012"] = <
					text = <"City">
					description = <"The name of the city, town, village or other community or delivery center.">
				>
				["at0013"] = <
					text = <"District">
					description = <"The name of the administrative area (county).">
				>
				["at0014"] = <
					text = <"Postal code">
					description = <"A postal code designating a region defined by the postal service.">
				>
				["at0015"] = <
					text = <"Country">
					description = <"Country - a nation as commonly understood or generally accepted.">
				>
				["at0016"] = <
					text = <"Valid period start">
					description = <"The start of the period. The boundary is inclusive.">
				>
				["at0017"] = <
					text = <"Valid period end">
					description = <"The end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.">
				>
			>
		>
	>