FHIR IG analytics| Package | openehr.base |
| Resource Type | StructureDefinition |
| Id | StructureDefinition-EHR-ACCESS.json |
| FHIR Version | R5 |
| Source | http://fhir.org/guides/openehr/base/0.1.0-snapshot/StructureDefinition-EHR-ACCESS.html |
| URL | http://openehr.org/fhir/StructureDefinition/EHR-ACCESS |
| Version | 0.1.0-snapshot |
| Status | active |
| Date | 2025-09-06T15:35:39+10:00 |
| Name | EHR_ACCESS |
| Title | EHR_ACCESS |
| Realm | uv |
| Authority | hl7 |
| Description | EHR-wide access control object. All access decisions to data in the EHR must be made in accordance with the policies and rules in this object. NOTE: It is strongly recommended that the inherited attribute `_uid_` be populated in `EHR_ACCESS` objects, using the UID copied from the `_object_id()_` of the `_uid_` field of the enclosing `VERSION` object. + For example, the `ORIGINAL_VERSION.uid` `87284370-2D4B-4e3d-A3F3-F303D2F4F34B::uk.nhs.ehr1::2` would be copied to the `_uid_` field of the `EHR_ACCESS` object. |
| Type | http://openehr.org/fhir/StructureDefinition/EHR_ACCESS |
| Kind | logical |
No resources found
| StructureDefinition | ||
| openehr.base#0.1.0-snapshot | ACCESS-CONTROL-SETTINGS | ACCESS_CONTROL_SETTINGS |
| openehr.base#0.1.0-snapshot | LOCATABLE | LOCATABLE |
Note: links and images are rebased to the (stated) source
Generated Narrative: StructureDefinition EHR-ACCESS
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  EHR_ACCESS | C | 0..* | LOCATABLE | EHR-wide access control object. Elements defined in Ancestors:name, archetype_node_id, uid, links, archetype_details, feeder_audit Constraints: Scheme_valid, Is_archetype_root |
  settings | 0..1 | ACCESS_CONTROL_SETTINGS | Access control settings for the EHR. | |
| Documentation for this format | ||||
FHIR
FHIRsmith{
"resourceType": "StructureDefinition",
"id": "EHR-ACCESS",
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"contained": [
{
"resourceType": "OperationDefinition",
"id": "scheme",
"name": "scheme",
"title": "scheme",
"status": "active",
"kind": "operation",
"description": "The name of the access control scheme in use; corresponds to the concrete instance of the settings attribute. ",
"code": "scheme",
"system": false,
"instance": true,
"parameter": [
{
"name": "return",
"use": "out",
"min": 1,
"max": "1",
"type": "string"
}
]
}
],
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/web-source",
"valueUrl": "https://specifications.openehr.org/releases/RM/development/ehr.html#_ehr_access_class"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/type-operation",
"valueCanonical": "#scheme"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "fhir"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/view-hint",
"valueCode": "element-view-replace-cardinality"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 3,
"_valueInteger": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical": "http://openehr.org/fhir/ImplementationGuide/openehr.base"
}
]
}
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "informative",
"_valueCode": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical": "http://openehr.org/fhir/ImplementationGuide/openehr.base"
}
]
}
}
],
"url": "http://openehr.org/fhir/StructureDefinition/EHR-ACCESS",
"version": "0.1.0-snapshot",
"name": "EHR_ACCESS",
"title": "EHR_ACCESS",
"status": "active",
"experimental": false,
"date": "2025-09-06T15:35:39+10:00",
"publisher": "openEHR + HL7",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://www.openehr.org"
}
]
}
],
"description": "EHR-wide access control object. All access decisions to data in the EHR must be made in accordance with the policies and rules in this object.\n\nNOTE: It is strongly recommended that the inherited attribute `_uid_` be populated in `EHR_ACCESS` objects, using the UID copied from the `_object_id()_` of the `_uid_` field of the enclosing `VERSION` object. +\nFor example, the `ORIGINAL_VERSION.uid` `87284370-2D4B-4e3d-A3F3-F303D2F4F34B::uk.nhs.ehr1::2` would be copied to the `_uid_` field of the `EHR_ACCESS` object.",
"jurisdiction": [
{
"coding": [
{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "001"
}
]
}
],
"fhirVersion": "5.0.0",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}
],
"kind": "logical",
"abstract": false,
"type": "http://openehr.org/fhir/StructureDefinition/EHR_ACCESS",
"baseDefinition": "http://openehr.org/fhir/StructureDefinition/LOCATABLE",
"derivation": "specialization",
"snapshot": {
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
"valueString": "0.1.0-snapshot"
}
],
"element": [
{
"id": "EHR_ACCESS",
"path": "EHR_ACCESS",
"short": "EHR-wide access control object.",
"definition": "EHR-wide access control object. All access decisions to data in the EHR must be made in accordance with the policies and rules in this object.\n\nNOTE: It is strongly recommended that the inherited attribute `_uid_` be populated in `EHR_ACCESS` objects, using the UID copied from the `_object_id()_` of the `_uid_` field of the enclosing `VERSION` object. +\nFor example, the `ORIGINAL_VERSION.uid` `87284370-2D4B-4e3d-A3F3-F303D2F4F34B::uk.nhs.ehr1::2` would be copied to the `_uid_` field of the `EHR_ACCESS` object.",
"min": 0,
"max": "*",
"base": {
"path": "Base",
"min": 0,
"max": "*"
},
"constraint": [
{
"key": "Links_valid",
"severity": "error",
"human": "Links valid must be present",
"expression": "links.exists() implies links.empty().not()",
"source": "http://openehr.org/fhir/StructureDefinition/LOCATABLE"
},
{
"key": "Archetyped_valid",
"severity": "error",
"human": "Archetyped valid must satisfy exclusive conditions",
"expression": "is_archetype_root() xor archetype_details .empty()",
"source": "http://openehr.org/fhir/StructureDefinition/LOCATABLE"
},
{
"key": "Archetype_node_id_valid",
"severity": "error",
"human": "Archetype node id valid must not be empty",
"expression": "archetype_node_id.empty().not()",
"source": "http://openehr.org/fhir/StructureDefinition/LOCATABLE"
},
{
"key": "Scheme_valid",
"severity": "error",
"human": "Scheme valid must not be empty",
"expression": "scheme().not().empty()"
},
{
"key": "Is_archetype_root",
"severity": "error",
"human": "Is archetype root",
"expression": "is_archetype_root()"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "EHR_ACCESS.name",
"path": "EHR_ACCESS.name",
"short": "Runtime name of this fragment, used to build runtime paths.",
"definition": "Runtime name of this fragment, used to build runtime paths. This is the term provided via a clinical application or batch process to name this EHR construct: its retention in the EHR faithfully preserves the original label by which this entry was known to end users.",
"min": 1,
"max": "1",
"base": {
"path": "LOCATABLE.name",
"min": 1,
"max": "1"
},
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/DV-TEXT"
}
],
"isModifier": false
},
{
"id": "EHR_ACCESS.archetype-node-id",
"path": "EHR_ACCESS.archetype_node_id",
"short": "Design-time archetype identifier of this node taken from its generating archetype; used to build archetype paths.",
"definition": "Design-time archetype identifier of this node taken from its generating archetype; used to build archetype paths. Always in the form of an at-code, e.g. `at0005`. This value enables a 'standardised' name for this node to be generated, by referring to the generating archetype local terminology. \n\nAt an archetype root point, the value of this attribute is always the stringified form of the `_archetype_id_` found in the `_archetype_details_` object.",
"min": 1,
"max": "1",
"base": {
"path": "LOCATABLE.archetype_node_id",
"min": 1,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isModifier": false
},
{
"id": "EHR_ACCESS.uid",
"path": "EHR_ACCESS.uid",
"short": "Optional globally unique object identifier for root points of archetyped structures.",
"definition": "Optional globally unique object identifier for root points of archetyped structures.",
"min": 0,
"max": "1",
"base": {
"path": "LOCATABLE.uid",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/UID-BASED-ID"
}
],
"isModifier": false
},
{
"id": "EHR_ACCESS.links",
"path": "EHR_ACCESS.links",
"short": "Links to other archetyped structures (data whose root object inherits from `ARCHETYPED`, such as `ENTRY`, `SECTION` and so on).",
"definition": "Links to other archetyped structures (data whose root object inherits from `ARCHETYPED`, such as `ENTRY`, `SECTION` and so on). Links may be to structures in other compositions.",
"min": 0,
"max": "*",
"base": {
"path": "LOCATABLE.links",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/LINK"
}
],
"isModifier": false
},
{
"id": "EHR_ACCESS.archetype-details",
"path": "EHR_ACCESS.archetype_details",
"short": "Details of archetyping used on this node.",
"definition": "Details of archetyping used on this node.",
"min": 0,
"max": "1",
"base": {
"path": "LOCATABLE.archetype_details",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/ARCHETYPED"
}
],
"isModifier": false
},
{
"id": "EHR_ACCESS.feeder-audit",
"path": "EHR_ACCESS.feeder_audit",
"short": "Audit trail from non-openEHR system of original commit of information forming the content of this node, or from a conversion gateway which has synthesised this node.",
"definition": "Audit trail from non-openEHR system of original commit of information forming the content of this node, or from a conversion gateway which has synthesised this node.",
"min": 0,
"max": "1",
"base": {
"path": "LOCATABLE.feeder_audit",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/FEEDER-AUDIT"
}
],
"isModifier": false
},
{
"id": "EHR_ACCESS.settings",
"path": "EHR_ACCESS.settings",
"short": "Access control settings for the EHR.",
"definition": "Access control settings for the EHR. Instance is a subtype of the type `ACCESS_CONTROL_SETTINGS`, allowing for the use of different access control schemes.",
"min": 0,
"max": "1",
"base": {
"path": "EHR_ACCESS.settings",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/ACCESS-CONTROL-SETTINGS"
}
],
"isModifier": false
}
]
},
"differential": {
"element": [
{
"id": "EHR_ACCESS",
"path": "EHR_ACCESS",
"short": "EHR-wide access control object.",
"definition": "EHR-wide access control object. All access decisions to data in the EHR must be made in accordance with the policies and rules in this object.\n\nNOTE: It is strongly recommended that the inherited attribute `_uid_` be populated in `EHR_ACCESS` objects, using the UID copied from the `_object_id()_` of the `_uid_` field of the enclosing `VERSION` object. +\nFor example, the `ORIGINAL_VERSION.uid` `87284370-2D4B-4e3d-A3F3-F303D2F4F34B::uk.nhs.ehr1::2` would be copied to the `_uid_` field of the `EHR_ACCESS` object.",
"min": 0,
"max": "*",
"constraint": [
{
"key": "Scheme_valid",
"severity": "error",
"human": "Scheme valid must not be empty",
"expression": "scheme().not().empty()"
},
{
"key": "Is_archetype_root",
"severity": "error",
"human": "Is archetype root",
"expression": "is_archetype_root()"
}
],
"isModifier": false
},
{
"id": "EHR_ACCESS.settings",
"path": "EHR_ACCESS.settings",
"short": "Access control settings for the EHR.",
"definition": "Access control settings for the EHR. Instance is a subtype of the type `ACCESS_CONTROL_SETTINGS`, allowing for the use of different access control schemes. ",
"min": 0,
"max": "1",
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/ACCESS-CONTROL-SETTINGS"
}
],
"isModifier": false
}
]
}
}