Resource Profile: Proxy Permission
General information
Scope and Usage
This profile can be used to describe a related person having permission to perform activities on behalf of a patient. If the activities are to be performed on patient data, the data can be defined in various ways using the profile.
This information is supplied in the rule element. One or more activities have to be supplied in the rule.activity.action element, along with the rule.activity.actor element referencing the related person permitted to perform the activities. The data on which the activies can be performed should go in the rule.data element. Note that all actions supplied in the activity element are permitted to be performed on the data supplied in the data element. To express an additional set of actions that are permitted to another data set, another Permission instance has to be created.
Profile
| ProxyPermissionPs (Permission) | C | Permission | |
| id | Σ | 0..1 | id |
| meta | Σ | 0..1 | Meta |
| implicitRules | Σ ?! | 0..1 | uri |
| language | 0..1 | codeBinding | |
| text | C | 0..1 | Narrative |
| contained | C | 0..* | Resource |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| status | S Σ | 1..1 | codeBinding |
| asserter | S Σ C | 1..1 | Reference(PatientDataAccess) |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| reference | Σ C | 0..1 | string |
| type | Σ | 0..1 | uriBinding |
| identifier | S Σ C | 1..1 | Identifier |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| use | Σ ?! | 0..1 | codeBinding |
| type | Σ | 0..1 | CodeableConceptBinding |
| system | S Σ | 1..1 | uri |
| value | S Σ C | 1..1 | string |
| period | Σ C | 0..1 | Period |
| assigner | Σ C | 0..1 | Reference(Organization) |
| display | Σ C | 0..1 | string |
| date | S Σ C | 1..1 | dateTime |
| validity | S Σ C | 1..1 | Period |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| start | S Σ C | 1..1 | dateTime |
| end | S Σ C | 0..1 | dateTime |
| justification | S Σ | 0..1 | BackboneElement |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| basis | Σ | 0..* | CodeableConcept |
| evidence | S Σ C | 1..1 | Reference(PowerOfAttorneyPoa | RelatedPersonDataAccess) |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| reference | S Σ C | 1..1 | string |
| type | Σ | 0..1 | uriBinding |
| identifier | Σ C | 0..1 | Identifier |
| display | Σ C | 0..1 | string |
| combining | S Σ ?! | 1..1 | codeBindingFixed Value |
| rule | S Σ | 1..1 | BackboneElement |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| type | S Σ ?! | 1..1 | codeBindingFixed Value |
| data | S Σ | 0..1 | BackboneElement |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| documentType | S C | 0..* | Extension(CodeableConcept) |
| id | 0..1 | string | |
| extension | C | 0..0 | Extension |
| url | 1..1 | uriFixed Value | |
| value[x] | S C | 1..1 | CodeableConceptBinding |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| coding | S Σ C | 1..1 | Coding |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| system | S Σ | 1..1 | uri |
| version | Σ | 0..1 | string |
| code | S Σ C | 1..1 | code |
| display | Σ C | 0..1 | string |
| userSelected | Σ | 0..1 | boolean |
| text | Σ | 0..1 | string |
| modifierExtension | Σ ?! C | 0..* | Extension |
| resource | S Σ | 0..* | BackboneElement |
| (All Slices) | |||
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| meaning | S Σ | 1..1 | codeBinding |
| reference | S Σ C | 1..1 | Reference(Resource) |
| fromCaregiverOrUnit | S Σ | 0..* | BackboneElement |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| meaning | S Σ | 1..1 | codeBindingFixed Value |
| reference | S Σ C | 1..1 | Reference(OrganizationDataAccess) |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| reference | S Σ C | 0..1 | string |
| type | Σ | 0..1 | uriBinding |
| identifier | S Σ C | 0..1 | Identifier |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| use | Σ ?! | 0..1 | codeBinding |
| type | Σ | 0..1 | CodeableConceptBinding |
| system | S Σ | 1..1 | uri |
| value | S Σ C | 1..1 | string |
| period | Σ C | 0..1 | Period |
| assigner | Σ C | 0..1 | Reference(Organization) |
| display | Σ C | 0..1 | string |
| security | Σ C | 0..* | Coding |
| period | S Σ C | 0..1 | Period |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| start | S Σ C | 0..1 | dateTime |
| end | S Σ C | 0..1 | dateTime |
| expression | Σ C | 0..1 | Expression |
| activity | S Σ | 1..1 | BackboneElement |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| actor | S Σ C | 1..1 | Reference(RelatedPersonDataAccess) |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| reference | Σ C | 0..1 | string |
| type | Σ | 0..1 | uriBinding |
| identifier | S Σ C | 1..1 | Identifier |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| use | Σ ?! | 0..1 | codeBinding |
| type | Σ | 0..1 | CodeableConceptBinding |
| system | S Σ | 1..1 | uri |
| value | S Σ C | 1..1 | string |
| period | Σ C | 0..1 | Period |
| assigner | Σ C | 0..1 | Reference(Organization) |
| display | Σ C | 0..1 | string |
| action | S Σ | 1..* | CodeableConceptBinding |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| coding | S Σ C | 1..1 | Coding |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| system | S Σ | 1..1 | uri |
| version | Σ | 0..1 | string |
| code | S Σ C | 1..1 | code |
| display | Σ C | 0..1 | string |
| userSelected | Σ | 0..1 | boolean |
| text | Σ | 0..1 | string |
| purpose | Σ | 0..* | CodeableConceptBinding |
| limit | Σ | 0..* | CodeableConcept |
| Permission | C | |
| Short | Access Rules | |
| Definition | Permission resource holds access rules for a given data and context. | |
| Cardinality | 0..* | |
| Constraints |
| |
| Mappings |
| |
| Permission.id | Σ | |
| Short | Logical id of this artifact | |
| Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | |
| Cardinality | 0..1 | |
| Type | id | |
| Summary | True | |
| Comments | Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case. | |
| Constraints |
| |
| Mappings |
| |
| Permission.meta | Σ | |
| Short | Metadata about the resource | |
| Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. | |
| Cardinality | 0..1 | |
| Type | Meta | |
| Summary | True | |
| Constraints |
| |
| Mappings |
| |
| Permission.implicitRules | Σ ?! | |
| Short | A set of rules under which this content was created | |
| Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | |
| Cardinality | 0..1 | |
| Type | uri | |
| Modifier | True | |
| Summary | True | |
| Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc. | |
| Constraints |
| |
| Mappings |
| |
| Permission.language | ||
| Short | Language of the resource content | |
| Definition | The base language in which the resource is written. | |
| Cardinality | 0..1 | |
| Type | code | |
| Binding | IETF language tag for a human language | |
| Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). | |
| Constraints |
| |
| Mappings |
| |
| Permission.text | C | |
| Short | Text summary of the resource, for human interpretation | |
| Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. | |
| Cardinality | 0..1 | |
| Type | Narrative | |
| Alias | narrative, html, xhtml, display | |
| Comments | Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. | |
| Conditions | The cardinality or value of this element may be affected by these constraints: dom-6 | |
| Constraints |
| |
| Mappings |
| |
| Permission.contained | C | |
| Short | Contained, inline Resources | |
| Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. | |
| Cardinality | 0..* | |
| Type | Resource | |
| Alias | inline resources, anonymous resources, contained resources | |
| Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels. | |
| Conditions | The cardinality or value of this element may be affected by these constraints: dom-2, dom-4, dom-3, dom-5 | |
| Mappings |
| |
| Permission.extension | C | |
| Short | Additional content defined by implementations | |
| Definition | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | |
| Cardinality | 0..* | |
| Type | Extension | |
| Alias | extensions, user content | |
| 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. | |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | |
| Constraints |
| |
| Mappings |
| |
| Permission.modifierExtension | Σ ?! C | |
| Short | Extensions that cannot be ignored | |
| Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | |
| Cardinality | 0..* | |
| Type | Extension | |
| Modifier | True | |
| Summary | True | |
| Alias | extensions, user content | |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | |
| 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. | |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | |
| Constraints |
| |
| Mappings |
| |
| Permission.status | S Σ | |
| Short | active | rejected | |
| Definition | Status. | |
| Cardinality | 1..1 | |
| Type | code | |
| Binding | Codes identifying the lifecycle stage of a product. | |
| Must Support | True | |
| Summary | True | |
| Comments | Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size | |
| Constraints |
| |
| Mappings |
| |
| Permission.asserter | S Σ C | |
| Short | The person or entity that asserts the permission | |
| Definition | The person or entity that asserts the permission. | |
| Cardinality | 1..1 | |
| Type | Reference(PatientDataAccess) | |
| Must Support | True | |
| Summary | True | |
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | |
| Constraints |
| |
| Mappings |
| |
| Permission.asserter.id | ||
| Short | Unique id for inter-element referencing | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
| Cardinality | 0..1 | |
| Type | string | |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |
| Mappings |
| |
| Permission.asserter.extension | C | |
| 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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | |
| Cardinality | 0..* | |
| Type | Extension | |
| Alias | extensions, user content | |
| 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. | |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | |
| Constraints |
| |
| Mappings |
| |
| Permission.asserter.reference | Σ C | |
| Short | Literal reference, Relative, internal or absolute URL | |
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. | |
| Cardinality | 0..1 | |
| Type | string | |
| Summary | True | |
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. | |
| Conditions | The cardinality or value of this element may be affected by these constraints: ref-2, ref-1 | |
| Constraints |
| |
| Mappings |
| |
| Permission.asserter.type | Σ | |
| Short | Type the reference refers to (e.g. "Patient") - must be a resource in resources | |
| Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). | |
| Cardinality | 0..1 | |
| Type | uri | |
| Binding | Aa resource (or, for logical models, the URI of the logical model). | |
| Summary | True | |
| Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference. | |
| Constraints |
| |
| Mappings |
| |
| Permission.asserter.identifier | S Σ C | |
| Short | Logical reference, when literal reference is not known | |
| Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. | |
| Cardinality | 1..1 | |
| Type | Identifier | |
| Must Support | True | |
| Summary | True | |
| Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). This element only allows for a single identifier. In the case where additional identifers are required, use the http://hl7.org/fhir/StructureDefinition/additionalIdentifier extension. | |
| Conditions | The cardinality or value of this element may be affected by these constraints: ref-2 | |
| Constraints |
| |
| Mappings |
| |
| Permission.asserter.identifier.id | ||
| Short | Unique id for inter-element referencing | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
| Cardinality | 0..1 | |
| Type | string | |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |
| Mappings |
| |
| Permission.asserter.identifier.extension | C | |
| 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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | |
| Cardinality | 0..* | |
| Type | Extension | |
| Alias | extensions, user content | |
| 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. | |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | |
| Constraints |
| |
| Mappings |
| |
| Permission.asserter.identifier.use | Σ ?! | |
| Short | usual | official | temp | secondary | old (If known) | |
| Definition | The purpose of this identifier. | |
| Cardinality | 0..1 | |
| Type | code | |
| Binding | Identifies the purpose for this identifier, if known . | |
| Modifier | True | |
| Summary | True | |
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | |
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. | |
| Constraints |
| |
| Mappings |
| |
| Permission.asserter.identifier.type | Σ | |
| Short | Description of identifier | |
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. | |
| Cardinality | 0..1 | |
| Type | CodeableConcept | |
| Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | |
| Summary | True | |
| Requirements | Allows users to make use of identifiers when the identifier system is not known. | |
| Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. | |
| Constraints |
| |
| Mappings |
| |
| Permission.asserter.identifier.system | S Σ | |
| Short | The namespace for the identifier value | |
| Definition | Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique. | |
| Cardinality | 1..1 | |
| Type | uri | |
| Must Support | True | |
| Summary | True | |
| Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. | |
| Comments | Identifier.system is always case sensitive. | |
| Constraints |
| |
| Examples | Generalhttp://www.acme.com/identifiers/patient | |
| Mappings |
| |
| Permission.asserter.identifier.value | S Σ C | |
| Short | The value that is unique | |
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | |
| Cardinality | 1..1 | |
| Type | string | |
| Must Support | True | |
| Summary | True | |
| Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. | |
| Conditions | The cardinality or value of this element may be affected by these constraints: ident-1 | |
| Constraints |
| |
| Examples | General123456 | |
| Mappings |
| |
| Permission.asserter.identifier.period | Σ C | |
| Short | Time period when id is/was valid for use | |
| Definition | Time period during which identifier is/was valid for use. | |
| Cardinality | 0..1 | |
| Type | Period | |
| Summary | True | |
| Comments | 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"). Period is not used for a duration (a measure of elapsed time). See Duration. | |
| Constraints |
| |
| Mappings |
| |
| Permission.asserter.identifier.assigner | Σ C | |
| Short | Organization that issued id (may be just text) | |
| Definition | Organization that issued/manages the identifier. | |
| Cardinality | 0..1 | |
| Type | Reference(Organization) | |
| Summary | True | |
| Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. | |
| Constraints |
| |
| Mappings |
| |
| Permission.asserter.display | Σ C | |
| Short | Text alternative for the resource | |
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. | |
| Cardinality | 0..1 | |
| Type | string | |
| Summary | True | |
| Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. | |
| Conditions | The cardinality or value of this element may be affected by these constraints: ref-2 | |
| Constraints |
| |
| Mappings |
| |
| Permission.date | S Σ C | |
| Short | The date that permission was asserted | |
| Definition | The date that permission was asserted. | |
| Cardinality | 1..1 | |
| Type | dateTime | |
| Must Support | True | |
| Summary | True | |
| Alias | class | |
| Comments | UTC offset is allowed for dates and partial dates | |
| Constraints |
| |
| Mappings |
| |
| Permission.validity | S Σ C | |
| Short | The period in which the permission is active | |
| Definition | The period in which the permission is active. | |
| Cardinality | 1..1 | |
| Type | Period | |
| Must Support | True | |
| Summary | True | |
| Alias | type | |
| Comments | 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"). Period is not used for a duration (a measure of elapsed time). See Duration. | |
| Constraints |
| |
| Mappings |
| |
| Permission.validity.id | ||
| Short | Unique id for inter-element referencing | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
| Cardinality | 0..1 | |
| Type | string | |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |
| Mappings |
| |
| Permission.validity.extension | C | |
| 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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | |
| Cardinality | 0..* | |
| Type | Extension | |
| Alias | extensions, user content | |
| 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. | |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | |
| Constraints |
| |
| Mappings |
| |
| Permission.validity.start | S Σ C | |
| Short | Starting time with inclusive boundary | |
| Definition | The start of the period. The boundary is inclusive. | |
| Cardinality | 1..1 | |
| Type | dateTime | |
| Must Support | True | |
| Summary | True | |
| Comments | If the low element is missing, the meaning is that the low boundary is not known. | |
| Conditions | The cardinality or value of this element may be affected by these constraints: per-1 | |
| Constraints |
| |
| Mappings |
| |
| Permission.validity.end | S Σ C | |
| Short | End time with inclusive boundary, if not ongoing | |
| Definition | The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. 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. | |
| Cardinality | 0..1 | |
| Type | dateTime | |
| Must Support | True | |
| Summary | True | |
| Comments | The end value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03. | |
| Meaning when missing | If the end of the period is missing, it means that the period is ongoing | |
| Conditions | The cardinality or value of this element may be affected by these constraints: per-1 | |
| Constraints |
| |
| Mappings |
| |
| Permission.justification | S Σ | |
| Short | The asserted justification for using the data | |
| Definition | The asserted justification for using the data. | |
| Cardinality | 0..1 | |
| Type | BackboneElement | |
| Must Support | True | |
| Summary | True | |
| Constraints |
| |
| Mappings |
| |
| Permission.justification.id | ||
| Short | Unique id for inter-element referencing | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
| Cardinality | 0..1 | |
| Type | string | |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |
| Mappings |
| |
| Permission.justification.extension | C | |
| 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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | |
| Cardinality | 0..* | |
| Type | Extension | |
| Alias | extensions, user content | |
| 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. | |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | |
| Constraints |
| |
| Mappings |
| |
| Permission.justification.modifierExtension | Σ ?! C | |
| Short | Extensions that cannot be ignored even if unrecognized | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | |
| Cardinality | 0..* | |
| Type | Extension | |
| Modifier | True | |
| Summary | True | |
| Alias | extensions, user content, modifiers | |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | |
| 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. | |
| Constraints |
| |
| Mappings |
| |
| Permission.justification.basis | Σ | |
| Short | The regulatory grounds upon which this Permission builds | |
| Definition | This would be a codeableconcept, or a coding, which can be constrained to , for example, the 6 grounds for processing in GDPR. | |
| Cardinality | 0..* | |
| Type | CodeableConcept | |
| Binding | Regulatory policy examples | |
| Summary | True | |
| Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. | |
| Constraints |
| |
| Mappings |
| |
| Permission.justification.evidence | S Σ C | |
| Short | Justifing rational | |
| Definition | Justifing rational. | |
| Cardinality | 1..1 | |
| Type | Reference(PowerOfAttorneyPoa | RelatedPersonDataAccess) | |
| Must Support | True | |
| Summary | True | |
| Comments | Reference Consent (PowerOfAttorney) for legal justification. Reference RelatedPerson when relationship to patient, eg guardian, justifies permission | |
| Constraints |
| |
| Mappings |
| |
| Permission.justification.evidence.id | ||
| Short | Unique id for inter-element referencing | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
| Cardinality | 0..1 | |
| Type | string | |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |
| Mappings |
| |
| Permission.justification.evidence.extension | C | |
| 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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | |
| Cardinality | 0..* | |
| Type | Extension | |
| Alias | extensions, user content | |
| 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. | |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | |
| Constraints |
| |
| Mappings |
| |
| Permission.justification.evidence.reference | S Σ C | |
| Short | Literal reference, Relative, internal or absolute URL | |
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. | |
| Cardinality | 1..1 | |
| Type | string | |
| Must Support | True | |
| Summary | True | |
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. | |
| Conditions | The cardinality or value of this element may be affected by these constraints: ref-2, ref-1 | |
| Constraints |
| |
| Mappings |
| |
| Permission.justification.evidence.type | Σ | |
| Short | Type the reference refers to (e.g. "Patient") - must be a resource in resources | |
| Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). | |
| Cardinality | 0..1 | |
| Type | uri | |
| Binding | Aa resource (or, for logical models, the URI of the logical model). | |
| Summary | True | |
| Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference. | |
| Constraints |
| |
| Mappings |
| |
| Permission.justification.evidence.identifier | Σ C | |
| Short | Logical reference, when literal reference is not known | |
| Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. | |
| Cardinality | 0..1 | |
| Type | Identifier | |
| Summary | True | |
| Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). This element only allows for a single identifier. In the case where additional identifers are required, use the http://hl7.org/fhir/StructureDefinition/additionalIdentifier extension. | |
| Conditions | The cardinality or value of this element may be affected by these constraints: ref-2 | |
| Constraints |
| |
| Mappings |
| |
| Permission.justification.evidence.display | Σ C | |
| Short | Text alternative for the resource | |
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. | |
| Cardinality | 0..1 | |
| Type | string | |
| Summary | True | |
| Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. | |
| Conditions | The cardinality or value of this element may be affected by these constraints: ref-2 | |
| Constraints |
| |
| Mappings |
| |
| Permission.combining | S Σ ?! | |
| Short | deny-overrides | permit-overrides | ordered-deny-overrides | ordered-permit-overrides | deny-unless-permit | permit-unless-deny | |
| Definition | Defines a procedure for arriving at an access decision given the set of rules. | |
| Cardinality | 1..1 | |
| Type | code | |
| Binding | How the rules are to be combined. | |
| Must Support | True | |
| Modifier | True | |
| Summary | True | |
| Comments | ||
| Constraints |
| |
| Fixed Value | deny-unless-permit | |
| Mappings |
| |
| Permission.rule | S Σ | |
| Short | Constraints to the Permission | |
| Definition | A set of rules. | |
| Cardinality | 1..1 | |
| Type | BackboneElement | |
| Must Support | True | |
| Summary | True | |
| Constraints |
| |
| Mappings |
| |
| Permission.rule.id | ||
| Short | Unique id for inter-element referencing | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
| Cardinality | 0..1 | |
| Type | string | |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |
| Mappings |
| |
| Permission.rule.extension | C | |
| 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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | |
| Cardinality | 0..* | |
| Type | Extension | |
| Alias | extensions, user content | |
| 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. | |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | |
| Constraints |
| |
| Mappings |
| |
| Permission.rule.modifierExtension | Σ ?! C | |
| Short | Extensions that cannot be ignored even if unrecognized | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | |
| Cardinality | 0..* | |
| Type | Extension | |
| Modifier | True | |
| Summary | True | |
| Alias | extensions, user content, modifiers | |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | |
| 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. | |
| Constraints |
| |
| Mappings |
| |
| Permission.rule.type | S Σ ?! | |
| Short | deny | permit | |
| Definition | deny | permit. | |
| Cardinality | 1..1 | |
| Type | code | |
| Binding | How a rule statement is applied. | |
| Must Support | True | |
| Modifier | True | |
| Summary | True | |
| Comments | Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size | |
| Constraints |
| |
| Fixed Value | permit | |
| Mappings |
| |
| Permission.rule.data | S Σ | |
| Short | The selection criteria to identify data that is within scope of this provision | |
| Definition | A description or definition of which activities are allowed to be done on the data. | |
| Cardinality | 0..1 | |
| Type | BackboneElement | |
| Must Support | True | |
| Summary | True | |
| Constraints |
| |
| Mappings |
| |
| Permission.rule.data.id | ||
| Short | Unique id for inter-element referencing | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
| Cardinality | 0..1 | |
| Type | string | |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |
| Mappings |
| |
| Permission.rule.data.extension | C | |
| 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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | |
| Cardinality | 0..* | |
| Type | Extension | |
| Alias | extensions, user content | |
| 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. | |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | |
| Constraints |
| |
| Mappings |
| |
| Permission.rule.data.extension:documentType | S C | |
| Short | Permission Data Document Type (PS) | |
| Definition | Extension for Permission rule data to express type of data. | |
| Cardinality | 0..* | |
| Type | Extension(CodeableConcept) | |
| Must Support | True | |
| Alias | extensions, user content | |
| 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. | |
| Constraints |
| |
| Mappings |
| |
| Permission.rule.data.extension:documentType.id | ||
| Short | Unique id for inter-element referencing | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
| Cardinality | 0..1 | |
| Type | string | |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |
| Mappings |
| |
| Permission.rule.data.extension:documentType.extension | C | |
| 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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | |
| Cardinality | 0..0 | |
| Type | Extension | |
| Alias | extensions, user content | |
| 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. | |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | |
| Constraints |
| |
| Mappings |
| |
| Permission.rule.data.extension:documentType.url | ||
| Short | identifies the meaning of the extension | |
| Definition | Source of the definition for the extension code - a logical name or a URL. | |
| Cardinality | 1..1 | |
| Type | uri | |
| 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 SHALL be a URI for the Structure Definition defining the extension. | |
| Fixed Value | http://electronichealth.se/fhir/NDI/StructureDefinition/permission-data-document-type-ps | |
| Mappings |
| |
| Permission.rule.data.extension:documentType.value[x] | S C | |
| Short | Value of extension | |
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | |
| Cardinality | 1..1 | |
| Type | CodeableConcept | |
| Binding | ||
| Must Support | True | |
| Conditions | The cardinality or value of this element may be affected by these constraints: ext-1 | |
| Constraints |
| |
| Mappings |
| |
| Permission.rule.data.extension:documentType.value[x].id | ||
| Short | Unique id for inter-element referencing | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
| Cardinality | 0..1 | |
| Type | string | |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |
| Mappings |
| |
| Permission.rule.data.extension:documentType.value[x].extension | C | |
| 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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | |
| Cardinality | 0..* | |
| Type | Extension | |
| Alias | extensions, user content | |
| 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. | |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | |
| Constraints |
| |
| Mappings |
| |
| Permission.rule.data.extension:documentType.value[x].coding | S Σ C | |
| Short | Code defined by a terminology system | |
| Definition | A reference to a code defined by a terminology system. | |
| Cardinality | 1..1 | |
| Type | Coding | |
| Must Support | True | |
| Summary | True | |
| Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | |
| Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. | |
| Constraints |
| |
| Mappings |
| |
| Permission.rule.data.extension:documentType.value[x].coding.id | ||
| Short | Unique id for inter-element referencing | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
| Cardinality | 0..1 | |
| Type | string | |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |
| Mappings |
| |
| Permission.rule.data.extension:documentType.value[x].coding.extension | C | |
| 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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | |
| Cardinality | 0..* | |
| Type | Extension | |
| Alias | extensions, user content | |
| 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. | |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | |
| Constraints |
| |
| Mappings |
| |
| Permission.rule.data.extension:documentType.value[x].coding.system | S Σ | |
| Short | Identity of the terminology system | |
| Definition | The identification of the code system that defines the meaning of the symbol in the code. | |
| Cardinality | 1..1 | |
| Type | uri | |
| Must Support | True | |
| Summary | True | |
| Requirements | Need to be unambiguous about the source of the definition of the symbol. | |
| Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously. | |
| Constraints |
| |
| Mappings |
| |
| Permission.rule.data.extension:documentType.value[x].coding.version | Σ | |
| Short | Version of the system - if relevant | |
| Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. | |
| Cardinality | 0..1 | |
| Type | string | |
| Summary | True | |
| Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. | |
| Constraints |
| |
| Mappings |
| |
| Permission.rule.data.extension:documentType.value[x].coding.code | S Σ C | |
| Short | Symbol in syntax defined by the system | |
| Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). | |
| Cardinality | 1..1 | |
| Type | code | |
| Must Support | True | |
| Summary | True | |
| Requirements | Need to refer to a particular code in the system. | |
| Comments | Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size | |
| Conditions | The cardinality or value of this element may be affected by these constraints: cod-1 | |
| Constraints |
| |
| Mappings |
| |
| Permission.rule.data.extension:documentType.value[x].coding.display | Σ C | |
| Short | Representation defined by the system | |
| Definition | A representation of the meaning of the code in the system, following the rules of the system. | |
| Cardinality | 0..1 | |
| Type | string | |
| Summary | True | |
| Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | |
| Comments | Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size | |
| Conditions | The cardinality or value of this element may be affected by these constraints: cod-1 | |
| Constraints |
| |
| Mappings |
| |
| Permission.rule.data.extension:documentType.value[x].coding.userSelected | Σ | |
| Short | If this coding was chosen directly by the user | |
| Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). | |
| Cardinality | 0..1 | |
| Type | boolean | |
| Summary | True | |
| Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. | |
| Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. | |
| Constraints |
| |
| Mappings |
| |
| Permission.rule.data.extension:documentType.value[x].text | Σ | |
| Short | Plain text representation of the concept | |
| Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. | |
| Cardinality | 0..1 | |
| Type | string | |
| Summary | True | |
| Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. | |
| Comments | Very often the text is the same as a displayName of one of the codings. | |
| Constraints |
| |
| Mappings |
| |
| Permission.rule.data.modifierExtension | Σ ?! C | |
| Short | Extensions that cannot be ignored even if unrecognized | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | |
| Cardinality | 0..* | |
| Type | Extension | |
| Modifier | True | |
| Summary | True | |
| Alias | extensions, user content, modifiers | |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | |
| 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. | |
| Constraints |
| |
| Mappings |
| |
| Permission.rule.data.resource | S Σ | |
| Short | Explicit FHIR Resource references | |
| Definition | Explicit FHIR Resource references. | |
| Cardinality | 0..* | |
| Type | BackboneElement | |
| Must Support | True | |
| Summary | True | |
| Slicing | Unordered, Open, by meaning(Value) Slice data based on meaning | |
| Constraints |
| |
| Mappings |
| |
| Permission.rule.data.resource.id | ||
| Short | Unique id for inter-element referencing | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
| Cardinality | 0..1 | |
| Type | string | |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |
| Mappings |
| |
| Permission.rule.data.resource.extension | C | |
| 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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | |
| Cardinality | 0..* | |
| Type | Extension | |
| Alias | extensions, user content | |
| 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. | |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | |
| Constraints |
| |
| Mappings |
| |
| Permission.rule.data.resource.modifierExtension | Σ ?! C | |
| Short | Extensions that cannot be ignored even if unrecognized | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | |
| Cardinality | 0..* | |
| Type | Extension | |
| Modifier | True | |
| Summary | True | |
| Alias | extensions, user content, modifiers | |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | |
| 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. | |
| Constraints |
| |
| Mappings |
| |
| Permission.rule.data.resource.meaning | S Σ | |
| Short | instance | related | dependents | authoredby | |
| Definition | How the resource reference is interpreted when testing consent restrictions. | |
| Cardinality | 1..1 | |
| Type | code | |
| Binding | How a resource reference is interpreted when testing consent restrictions. | |
| Must Support | True | |
| Summary | True | |
| Comments | Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size | |
| Constraints |
| |
| Mappings |
| |
| Permission.rule.data.resource.reference | S Σ C | |
| Short | The actual data reference | |
| Definition | A reference to a specific resource that defines which resources are covered by this consent. | |
| Cardinality | 1..1 | |
| Type | Reference(Resource) | |
| Must Support | True | |
| Summary | True | |
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | |
| Constraints |
| |
| Mappings |
| |
| Permission.rule.data.resource:fromCaregiverOrUnit | S Σ | |
| Short | Explicit FHIR Resource references | |
| Definition | Explicit FHIR Resource references. | |
| Cardinality | 0..* | |
| Type | BackboneElement | |
| Must Support | True | |
| Summary | True | |
| Constraints |
| |
| Mappings |
| |
| Permission.rule.data.resource:fromCaregiverOrUnit.id | ||
| Short | Unique id for inter-element referencing | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
| Cardinality | 0..1 | |
| Type | string | |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |
| Mappings |
| |
| Permission.rule.data.resource:fromCaregiverOrUnit.extension | C | |
| 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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | |
| Cardinality | 0..* | |
| Type | Extension | |
| Alias | extensions, user content | |
| 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. | |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | |
| Constraints |
| |
| Mappings |
| |
| Permission.rule.data.resource:fromCaregiverOrUnit.modifierExtension | Σ ?! C | |
| Short | Extensions that cannot be ignored even if unrecognized | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | |
| Cardinality | 0..* | |
| Type | Extension | |
| Modifier | True | |
| Summary | True | |
| Alias | extensions, user content, modifiers | |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | |
| 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. | |
| Constraints |
| |
| Mappings |
| |
| Permission.rule.data.resource:fromCaregiverOrUnit.meaning | S Σ | |
| Short | instance | related | dependents | authoredby | |
| Definition | How the resource reference is interpreted when testing consent restrictions. | |
| Cardinality | 1..1 | |
| Type | code | |
| Binding | How a resource reference is interpreted when testing consent restrictions. | |
| Must Support | True | |
| Summary | True | |
| Comments | Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size | |
| Constraints |
| |
| Fixed Value | authoredby | |
| Mappings |
| |
| Permission.rule.data.resource:fromCaregiverOrUnit.reference | S Σ C | |
| Short | The actual data reference | |
| Definition | A reference to a specific resource that defines which resources are covered by this consent. | |
| Cardinality | 1..1 | |
| Type | Reference(OrganizationDataAccess) | |
| Must Support | True | |
| Summary | True | |
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | |
| Constraints |
| |
| Mappings |
| |
| Permission.rule.data.resource:fromCaregiverOrUnit.reference.id | ||
| Short | Unique id for inter-element referencing | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
| Cardinality | 0..1 | |
| Type | string | |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |
| Mappings |
| |
| Permission.rule.data.resource:fromCaregiverOrUnit.reference.extension | C | |
| 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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | |
| Cardinality | 0..* | |
| Type | Extension | |
| Alias | extensions, user content | |
| 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. | |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | |
| Constraints |
| |
| Mappings |
| |
| Permission.rule.data.resource:fromCaregiverOrUnit.reference.reference | S Σ C | |
| Short | Literal reference, Relative, internal or absolute URL | |
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. | |
| Cardinality | 0..1 | |
| Type | string | |
| Must Support | True | |
| Summary | True | |
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. | |
| Conditions | The cardinality or value of this element may be affected by these constraints: ref-2, ref-1 | |
| Constraints |
| |
| Mappings |
| |
| Permission.rule.data.resource:fromCaregiverOrUnit.reference.type | Σ | |
| Short | Type the reference refers to (e.g. "Patient") - must be a resource in resources | |
| Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). | |
| Cardinality | 0..1 | |
| Type | uri | |
| Binding | Aa resource (or, for logical models, the URI of the logical model). | |
| Summary | True | |
| Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference. | |
| Constraints |
| |
| Mappings |
| |
| Permission.rule.data.resource:fromCaregiverOrUnit.reference.identifier | S Σ C | |
| Short | Logical reference, when literal reference is not known | |
| Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. | |
| Cardinality | 0..1 | |
| Type | Identifier | |
| Must Support | True | |
| Summary | True | |
| Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). This element only allows for a single identifier. In the case where additional identifers are required, use the http://hl7.org/fhir/StructureDefinition/additionalIdentifier extension. | |
| Conditions | The cardinality or value of this element may be affected by these constraints: ref-2 | |
| Constraints |
| |
| Mappings |
| |
| Permission.rule.data.resource:fromCaregiverOrUnit.reference.identifier.id | ||
| Short | Unique id for inter-element referencing | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
| Cardinality | 0..1 | |
| Type | string | |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |
| Mappings |
| |
| Permission.rule.data.resource:fromCaregiverOrUnit.reference.identifier.extension | C | |
| 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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | |
| Cardinality | 0..* | |
| Type | Extension | |
| Alias | extensions, user content | |
| 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. | |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | |
| Constraints |
| |
| Mappings |
| |
| Permission.rule.data.resource:fromCaregiverOrUnit.reference.identifier.use | Σ ?! | |
| Short | usual | official | temp | secondary | old (If known) | |
| Definition | The purpose of this identifier. | |
| Cardinality | 0..1 | |
| Type | code | |
| Binding | Identifies the purpose for this identifier, if known . | |
| Modifier | True | |
| Summary | True | |
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | |
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. | |
| Constraints |
| |
| Mappings |
| |
| Permission.rule.data.resource:fromCaregiverOrUnit.reference.identifier.type | Σ | |
| Short | Description of identifier | |
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. | |
| Cardinality | 0..1 | |
| Type | CodeableConcept | |
| Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | |
| Summary | True | |
| Requirements | Allows users to make use of identifiers when the identifier system is not known. | |
| Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. | |
| Constraints |
| |
| Mappings |
| |
| Permission.rule.data.resource:fromCaregiverOrUnit.reference.identifier.system | S Σ | |
| Short | The namespace for the identifier value | |
| Definition | Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique. | |
| Cardinality | 1..1 | |
| Type | uri | |
| Must Support | True | |
| Summary | True | |
| Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. | |
| Comments | Identifier.system is always case sensitive. | |
| Constraints |
| |
| Examples | Generalhttp://www.acme.com/identifiers/patient | |
| Mappings |
| |
| Permission.rule.data.resource:fromCaregiverOrUnit.reference.identifier.value | S Σ C | |
| Short | The value that is unique | |
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | |
| Cardinality | 1..1 | |
| Type | string | |
| Must Support | True | |
| Summary | True | |
| Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. | |
| Conditions | The cardinality or value of this element may be affected by these constraints: ident-1 | |
| Constraints |
| |
| Examples | General123456 | |
| Mappings |
| |
| Permission.rule.data.resource:fromCaregiverOrUnit.reference.identifier.period | Σ C | |
| Short | Time period when id is/was valid for use | |
| Definition | Time period during which identifier is/was valid for use. | |
| Cardinality | 0..1 | |
| Type | Period | |
| Summary | True | |
| Comments | 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"). Period is not used for a duration (a measure of elapsed time). See Duration. | |
| Constraints |
| |
| Mappings |
| |
| Permission.rule.data.resource:fromCaregiverOrUnit.reference.identifier.assigner | Σ C | |
| Short | Organization that issued id (may be just text) | |
| Definition | Organization that issued/manages the identifier. | |
| Cardinality | 0..1 | |
| Type | Reference(Organization) | |
| Summary | True | |
| Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. | |
| Constraints |
| |
| Mappings |
| |
| Permission.rule.data.resource:fromCaregiverOrUnit.reference.display | Σ C | |
| Short | Text alternative for the resource | |
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. | |
| Cardinality | 0..1 | |
| Type | string | |
| Summary | True | |
| Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. | |
| Conditions | The cardinality or value of this element may be affected by these constraints: ref-2 | |
| Constraints |
| |
| Mappings |
| |
| Permission.rule.data.security | Σ C | |
| Short | Security tag code on .meta.security | |
| Definition | The data in scope are those with the given codes present in that data .meta.security element. | |
| Cardinality | 0..* | |
| Type | Coding | |
| Summary | True | |
| Comments | Note the ConfidentialityCode vocabulary indicates the highest value, thus a security label of "R" then it applies to all resources that are labeled "R" or lower. E.g. for Confidentiality, it's a high water mark. For other kinds of security labels, subsumption logic applies. When the purpose of use tag is on the data, access request purpose of use shall not conflict. | |
| Constraints |
| |
| Mappings |
| |
| Permission.rule.data.period | S Σ C | |
| Short | Timeframe encompasing data create/update | |
| Definition | Clinical or Operational Relevant period of time that bounds the data controlled by this rule. | |
| Cardinality | 0..1 | |
| Type | Period | |
| Must Support | True | |
| Summary | True | |
| Comments | This has a different sense to the .validity. | |
| Constraints |
| |
| Mappings |
| |
| Permission.rule.data.period.id | ||
| Short | Unique id for inter-element referencing | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
| Cardinality | 0..1 | |
| Type | string | |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |
| Mappings |
| |
| Permission.rule.data.period.extension | C | |
| 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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | |
| Cardinality | 0..* | |
| Type | Extension | |
| Alias | extensions, user content | |
| 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. | |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | |
| Constraints |
| |
| Mappings |
| |
| Permission.rule.data.period.start | S Σ C | |
| Short | Starting time with inclusive boundary | |
| Definition | The start of the period. The boundary is inclusive. | |
| Cardinality | 0..1 | |
| Type | dateTime | |
| Must Support | True | |
| Summary | True | |
| Comments | If the low element is missing, the meaning is that the low boundary is not known. | |
| Conditions | The cardinality or value of this element may be affected by these constraints: per-1 | |
| Constraints |
| |
| Mappings |
| |
| Permission.rule.data.period.end | S Σ C | |
| Short | End time with inclusive boundary, if not ongoing | |
| Definition | The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. 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. | |
| Cardinality | 0..1 | |
| Type | dateTime | |
| Must Support | True | |
| Summary | True | |
| Comments | The end value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03. | |
| Meaning when missing | If the end of the period is missing, it means that the period is ongoing | |
| Conditions | The cardinality or value of this element may be affected by these constraints: per-1 | |
| Constraints |
| |
| Mappings |
| |
| Permission.rule.data.expression | Σ C | |
| Short | Expression identifying the data | |
| Definition | Used when other data selection elements are insufficient. | |
| Cardinality | 0..1 | |
| Type | Expression | |
| Summary | True | |
| Constraints |
| |
| Mappings |
| |
| Permission.rule.activity | S Σ | |
| Short | A description or definition of which activities are allowed to be done on the data | |
| Definition | A description or definition of which activities are allowed to be done on the data. | |
| Cardinality | 1..1 | |
| Type | BackboneElement | |
| Must Support | True | |
| Summary | True | |
| Constraints |
| |
| Mappings |
| |
| Permission.rule.activity.id | ||
| Short | Unique id for inter-element referencing | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
| Cardinality | 0..1 | |
| Type | string | |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |
| Mappings |
| |
| Permission.rule.activity.extension | C | |
| 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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | |
| Cardinality | 0..* | |
| Type | Extension | |
| Alias | extensions, user content | |
| 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. | |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | |
| Constraints |
| |
| Mappings |
| |
| Permission.rule.activity.modifierExtension | Σ ?! C | |
| Short | Extensions that cannot be ignored even if unrecognized | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | |
| Cardinality | 0..* | |
| Type | Extension | |
| Modifier | True | |
| Summary | True | |
| Alias | extensions, user content, modifiers | |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | |
| 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. | |
| Constraints |
| |
| Mappings |
| |
| Permission.rule.activity.actor | S Σ C | |
| Short | Authorized actor(s) | |
| Definition | The actor(s) authorized for the defined activity. | |
| Cardinality | 1..1 | |
| Type | Reference(RelatedPersonDataAccess) | |
| Must Support | True | |
| Summary | True | |
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | |
| Constraints |
| |
| Mappings |
| |
| Permission.rule.activity.actor.id | ||
| Short | Unique id for inter-element referencing | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
| Cardinality | 0..1 | |
| Type | string | |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |
| Mappings |
| |
| Permission.rule.activity.actor.extension | C | |
| 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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | |
| Cardinality | 0..* | |
| Type | Extension | |
| Alias | extensions, user content | |
| 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. | |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | |
| Constraints |
| |
| Mappings |
| |
| Permission.rule.activity.actor.reference | Σ C | |
| Short | Literal reference, Relative, internal or absolute URL | |
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. | |
| Cardinality | 0..1 | |
| Type | string | |
| Summary | True | |
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. | |
| Conditions | The cardinality or value of this element may be affected by these constraints: ref-2, ref-1 | |
| Constraints |
| |
| Mappings |
| |
| Permission.rule.activity.actor.type | Σ | |
| Short | Type the reference refers to (e.g. "Patient") - must be a resource in resources | |
| Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). | |
| Cardinality | 0..1 | |
| Type | uri | |
| Binding | Aa resource (or, for logical models, the URI of the logical model). | |
| Summary | True | |
| Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference. | |
| Constraints |
| |
| Mappings |
| |
| Permission.rule.activity.actor.identifier | S Σ C | |
| Short | Logical reference, when literal reference is not known | |
| Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. | |
| Cardinality | 1..1 | |
| Type | Identifier | |
| Must Support | True | |
| Summary | True | |
| Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). This element only allows for a single identifier. In the case where additional identifers are required, use the http://hl7.org/fhir/StructureDefinition/additionalIdentifier extension. | |
| Conditions | The cardinality or value of this element may be affected by these constraints: ref-2 | |
| Constraints |
| |
| Mappings |
| |
| Permission.rule.activity.actor.identifier.id | ||
| Short | Unique id for inter-element referencing | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
| Cardinality | 0..1 | |
| Type | string | |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |
| Mappings |
| |
| Permission.rule.activity.actor.identifier.extension | C | |
| 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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | |
| Cardinality | 0..* | |
| Type | Extension | |
| Alias | extensions, user content | |
| 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. | |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | |
| Constraints |
| |
| Mappings |
| |
| Permission.rule.activity.actor.identifier.use | Σ ?! | |
| Short | usual | official | temp | secondary | old (If known) | |
| Definition | The purpose of this identifier. | |
| Cardinality | 0..1 | |
| Type | code | |
| Binding | Identifies the purpose for this identifier, if known . | |
| Modifier | True | |
| Summary | True | |
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | |
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. | |
| Constraints |
| |
| Mappings |
| |
| Permission.rule.activity.actor.identifier.type | Σ | |
| Short | Description of identifier | |
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. | |
| Cardinality | 0..1 | |
| Type | CodeableConcept | |
| Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | |
| Summary | True | |
| Requirements | Allows users to make use of identifiers when the identifier system is not known. | |
| Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. | |
| Constraints |
| |
| Mappings |
| |
| Permission.rule.activity.actor.identifier.system | S Σ | |
| Short | The namespace for the identifier value | |
| Definition | Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique. | |
| Cardinality | 1..1 | |
| Type | uri | |
| Must Support | True | |
| Summary | True | |
| Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. | |
| Comments | Identifier.system is always case sensitive. | |
| Constraints |
| |
| Examples | Generalhttp://www.acme.com/identifiers/patient | |
| Mappings |
| |
| Permission.rule.activity.actor.identifier.value | S Σ C | |
| Short | The value that is unique | |
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | |
| Cardinality | 1..1 | |
| Type | string | |
| Must Support | True | |
| Summary | True | |
| Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. | |
| Conditions | The cardinality or value of this element may be affected by these constraints: ident-1 | |
| Constraints |
| |
| Examples | General123456 | |
| Mappings |
| |
| Permission.rule.activity.actor.identifier.period | Σ C | |
| Short | Time period when id is/was valid for use | |
| Definition | Time period during which identifier is/was valid for use. | |
| Cardinality | 0..1 | |
| Type | Period | |
| Summary | True | |
| Comments | 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"). Period is not used for a duration (a measure of elapsed time). See Duration. | |
| Constraints |
| |
| Mappings |
| |
| Permission.rule.activity.actor.identifier.assigner | Σ C | |
| Short | Organization that issued id (may be just text) | |
| Definition | Organization that issued/manages the identifier. | |
| Cardinality | 0..1 | |
| Type | Reference(Organization) | |
| Summary | True | |
| Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. | |
| Constraints |
| |
| Mappings |
| |
| Permission.rule.activity.actor.display | Σ C | |
| Short | Text alternative for the resource | |
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. | |
| Cardinality | 0..1 | |
| Type | string | |
| Summary | True | |
| Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. | |
| Conditions | The cardinality or value of this element may be affected by these constraints: ref-2 | |
| Constraints |
| |
| Mappings |
| |
| Permission.rule.activity.action | S Σ | |
| Short | Actions controlled by this rule | |
| Definition | Actions controlled by this Rule. | |
| Cardinality | 1..* | |
| Type | CodeableConcept | |
| Binding | Detailed codes for the action. | |
| Must Support | True | |
| Summary | True | |
| Comments | Note that this is the direct action (not the grounds for the action covered in the purpose element). At present, the only action in the understood and tested scope of this resource is 'read'. | |
| Constraints |
| |
| Mappings |
| |
| Permission.rule.activity.action.id | ||
| Short | Unique id for inter-element referencing | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
| Cardinality | 0..1 | |
| Type | string | |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |
| Mappings |
| |
| Permission.rule.activity.action.extension | C | |
| 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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | |
| Cardinality | 0..* | |
| Type | Extension | |
| Alias | extensions, user content | |
| 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. | |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | |
| Constraints |
| |
| Mappings |
| |
| Permission.rule.activity.action.coding | S Σ C | |
| Short | Code defined by a terminology system | |
| Definition | A reference to a code defined by a terminology system. | |
| Cardinality | 1..1 | |
| Type | Coding | |
| Must Support | True | |
| Summary | True | |
| Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | |
| Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. | |
| Constraints |
| |
| Mappings |
| |
| Permission.rule.activity.action.coding.id | ||
| Short | Unique id for inter-element referencing | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
| Cardinality | 0..1 | |
| Type | string | |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |
| Mappings |
| |
| Permission.rule.activity.action.coding.extension | C | |
| 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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | |
| Cardinality | 0..* | |
| Type | Extension | |
| Alias | extensions, user content | |
| 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. | |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | |
| Constraints |
| |
| Mappings |
| |
| Permission.rule.activity.action.coding.system | S Σ | |
| Short | Identity of the terminology system | |
| Definition | The identification of the code system that defines the meaning of the symbol in the code. | |
| Cardinality | 1..1 | |
| Type | uri | |
| Must Support | True | |
| Summary | True | |
| Requirements | Need to be unambiguous about the source of the definition of the symbol. | |
| Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously. | |
| Constraints |
| |
| Mappings |
| |
| Permission.rule.activity.action.coding.version | Σ | |
| Short | Version of the system - if relevant | |
| Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. | |
| Cardinality | 0..1 | |
| Type | string | |
| Summary | True | |
| Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. | |
| Constraints |
| |
| Mappings |
| |
| Permission.rule.activity.action.coding.code | S Σ C | |
| Short | Symbol in syntax defined by the system | |
| Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). | |
| Cardinality | 1..1 | |
| Type | code | |
| Must Support | True | |
| Summary | True | |
| Requirements | Need to refer to a particular code in the system. | |
| Comments | Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size | |
| Conditions | The cardinality or value of this element may be affected by these constraints: cod-1 | |
| Constraints |
| |
| Mappings |
| |
| Permission.rule.activity.action.coding.display | Σ C | |
| Short | Representation defined by the system | |
| Definition | A representation of the meaning of the code in the system, following the rules of the system. | |
| Cardinality | 0..1 | |
| Type | string | |
| Summary | True | |
| Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | |
| Comments | Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size | |
| Conditions | The cardinality or value of this element may be affected by these constraints: cod-1 | |
| Constraints |
| |
| Mappings |
| |
| Permission.rule.activity.action.coding.userSelected | Σ | |
| Short | If this coding was chosen directly by the user | |
| Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). | |
| Cardinality | 0..1 | |
| Type | boolean | |
| Summary | True | |
| Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. | |
| Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. | |
| Constraints |
| |
| Mappings |
| |
| Permission.rule.activity.action.text | Σ | |
| Short | Plain text representation of the concept | |
| Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. | |
| Cardinality | 0..1 | |
| Type | string | |
| Summary | True | |
| Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. | |
| Comments | Very often the text is the same as a displayName of one of the codings. | |
| Constraints |
| |
| Mappings |
| |
| Permission.rule.activity.purpose | Σ | |
| Short | The purpose for which the permission is given | |
| Definition | The purpose for which the permission is given. | |
| Cardinality | 0..* | |
| Type | CodeableConcept | |
| Binding | What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels. http://terminology.hl7.org/ValueSet/v3-PurposeOfUse (preferred) | |
| Summary | True | |
| Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. | |
| Constraints |
| |
| Mappings |
| |
| Permission.rule.limit | Σ | |
| Short | What limits apply to the use of the data | |
| Definition | What limits apply to the use of the data. | |
| Cardinality | 0..* | |
| Type | CodeableConcept | |
| Binding | Obligations and Refrains | |
| Summary | True | |
| Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. | |
| Constraints |
| |
| Mappings |
| |
Details
The red must-support flag ("S") indicates that the element is expected in some use cases, and a missing flag that the element is never used.
The following sections describe how to use the profile to build a proxy permission.
For whom - on whose behalf can the actions be performed
To define the patient on whose behalf the permitted actions can be performed, use the asserter element. To reference the patient using an existing external identifier, the system of the identifier and the value should be provided. The system ID declares what type of identifier the patient identifier is.
{
[...]
"asserter": {
"identifier": {
"system": "http://electronichealth.se/identifier/personnummer",
"value": "198001032385"
}
}
}
Current valid patient identifiers are:
- Personal identity number (sv: personnummer)
- system: http://electronichealth.se/identifier/personnummer
- value format: 12 digits without hyphen, e.g. 198001032385
- Coordination number (sv: samordningsnummer)
- system: http://electronichealth.se/identifier/samordningsnummer
- value format: 12 digits without hyphen, e.g. 201903682399
Actor - Who is being permitted to perform the actions
To define the RelatedPerson who is being permitted to perform the actions, the element rule.activity.actor should be used.
To reference the actor's existing external identifier, the system of the identifier and the value should be provided. The system ID declares what type of identifier the external identifier is.
{
[...]
"rule": [
{
"activity": [
{
"actor": [
{
"identifier": {
"system": "http://electronichealth.se/identifier/personnummer",
"value": "198001032385"
}
}
]
}
]
}
]
}
Current valid identifiers are:
- Personal identity number (sv: personnummer)
- system: http://electronichealth.se/identifier/personnummer
- value format: 12 digits without hyphen, e.g. 198001032385
- Coordination number (sv: samordningsnummer)
- system: http://electronichealth.se/identifier/samordningsnummer
- value format: 12 digits without hyphen, e.g. 201903682399
To supply evidence that justifies why the related person legally is permitted to perform the actions, use the justification.evidence element. The element can reference a Permission - ProxyPermission if the proxy is based on a power of attorney or a RelatedPerson if the proxy is based on the relationship the actor has to the patient, e.g. being a legal guardian. The RelatedPerson instance referenced must have the relationship element supplied with the correct code for guardian.
{
[...]
"justification": {
"evidence": [
{
"reference": "Consent/1fe15eac-f445-45ae-a1f2-bec471d300dc"
}
]
}
}
When - During what time frame are the actions permitted
To define when the permission is valid, use the validity element. Note that a start time for the permission has to be supplied. If an end time is not supplied, the permission should be interpreted as indefinite.
{
[...]
"validity": {
"start": "2026-11-12",
"end": "2027-11-12"
}
}
Actions - what actions are permitted
To define what actions are permitted to be performed on behalf of the patient, use the rule.activity.action element. Use codes from value set Aktiviteter som företrädarskap innefattar.
Data - on what data can actions be performed
The following sections describe how to define the data on which the actions can be performed. This can be done by specifying what source the data has, what category of data it is and when the data was registered. These filters can be combined freely.
Define data by its source
To define the data on which the permitted actions can be performed based on where the data originates, the rule.data.resource element should be used. A data source can be a care giver, care unit or country. The resource element contains a reference that can reference to the source as a Organization. The data element also contains a meaning element that should be set to authoredby to specify that the reference is a data source.
If a data source is not supplied, the data definition should be interpreted to regard data from any data source and that matches the other data filters.
{
[...]
"rule": [
{
"data": [
{
"resource": [
{
"reference": {
"identifier": {
"system": "urn:oid:2.5.4.97",
"value": "2021005389"
}
},
"meaning": "authoredby"
}
]
}
]
}
]
}
Country
If the source is a country, current valid identifiers are:
- Country code according to ISO-3166
- system: urn:iso:std:iso:3166
- value format: 2 characters, e.g. SE
Healthcare provider
If the source is a healthcare provider, current valid identifiers are:
- Organization identifier (sv: organisationsnummer)
- system: urn:oid:2.5.4.97
- value format: 10 digits without hyphen, e.g. 2021005389
- Personal identity number (sv: personnummer)
- system: http://electronichealth.se/identifier/personnummer
- value format: 12 digits without hyphen, e.g. 198001032385
Healthcare unit
If the source is a healthcare unit, current valid identifiers are:
- HSA ID
- system: urn:oid:1.2.752.29.4.19
- value format: SE+10 digits+hyphen+a number of alphanumerical characters, e.g. SE1234567890-ABC1
Define data by information category
To define the data on which the permitted actions can be performed based on information category, the rule.data.extension.resourceType element should be used. To use the resourceType extension, supply the url "http://electronichealth.se/fhir/NDI/StructureDefinition/permission-data-document-type-ps". Use codes from value set Datakategorier enligt EHDS.
If an information category is not supplied, the data definition should be interpreted to regard data of all information categories and that matches the other data filters.
{
[...]
"rule": [
{
"data": [
{
"extension": [
{
"url": "http://electronichealth.se/fhir/NDI/StructureDefinition/permission-data-document-type-ps",
"valueCodeableConcept": {
"coding": [
{
"system": "https://electronichealth.se/CodeSystem/ehds-priority-category",
"code": "laboratory-results"
}
]
}
}
],
}
]
}
]
}
Define data by date of registration
To define the data on which the permitted actions can be performed based on whether it was registered within a certain time interval, use the rule.data.period element. An empty start element when end has been set should be interpreted as data registered at any time before the set end. An empty end element when start has been set should be interpreted as data registered at any time after the set start.
If a time interval is not supplied, the data definition should be interpreted to regard data from any point in time and that matches the other data filters.
{
[...]
"rule": [
{
"data": [
{
"period": [
{
"start": "2025-08-01",
"end": "2025-11-01"
}
]
}
]
}
]
}
Reference to instance of data
To define a permission that authorizes access to a specific piece of data the rule.data.resource element should be used. The resource element contains a reference that can reference to an instance of for example an observation or a diagnosis. The meaning should be set to instance to specify that the reference is a data instance.
If a reference to an instance is not supplied, the data definition should be interpreted to regard all data that matches the other data filters.
{
[...]
"rule": [
{
"data": [
{
"reference": {
"reference": "Observation/02d9860a-18a8-43a2-a961-04219650e72c"
},
"meaning": "instance"
}
]
}
]
}
Invariants
| Element | Description | Expression |
|---|---|---|
| Permission.asserter.identifier, Permission.rule.activity.actor.identifier, Permission.rule.data.resource.reference.identifier | A Swedish personal identity number (sv: personnummer) should follow format 198001032385 | value.matches('^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(0[1-9]|1[0-2])(0[1-9]|[1-2][0-9]|3[0-1])\\d{4}$') or system != 'http://electronichealth.se/identifier/personnummer' |
| Permission.asserter.identifier, Permission.rule.activity.actor.identifier | A Swedish coordination number (sv: samordningsnummer) should follow format 201903682399 | value.matches('^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(0[1-9]|1[0-2])([6-9][1-9])\\d{4}$') or system != 'http://electronichealth.se/identifier/samordningsnummer' |
| Permission.date, Permission.rule.data.period.start, Permission.rule.data.period.end, Permission.validity.start, Permission.validity.end | DateTime must be a valid date that follows format YYYY-MM-DD without timestamp | $this.matches('^\\d{4}-\\d{2}-\\d{2}$') |
| Permission.rule.data.resource.reference.identifier | A Swedish organization identifier (sv: organisationsnummer) should follow format 7999000057 | value.matches('^\\d{6}\\d{4}$') or system != 'urn:oid:2.5.4.97' |
| Permission.validity | If present, start SHALL have a lower or equal value than end. | start.hasValue().not() or end.hasValue().not() or (start.lowBoundary() <= end.highBoundary()) |
ValueSet bindings
The following table shows the elements in the profile that should be populated with codes as well as what value sets contain the valid codes for the respective elements. The strength indicates whether it is recommended or required to choose a code from the defined value set.
| Path | Strength | ValueSet |
|---|---|---|
| Permission.status | required | http://electronichealth.se/fhir/NDI/ValueSet/ps-proxy-permission-statuses |
| Permission.rule.data.extension.value[x] | required | http://electronichealth.se/fhir/NDI/ValueSet/ndi-ehds-categories |
| Permission.rule.activity.action | required | http://electronichealth.se/fhir/NDI/ValueSet/ps-permission-actions |
Examples
This section contains example instances of ProxyPermission to illustrate how the profile can be used to express permissions for different use cases. See section Supported operations for information on how to query ProxyPermissions.
Note that all logical IDs and personal identifiers are fictional and cannot be queried.
Permission based on legal document
The following example shows how to use ProxyPermission to express a related person being permitted to access laboratory results of a patient from a healthcare provider (NDIOrganization). The type of data is expressed in the rule.data.extension.resourceType element. The action allowed, i.e. access, is expressed in the rule.activity.action element. The healthcare provider from which the laboratory results originates is expressed in the rule.data.resource.reference element, by referencing its organization identifier. The system ID for organization identifier is "urn:oid:2.5.4.97". The rule.data.period element specifies laboratory results that are covered by this permission by the time of their registration.
The asserter references the NDIPatient whose data the related person is permitted to access. The element references the patient's personal identity number, using the system ID "http://electronichealth.se/identifier/personnummer".
The NDIRelatedPerson who is being permitted access rights is referenced to in the rule.activity.actor element. This reference references the related person's personal identity number, using the system ID "http://electronichealth.se/identifier/personnummer".
The justification element references a PowerOfAttorney as legal evidence of the permission.
| Permission |
| id : 4165f483-357b-4e0c-b7e7-d8f1ed77fc23 |
| text |
| status : generated |
| status : active |
| asserter |
| identifier |
| system : http://electronichealth.se/identifier/personnummer |
| value : 199001232389 |
| date : 2025-11-21 |
| validity |
| start : 2025-12-01 |
| end : 2026-05-01 |
| justification |
| evidence |
| reference : Consent/57d8e572-7dab-469a-ab33-ddeb7ad2a6b2 |
| combining : deny-unless-permit |
| rule |
| type : permit |
| data |
| extension |
| url : http://electronichealth.se/fhir/NDI/StructureDefinition/permission-data-document-type-ps |
| value |
| coding |
| system : https://electronichealth.se/ndi/CodeSystem/ndi-ehds-priority-category |
| code : laboratory-results |
| resource |
| meaning : authoredby |
| reference |
| identifier |
| system : urn:oid:2.5.4.97 |
| value : 165560269986 |
| period |
| start : 2025-08-01 |
| activity |
| actor |
| identifier |
| system : http://electronichealth.se/identifier/personnummer |
| value : 198001032385 |
| action |
| coding |
| system : http://terminology.hl7.org/CodeSystem/consentaction |
| code : access |
Permission based on relationship to patient
The following example shows how to use ProxyPermission to express a related person being permitted to access electronic prescriptions of a patient from a healthcare provider (Organization). The type of data is expressed in the rule.data.extension.resourceType element. The action allowed, i.e. access, is expressed in the rule.activity.action element. The healthcare provider from which the laboratory results originates is expressed in the rule.data.resource.reference element, by referencing its organization identifier. The system ID for organization identifier is "urn:oid:2.5.4.97".
The asserter references the Patient whose data the related person is permitted to access. The element references the patient's personal identity number, using the system ID "http://electronichealth.se/identifier/personnummer".
The RelatedPerson who is being permitted access rights is referenced to in the rule.activity.actor element. This reference references the related person's personal identity number, using the system ID "http://electronichealth.se/identifier/personnummer".
The justification element references a RelatedPerson as evidence of the permission, to declare that the permission is based on the fact that the related person is the guardian of the patient.
| Permission |
| id : 29a546c9-5d32-498c-9e3a-cb9cc5b69a06 |
| status : active |
| asserter |
| identifier |
| system : http://electronichealth.se/identifier/personnummer |
| value : 202402262394 |
| date : 2025-11-21 |
| validity |
| start : 2025-12-01 |
| end : 2026-05-01 |
| justification |
| evidence |
| reference : RelatedPerson/1639ce1a-0509-44d7-8bfd-20332fb4ac17 |
| combining : deny-unless-permit |
| rule |
| type : permit |
| data |
| extension |
| url : http://electronichealth.se/fhir/NDI/StructureDefinition/permission-data-document-type-ps |
| value |
| coding |
| system : https://electronichealth.se/CodeSystem/ehds-priority-category |
| code : electronic-prescriptions |
| resource |
| meaning : authoredby |
| reference |
| identifier |
| system : urn:oid:2.5.4.97 |
| value : 165560269986 |
| period |
| start : 2025-08-01 |
| activity |
| actor |
| identifier |
| system : http://electronichealth.se/identifier/personnummer |
| value : 198001132383 |
| action |
| coding |
| system : http://terminology.hl7.org/CodeSystem/consentaction |
| code : access |
Supported operations
HTTP methods
The following table explains what HTTP methods can be done on the Permission resource using this profile.
| Operation | Supported | Comment |
|---|---|---|
| Search (GET, POST) | yes | |
| Insert (POST) | no | |
| Update (PUT) | no | |
| Delete (DEL) | no | |
| Operation (GET, POST) | no |
Query operations
Supported Queries
GET [base]/Permission?patient:identifier=[system]|[value]{&[parameters]}returns a Bundle of Permissions where the patient with supplied identifier is the asserter of the Permission and that match the additional parameters if any. If no Permissions are found the Bundle will be empty.GET [base]/Permission?actor:identifier=[system]|[value]{&[parameters]}returns a Bundle of Permissions where the actor with supplied identifier is the actor of the Permission and that match the additional parameters if any. If no Permissions are found the Bundle will be empty.
Search parameters
| Parameter | Description | Example |
|---|---|---|
| actor:identifier | Identifier of rule.activity.actor of Permission, as "system|value". | actor:identifier=http://electronichealth.se/identifier/personnummer|198001012345 |
| patient:identifier | Identifier of Patient asserter of Permission, as "system|value". | patient:identifier=http://electronichealth.se/identifier/personnummer|198001012345 |
| status | Status of Permission. Must be from Status på företrädarbehörighet. | status=active |
Validation rules
Validation messages are error, information or success messages that are returned as a result of an operation. These messages are returned in a OperationOutcome resource.
| Parameter | Error message | Description | Severity |
|---|---|---|---|
| actor:identifier, patient:identifier | 2-XX-2: Ogiltigt format på personnummer i parameter %s. Ange tolvsiffriga personnumret utan bindestreck, t. ex. 198001032385 | Personal identity number should be 12 digits without hyphen | Error |
| actor:identifier, patient:identifier | 2-XX-3: Ogiltigt format på samordningsnummer i parameter %s | Coordination number should be 12 digits without hyphen | Error |
| actor:identifier, patient:identifier | 2-XX-4: Ogiltigt system-ID i parameter %s | The identifier system value must be be from list of valid systems (see section "Details" above) | Error |