This page is part of the FHIR Specification (v1.2.0: STU 3 Draft). The current version which supercedes this version is 4.0.1. For a full list of available versions, see the Directory of published versions
nl-core-address-official
{ "resourceType": "StructureDefinition", "id": "nl-address-official", "meta": { "lastUpdated": "2015-09-22T20:02:49.724+10:00" }, "url": "http://fhir.nl/fhir/StructureDefinition/nl-address-official", "name": "nl-core-address-official", "status": "draft", "contact": [ { "name": "HL7 Netherlands" } ], "date": "2015-09-22T20:02:49+10:00", "description": "Base StructureDefinition for Extension Type", "requirements": "The ability to add extensions in a structured way is what keeps FHIR resources simple.", "fhirVersion": "1.0.1", "mapping": [ { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM" } ], "kind": "datatype", "constrainedType": "Extension", "abstract": false, "contextType": "resource", "context": [ "Address" ], "base": "http://hl7.org/fhir/StructureDefinition/Extension", "snapshot": { "element": [ { "path": "Extension", "short": "Mark an address as an 'officially registered' address.", "definition": "Mark an address as an 'officially registered' address. In Dutch context that means it is registered in the Basisregistratie persoonsgegevens (BRP)", "min": 0, "max": "*", "base": { "path": "Extension", "min": 0, "max": "*" }, "type": [ { "code": "Element" } ], "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "path": "Extension.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references).", "min": 0, "max": "1", "base": { "path": "Extension.id", "min": 0, "max": "1" }, "type": [ { "code": "id" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "path": "Extension.extension", "short": "Additional Content defined by implementations", "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.", "comments": "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.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Extension.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "path": "Extension.url", "representation": [ "xmlAttr" ], "short": "identifies the meaning of the extension", "definition": "Source of the definition for the extension code - a logical name or a URL.", "comments": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition should be version specific. This will ideally be the URI for the Resource Profile defining the extension, with the code for the extension after a #.", "min": 1, "max": "1", "base": { "path": "Extension.url", "min": 1, "max": "1" }, "type": [ { "code": "uri" } ], "fixedUri": "http://fhir.nl/fhir/StructureDefinition/nl-address-official", "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "path": "Extension.valueBoolean", "short": "true if part of an official registry. false if it is not", "definition": "When the value is true, this address is marked to be part of an official registry (Dutch realm: BRP). When the value is false, this address is explicitly marked as not part of an official registry.", "min": 1, "max": "1", "base": { "path": "Extension.value[x]", "min": 0, "max": "1" }, "type": [ { "code": "boolean" } ], "mapping": [ { "identity": "rim", "map": "N/A" }, { "identity": "rim", "map": "AD/@use[.='OR']" } ] } ] }, "differential": { "element": [ { "path": "Extension", "short": "Mark an address as an 'officially registered' address.", "definition": "Mark an address as an 'officially registered' address. In Dutch context that means it is registered in the Basisregistratie persoonsgegevens (BRP)", "min": 0, "max": "*", "type": [ { "code": "Element" } ], "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "path": "Extension.url", "representation": [ "xmlAttr" ], "short": "identifies the meaning of the extension", "definition": "Source of the definition for the extension code - a logical name or a URL.", "comments": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition should be version specific. This will ideally be the URI for the Resource Profile defining the extension, with the code for the extension after a #.", "min": 1, "max": "1", "fixedUri": "http://fhir.nl/fhir/StructureDefinition/nl-address-official", "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "path": "Extension.value[x]", "short": "true if part of an official registry. false if it is not", "definition": "When the value is true, this address is marked to be part of an official registry (Dutch realm: BRP). When the value is false, this address is explicitly marked as not part of an official registry.", "min": 1, "max": "1", "type": [ { "code": "boolean" } ], "meaningWhenMissing": "When an address is not marked explicitly as official=true|false than no information can be inferred from that.", "mapping": [ { "identity": "rim", "map": "AD/@use[.='OR']" } ] } ] } }
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.