FHIR © HL7.org  |  FHIRsmith 4.0.1  |  Server Home  |  XIG Home  |  XIG Stats  | 

FHIR IG analytics

Packageopenehr.base
Resource TypeStructureDefinition
IdStructureDefinition-ROLE.json
FHIR VersionR5
Sourcehttp://fhir.org/guides/openehr/base/0.1.0-snapshot/StructureDefinition-ROLE.html
URLhttp://openehr.org/fhir/StructureDefinition/ROLE
Version0.1.0-snapshot
Statusactive
Date2025-09-06T15:35:39+10:00
NameROLE
TitleROLE
Realmuv
Authorityhl7
DescriptionGeneric description of a role performed by an Actor. The role corresponds to a competency of the Party. Roles are used to define the responsibilities undertaken by a Party for a purpose. Roles should have credentials qualifying the performer to perform the role.
Typehttp://openehr.org/fhir/StructureDefinition/ROLE
Kindlogical

Resources that use this resource

No resources found


Resources that this resource uses

StructureDefinition
openehr.base#0.1.0-snapshotCAPABILITYCAPABILITY
openehr.base#0.1.0-snapshotDV-INTERVALDV_INTERVAL
openehr.base#0.1.0-snapshotPARTYPARTY
openehr.base#0.1.0-snapshotPARTY-REFPARTY_REF

Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: StructureDefinition ROLE

NameFlagsCard.TypeDescription & Constraintsdoco
.. ROLE C0..*PARTYGeneric description of a role performed by an Actor.

Elements defined in Ancestors:name, archetype_node_id, uid, links, archetype_details, feeder_audit, identities, contacts, details, reverse_relationships, relationships
Constraints: Capabilities_valid
... time_validity 0..1DV_INTERVAL<DV_DATE>Valid time interval for this role.
... performer 1..1PARTY_REFReference to Version container of Actor playing the role.
... capabilities 0..*CAPABILITYThe capabilities of this role.

doco Documentation for this format

Source1

{
  "resourceType": "StructureDefinition",
  "id": "ROLE",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/web-source",
      "valueUrl": "https://specifications.openehr.org/releases/RM/development/demographic.html#_role_class"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode": "fhir"
    },
    {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/type-operation",
      "valueCanonical": "#type"
    },
    {
      "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/ROLE",
  "version": "0.1.0-snapshot",
  "name": "ROLE",
  "title": "ROLE",
  "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": "Generic description of a role performed by an Actor. The role corresponds to a competency of the Party. Roles are used to define the responsibilities undertaken by a Party for a purpose. Roles should have credentials qualifying the performer to perform the role.",
  "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/ROLE",
  "baseDefinition": "http://openehr.org/fhir/StructureDefinition/PARTY",
  "derivation": "specialization",
  "snapshot": {
    "extension": [
      {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
        "valueString": "0.1.0-snapshot"
      }
    ],
    "element": [
      {
        "id": "ROLE",
        "path": "ROLE",
        "short": "Generic description of a role performed by an Actor.",
        "definition": "Generic description of a role performed by an Actor. The role corresponds to a competency of the Party. Roles are used to define the responsibilities undertaken by a Party for a purpose. Roles should have credentials qualifying the performer to perform the role.",
        "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": "Type_valid",
            "severity": "error",
            "human": "Type valid",
            "expression": "type() = name",
            "source": "http://openehr.org/fhir/StructureDefinition/PARTY"
          },
          {
            "key": "Identities_valid",
            "severity": "error",
            "human": "Identities valid must not be empty",
            "expression": "identities.empty().not()",
            "source": "http://openehr.org/fhir/StructureDefinition/PARTY"
          },
          {
            "key": "Contacts_valid",
            "severity": "error",
            "human": "Contacts valid must be present",
            "expression": "contacts.exists() implies contacts.empty().not()",
            "source": "http://openehr.org/fhir/StructureDefinition/PARTY"
          },
          {
            "key": "Relationships_validity",
            "severity": "error",
            "human": "Relationships validity must be present",
            "expression": "relationships.exists() implies (relationships.empty().not() and then relationships.for_all (r | r.source = self)",
            "source": "http://openehr.org/fhir/StructureDefinition/PARTY"
          },
          {
            "key": "Reverse_relationships_validity",
            "severity": "error",
            "human": "Reverse relationships validity must be present",
            "expression": "reverse_relationships.exists() implies (reverse_relationships.empty().not() and then reverse_relationships.for_all (item | repository (\\\"demographics\\\").all_party_relationships.has_object (item) and then repository(\\\"demographics\\\").all_party_relationships.object (item).target = self))",
            "source": "http://openehr.org/fhir/StructureDefinition/PARTY"
          },
          {
            "key": "Is_archetype_root",
            "severity": "error",
            "human": "Is archetype root",
            "expression": "is_archetype_root()",
            "source": "http://openehr.org/fhir/StructureDefinition/PARTY"
          },
          {
            "key": "Uid_mandatory",
            "severity": "error",
            "human": "Uid mandatory must be present",
            "expression": "uid.exists()",
            "source": "http://openehr.org/fhir/StructureDefinition/PARTY"
          },
          {
            "key": "Capabilities_valid",
            "severity": "error",
            "human": "Capabilities valid must be present",
            "expression": "capabilities.exists() implies capabilities.empty().not()"
          }
        ],
        "isModifier": false,
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "id": "ROLE.name",
        "path": "ROLE.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": "ROLE.archetype-node-id",
        "path": "ROLE.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": "ROLE.uid",
        "path": "ROLE.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": "ROLE.links",
        "path": "ROLE.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": "ROLE.archetype-details",
        "path": "ROLE.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": "ROLE.feeder-audit",
        "path": "ROLE.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": "ROLE.identities",
        "path": "ROLE.identities",
        "short": "Identities used by the party to identify itself, such as legal name, stage names, aliases, nicknames and so on.",
        "definition": "Identities used by the party to identify itself, such as legal name, stage names, aliases, nicknames and so on.",
        "min": 1,
        "max": "*",
        "base": {
          "path": "PARTY.identities",
          "min": 1,
          "max": "*"
        },
        "type": [
          {
            "code": "http://openehr.org/fhir/StructureDefinition/PARTY-IDENTITY"
          }
        ],
        "isModifier": false
      },
      {
        "id": "ROLE.contacts",
        "path": "ROLE.contacts",
        "short": "Contacts for this party.",
        "definition": "Contacts for this party.",
        "min": 0,
        "max": "*",
        "base": {
          "path": "PARTY.contacts",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "http://openehr.org/fhir/StructureDefinition/CONTACT"
          }
        ],
        "isModifier": false
      },
      {
        "id": "ROLE.details",
        "path": "ROLE.details",
        "short": "All other details for this Party.",
        "definition": "All other details for this Party.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "PARTY.details",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "http://openehr.org/fhir/StructureDefinition/ITEM-STRUCTURE"
          }
        ],
        "isModifier": false
      },
      {
        "id": "ROLE.reverse-relationships",
        "path": "ROLE.reverse_relationships",
        "short": "References to relationships in which this Party takes part as target.",
        "definition": "References to relationships in which this Party takes part as target.",
        "min": 0,
        "max": "*",
        "base": {
          "path": "PARTY.reverse_relationships",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "http://openehr.org/fhir/StructureDefinition/LOCATABLE-REF"
          }
        ],
        "isModifier": false
      },
      {
        "id": "ROLE.relationships",
        "path": "ROLE.relationships",
        "short": "Relationships in which this Party takes part as source.",
        "definition": "Relationships in which this Party takes part as source.",
        "min": 0,
        "max": "*",
        "base": {
          "path": "PARTY.relationships",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "http://openehr.org/fhir/StructureDefinition/PARTY-RELATIONSHIP"
          }
        ],
        "isModifier": false
      },
      {
        "id": "ROLE.time-validity",
        "path": "ROLE.time_validity",
        "short": "Valid time interval for this role.",
        "definition": "Valid time interval for this role.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "ROLE.time_validity",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "extension": [
              {
                "extension": [
                  {
                    "url": "name",
                    "valueCode": "T"
                  },
                  {
                    "url": "type",
                    "valueUri": "http://openehr.org/fhir/StructureDefinition/DV-DATE"
                  }
                ],
                "url": "http://hl7.org/fhir/tools/StructureDefinition/type-parameter"
              }
            ],
            "code": "http://openehr.org/fhir/StructureDefinition/DV-INTERVAL"
          }
        ],
        "isModifier": false
      },
      {
        "id": "ROLE.performer",
        "path": "ROLE.performer",
        "short": "Reference to Version container of Actor playing the role.",
        "definition": "Reference to Version container of Actor playing the role.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "ROLE.performer",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "http://openehr.org/fhir/StructureDefinition/PARTY-REF"
          }
        ],
        "isModifier": false
      },
      {
        "id": "ROLE.capabilities",
        "path": "ROLE.capabilities",
        "short": "The capabilities of this role.",
        "definition": "The capabilities of this role.",
        "min": 0,
        "max": "*",
        "base": {
          "path": "ROLE.capabilities",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "http://openehr.org/fhir/StructureDefinition/CAPABILITY"
          }
        ],
        "isModifier": false
      }
    ]
  },
  "differential": {
    "element": [
      {
        "id": "ROLE",
        "path": "ROLE",
        "short": "Generic description of a role performed by an Actor.",
        "definition": "Generic description of a role performed by an Actor. The role corresponds to a competency of the Party. Roles are used to define the responsibilities undertaken by a Party for a purpose. Roles should have credentials qualifying the performer to perform the role.",
        "min": 0,
        "max": "*",
        "constraint": [
          {
            "key": "Capabilities_valid",
            "severity": "error",
            "human": "Capabilities valid must be present",
            "expression": "capabilities.exists() implies capabilities.empty().not()"
          }
        ],
        "isModifier": false
      },
      {
        "id": "ROLE.time-validity",
        "path": "ROLE.time_validity",
        "short": "Valid time interval for this role.",
        "definition": "Valid time interval for this role.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "extension": [
              {
                "extension": [
                  {
                    "url": "name",
                    "valueCode": "T"
                  },
                  {
                    "url": "type",
                    "valueUri": "http://openehr.org/fhir/StructureDefinition/DV-DATE"
                  }
                ],
                "url": "http://hl7.org/fhir/tools/StructureDefinition/type-parameter"
              }
            ],
            "code": "http://openehr.org/fhir/StructureDefinition/DV-INTERVAL"
          }
        ],
        "isModifier": false
      },
      {
        "id": "ROLE.performer",
        "path": "ROLE.performer",
        "short": "Reference to Version container of Actor playing the role.",
        "definition": "Reference to Version container of Actor playing the role.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "http://openehr.org/fhir/StructureDefinition/PARTY-REF"
          }
        ],
        "isModifier": false
      },
      {
        "id": "ROLE.capabilities",
        "path": "ROLE.capabilities",
        "short": "The capabilities of this role.",
        "definition": "The capabilities of this role.",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "http://openehr.org/fhir/StructureDefinition/CAPABILITY"
          }
        ],
        "isModifier": false
      }
    ]
  }
}