{
"description": "Basisprofil for Norwegian Address information. Defined by The Norwegian Directorate of eHealth and HL7 Norway. The profile adds Norwegian specific property information, official use of address and further explanation of the use for the data-elements in a Norwegian address. The basis profile is open, but derived profiles should close down the information elements according to specification relevant to the use-case.",
"_filename": "no-basis-Address.structuredefinition-profile.json",
"package_name": "HL7Norway.STU3.no.basis",
"date": "2018-10-26",
"derivation": "constraint",
"meta": {
"versionId": "3",
"lastUpdated": "2018-06-15T13:38:12.872+00:00"
},
"publisher": null,
"fhirVersion": "3.0.1",
"purpose": "Norwegian basisprofil for Address resource adding Norwegian specific property information, official use of address and further explanation of the use for the data-elements in a Norwegian address.",
"name": "no-basis-Address",
"abstract": false,
"type": "Address",
"experimental": null,
"resourceType": "StructureDefinition",
"title": "no-basis-Address",
"package_version": "1.0.3",
"snapshot": {
"element": [ {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Address",
"min": 0,
"definition": "An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world.",
"short": "An address expressed using postal conventions (as opposed to GPS or other location definition formats)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "XAD",
"identity": "v2"
}, {
"map": "AD",
"identity": "rim"
}, {
"map": "Address",
"identity": "servd"
} ],
"max": "*",
"id": "Address",
"condition": [ "ele-1" ],
"comment": "Note: address is for postal addresses, not physical locations.",
"base": {
"max": "*",
"min": 0,
"path": "Element"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Address.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Address.id",
"condition": [ "ele-1" ],
"comment": "Note that FHIR strings may not exceed 1MB in size",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Address.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Address.extension",
"condition": [ "ele-1" ],
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Address.extension",
"min": 0,
"definition": "Identification of a real property in Norway is defined using gårdsnummer, bruksnummer and kommunenummer. In addition real property can be rented out, the area of the real property that is rented is measured and is further identified by its festenummer. In addition some real property is split into sections identified by its seksjonsnummer.",
"short": "real property identification",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension",
"profile": "http://hl7.no/fhir/StructureDefinition/no-basis-propertyinformation"
} ],
"sliceName": "propertyinformation",
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Address.extension:propertyinformation",
"condition": [ "ele-1" ],
"comment": "real property identification",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Address.extension",
"min": 0,
"definition": "Defines the concept of an officially registered address in Norway. Usually this will be the adress registered in \"Folkeregisteret\" for persons or \"Enhetsregisteret\" for organizations.",
"short": "The concept of an officially registered address",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension",
"profile": "http://hl7.no/fhir/StructureDefinition/no-basis-address-official"
} ],
"sliceName": "official",
"alias": [ "extensions", "user content" ],
"max": "1",
"id": "Address.extension:official",
"condition": [ "ele-1" ],
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Address.use",
"requirements": "Allows an appropriate address to be chosen from a list of many.",
"min": 0,
"definition": "The purpose of this address.\r\n\r\nMapping of values to other Norwegian CodeSystems is documented in the implementation guide. In general the address used for visiting the person should have use \"home\" and type \"physical\" or \"both\". The \"official\" flag can be either true or false.",
"isModifier": true,
"short": "home | work | temp | old - purpose of this address",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "XAD.7",
"identity": "v2"
}, {
"map": "unique(./use)",
"identity": "rim"
}, {
"map": "./AddressPurpose",
"identity": "servd"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "AddressUse"
} ],
"description": "The use of an address",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/address-use"
}
},
"max": "1",
"id": "Address.use",
"condition": [ "ele-1" ],
"comment": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary or old address etc.for a current/permanent one. Applications can assume that an address is current unless it explicitly says that it is temporary or old.",
"example": [ {
"label": "General",
"valueCode": "home"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Address.use"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Address.type",
"min": 0,
"definition": "Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.\r\n\r\nMapping of values to other Norwegian CodeSystems is documented in the implementation guide. In general the address used for visiting the person should have use \"home\" and type \"physical\" or \"both\". The \"official\" flag can be either true or false.",
"short": "postal | physical | both",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "XAD.18",
"identity": "v2"
}, {
"map": "unique(./use)",
"identity": "rim"
}, {
"map": "address type parameter",
"identity": "vcard"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "AddressType"
} ],
"description": "The type of an address (physical / postal)",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/address-type"
}
},
"max": "1",
"id": "Address.type",
"condition": [ "ele-1" ],
"comment": "Note that FHIR strings may not exceed 1MB in size",
"example": [ {
"label": "General",
"valueCode": "both"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Address.type"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Address.text",
"requirements": "A renderable, unencoded form.",
"min": 0,
"definition": "A full text representation of the address.",
"short": "Text representation of the address",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "XAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6",
"identity": "v2"
}, {
"map": "./formatted",
"identity": "rim"
}, {
"map": "address label parameter",
"identity": "vcard"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "Address.text",
"condition": [ "ele-1" ],
"comment": "Can provide both a text representation and parts.",
"example": [ {
"label": "General",
"valueString": "137 Nowhere Street, Erewhon 9132"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Address.text"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Address.line",
"requirements": "home | work | temp | old - purpose of this address.",
"min": 0,
"definition": "This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.",
"short": "Street name, number, direction & P.O. Box etc.",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "XAD.1 + XAD.2 (note: XAD.1 and XAD.2 have different meanings for a company address than for a person address)",
"identity": "v2"
}, {
"map": "AD.part[parttype = AL]",
"identity": "rim"
}, {
"map": "street",
"identity": "vcard"
}, {
"map": "./StreetAddress (newline delimitted)",
"identity": "servd"
} ],
"type": [ {
"code": "string"
} ],
"max": "*",
"id": "Address.line",
"condition": [ "ele-1" ],
"comment": "Note that FHIR strings may not exceed 1MB in size",
"example": [ {
"label": "General",
"valueString": "137 Nowhere Street"
} ],
"orderMeaning": "The order in which lines should appear in an address label",
"base": {
"max": "*",
"min": 0,
"path": "Address.line"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Address.city",
"min": 0,
"definition": "When a postalcode is given the name of the city must be according to the official list of postalcodes used in Norway.\r\n\r\nThe name of the city, town, village or other community or delivery center.",
"short": "Poststed or city",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "XAD.3",
"identity": "v2"
}, {
"map": "AD.part[parttype = CTY]",
"identity": "rim"
}, {
"map": "locality",
"identity": "vcard"
}, {
"map": "./Jurisdiction",
"identity": "servd"
} ],
"type": [ {
"code": "string"
} ],
"alias": [ "Municpality", "by", "poststed" ],
"max": "1",
"id": "Address.city",
"condition": [ "ele-1" ],
"comment": "Note that FHIR strings may not exceed 1MB in size",
"example": [ {
"label": "General",
"valueString": "Erewhon"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Address.city"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Address.district",
"min": 0,
"definition": "Name of the county (norwegian \"kommune\"). If kommune number is required \"eiendomsinformasjon\" should be used.\r\n\r\nThe name of the administrative area (county).",
"short": "name of \"kommune\"",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "XAD.9",
"identity": "v2"
}, {
"map": "AD.part[parttype = CNT | CPA]",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"alias": [ "County", "kommune" ],
"max": "1",
"id": "Address.district",
"condition": [ "ele-1" ],
"comment": "District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead.",
"example": [ {
"label": "General",
"valueString": "Madison"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Address.district"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Address.state",
"min": 0,
"definition": "Name of the norwegian \"fylke\"). If fylkes-number is required \"eiendomsinformasjon\" should be used with koded kommune-number.\r\n\r\nSub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (i.e. US 2 letter state codes).",
"short": "norwegian \"fylke\"",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "XAD.4",
"identity": "v2"
}, {
"map": "AD.part[parttype = STA]",
"identity": "rim"
}, {
"map": "region",
"identity": "vcard"
}, {
"map": "./Region",
"identity": "servd"
} ],
"type": [ {
"code": "string"
} ],
"alias": [ "Province", "Territory", "fylke" ],
"max": "1",
"id": "Address.state",
"condition": [ "ele-1" ],
"comment": "Note that FHIR strings may not exceed 1MB in size",
"base": {
"max": "1",
"min": 0,
"path": "Address.state"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Address.postalCode",
"min": 0,
"definition": "A postal code designating a region defined by the postal service.\r\n\r\nIn Norway this is af four digit number defined by the norwegian postal service.",
"short": "Postal code for area",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "XAD.5",
"identity": "v2"
}, {
"map": "AD.part[parttype = ZIP]",
"identity": "rim"
}, {
"map": "code",
"identity": "vcard"
}, {
"map": "./PostalIdentificationCode",
"identity": "servd"
} ],
"type": [ {
"code": "string"
} ],
"alias": [ "Zip", "postnummer" ],
"max": "1",
"id": "Address.postalCode",
"condition": [ "ele-1" ],
"comment": "Note that FHIR strings may not exceed 1MB in size",
"example": [ {
"label": "General",
"valueString": "9132"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Address.postalCode"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Address.country",
"min": 0,
"definition": "Country - a nation as commonly understood or generally accepted.",
"short": "Country (e.g. can be ISO 3166 2 or 3 letter code)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "XAD.6",
"identity": "v2"
}, {
"map": "AD.part[parttype = CNT]",
"identity": "rim"
}, {
"map": "country",
"identity": "vcard"
}, {
"map": "./Country",
"identity": "servd"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "Address.country",
"condition": [ "ele-1" ],
"comment": "ISO 3166 3 letter codes can be used in place of a full country name.",
"base": {
"max": "1",
"min": 0,
"path": "Address.country"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
}, {
"key": "per-1",
"human": "If present, start SHALL have a lower value than end",
"xpath": "not(exists(f:start)) or not(exists(f:end)) or (f:start/@value <= f:end/@value)",
"severity": "error",
"expression": "start.empty() or end.empty() or (start <= end)"
} ],
"path": "Address.period",
"requirements": "Allows addresses to be placed in historical context.",
"min": 0,
"definition": "Time period when address was/is in use.",
"short": "Time period when address was/is in use",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "DR",
"identity": "v2"
}, {
"map": "IVL[lowClosed=\"true\" and highClosed=\"true\"] or URG[lowClosed=\"true\" and highClosed=\"true\"]",
"identity": "rim"
}, {
"map": "XAD.12 / XAD.13 + XAD.14",
"identity": "v2"
}, {
"map": "./usablePeriod[type=\"IVL\"]",
"identity": "rim"
}, {
"map": "./StartDate and ./EndDate",
"identity": "servd"
} ],
"type": [ {
"code": "Period"
} ],
"max": "1",
"id": "Address.period",
"condition": [ "ele-1" ],
"comment": "This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. \"the patient was an inpatient of the hospital for this time range\") or one value from the range applies (e.g. \"give to the patient between these two times\"). If duration is required, specify the type as Interval|Duration.",
"example": [ {
"label": "General",
"valuePeriod": {
"end": "2010-07-01",
"start": "2010-03-23"
}
} ],
"base": {
"max": "1",
"min": 0,
"path": "Address.period"
},
"isSummary": true
} ]
},
"status": "active",
"id": "58de974e-068f-4212-9cb5-13b325a18a07",
"kind": "complex-type",
"url": "http://hl7.no/fhir/StructureDefinition/no-basis-Address",
"version": "1.0",
"differential": {
"element": [ {
"id": "Address.extension",
"path": "Address.extension",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
}
}, {
"id": "Address.extension:propertyinformation",
"path": "Address.extension",
"type": [ {
"code": "Extension",
"profile": "http://hl7.no/fhir/StructureDefinition/no-basis-propertyinformation"
} ],
"comment": "real property identification",
"sliceName": "propertyinformation",
"definition": "Identification of a real property in Norway is defined using gårdsnummer, bruksnummer and kommunenummer. In addition real property can be rented out, the area of the real property that is rented is measured and is further identified by its festenummer. In addition some real property is split into sections identified by its seksjonsnummer."
}, {
"id": "Address.extension:official",
"path": "Address.extension",
"type": [ {
"code": "Extension",
"profile": "http://hl7.no/fhir/StructureDefinition/no-basis-address-official"
} ],
"sliceName": "official"
}, {
"id": "Address.use",
"path": "Address.use",
"definition": "The purpose of this address.\r\n\r\nMapping of values to other Norwegian CodeSystems is documented in the implementation guide. In general the address used for visiting the person should have use \"home\" and type \"physical\" or \"both\". The \"official\" flag can be either true or false."
}, {
"id": "Address.type",
"path": "Address.type",
"definition": "Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.\r\n\r\nMapping of values to other Norwegian CodeSystems is documented in the implementation guide. In general the address used for visiting the person should have use \"home\" and type \"physical\" or \"both\". The \"official\" flag can be either true or false."
}, {
"id": "Address.city",
"path": "Address.city",
"alias": [ "by", "poststed" ],
"short": "Poststed or city",
"definition": "When a postalcode is given the name of the city must be according to the official list of postalcodes used in Norway.\r\n\r\nThe name of the city, town, village or other community or delivery center."
}, {
"id": "Address.district",
"path": "Address.district",
"alias": [ "kommune" ],
"short": "name of \"kommune\"",
"definition": "Name of the county (norwegian \"kommune\"). If kommune number is required \"eiendomsinformasjon\" should be used.\r\n\r\nThe name of the administrative area (county)."
}, {
"id": "Address.state",
"path": "Address.state",
"alias": [ "fylke" ],
"short": "norwegian \"fylke\"",
"definition": "Name of the norwegian \"fylke\"). If fylkes-number is required \"eiendomsinformasjon\" should be used with koded kommune-number.\r\n\r\nSub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (i.e. US 2 letter state codes)."
}, {
"id": "Address.postalCode",
"path": "Address.postalCode",
"alias": [ "postnummer" ],
"definition": "A postal code designating a region defined by the postal service.\r\n\r\nIn Norway this is af four digit number defined by the norwegian postal service."
} ]
},
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Address"
}