Médicosocial - Suivi Décisions Orientation
4.0.2-ballot-2 - trial-use
Médicosocial - Suivi Décisions Orientation
4.0.2-ballot-2 - trial-use
This page is part of the Médicosocial - Suivi Décisions Orientation (v4.0.2-ballot-2: Release) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
| Official URL: https://interop.esante.gouv.fr/ig/fhir/sdo/StructureDefinition/esms-consent | Version: 4.0.2-ballot-2 | |||
| Active as of 2024-01-19 | Computable Name: ESMSConsent | |||
Profil pour la définition de l’accord
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Consent
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Consent | 0..* | Consent | A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time | |
  meta | 1..1 | Meta | Metadata about the resource | |
  source | 1..1 | uri | Identifiant de l’ESMS créant la ressource (=idNat_Struct). Il s’agit de la structure bénéficiant de l’accord. | |
 status | 1..1 | code | draft | proposed | active | rejected | inactive | entered-in-error Fixed Value: active | |
| scope | 1..1 | CodeableConcept | Which of the four areas this resource covers (extensible) Fixed Value: As shown | |
  coding | 1..1 | Coding | Code defined by a terminology system Fixed Value: (complex) | |
 system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/consentscope | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: patient-privacy | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Privacy Consent | |
| category | 1..* | CodeableConcept | Classification of the consent statement - for indexing/retrieval Fixed Value: As shown | |
| coding | 1..1 | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 59284-0 | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Consent | |
| dateTime | 1..1 | dateTime | Date de recueil de l'accord de la personne orientée par l’ESMS. | |
| provision | 1..1 | BackboneElement | Constraints to the base Consent.policyRule | |
| data | 1..1 | BackboneElement | Data controlled by this rule | |
| meaning | 1..1 | code | instance | related | dependents | authoredby Fixed Value: related | |
 reference | 1..1 | Reference(https://hl7.org/fhir/R4/documentreference.html) | Référence à la ressource DocumentReference (dossier de décisions d’orientation) concernée par l’accord. | |
| identifier | 1..1 | Identifier | Référence logique vers la ressource (dossier de décisions d’orientation) pour laquelle s’applique cet accord | |
| use | 1..1 | code | usual | official | temp | secondary | old (If known) Fixed Value: official | |
| value | 1..1 | string | Valeur de l’identifier vers lequel la ressource Consent doit pointer (identifier officiel du documentReference = idNat_Decision) | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Consent | C | 0..* | Consent | A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time |
 meta | Σ | 1..1 | Meta | Metadata about the resource |
 source | Σ | 1..1 | uri | Identifiant de l’ESMS créant la ressource (=idNat_Struct). Il s’agit de la structure bénéficiant de l’accord. |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
 modifierExtension | ?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url |
| status | ?!Σ | 1..1 | code | draft | proposed | active | rejected | inactive | entered-in-error Binding: ConsentState (required): Indicates the state of the consent. Fixed Value: active |
| scope | ?!Σ | 1..1 | CodeableConcept | Which of the four areas this resource covers (extensible) Binding: ConsentScopeCodes (extensible): The four anticipated uses for the Consent Resource. Fixed Value: As shown |
| id | 0..0 | string | Unique id for inter-element referencing | |
| extension | 0..0 | Extension | Additional content defined by implementations | |
| coding | 1..1 | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| id | 0..0 | string | Unique id for inter-element referencing | |
| extension | 0..0 | Extension | Additional content defined by implementations | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/consentscope | |
| version | 0..0 | string | Version of the system - if relevant | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: patient-privacy | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Privacy Consent | |
| userSelected | 0..0 | boolean | If this coding was chosen directly by the user | |
| text | 0..0 | string | Plain text representation of the concept | |
| category | Σ | 1..* | CodeableConcept | Classification of the consent statement - for indexing/retrieval Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement. Fixed Value: As shown |
| id | 0..0 | string | Unique id for inter-element referencing | |
| extension | 0..0 | Extension | Additional content defined by implementations | |
| coding | 1..1 | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| id | 0..0 | string | Unique id for inter-element referencing | |
| extension | 0..0 | Extension | Additional content defined by implementations | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
| version | 0..0 | string | Version of the system - if relevant | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 59284-0 | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Consent | |
| userSelected | 0..0 | boolean | If this coding was chosen directly by the user | |
| text | 0..0 | string | Plain text representation of the concept | |
| dateTime | Σ | 1..1 | dateTime | Date de recueil de l'accord de la personne orientée par l’ESMS. |
| policyRule | ΣC | 0..1 | CodeableConcept | Regulation that this consents to Binding: ConsentPolicyRuleCodes (extensible): Regulatory policy examples. |
| provision | Σ | 1..1 | BackboneElement | Constraints to the base Consent.policyRule |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| data | Σ | 1..1 | BackboneElement | Data controlled by this rule |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| meaning | Σ | 1..1 | code | instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions. Fixed Value: related |
| reference | ΣC | 1..1 | Reference(https://hl7.org/fhir/R4/documentreference.html) | Référence à la ressource DocumentReference (dossier de décisions d’orientation) concernée par l’accord. |
| reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| identifier | Σ | 1..1 | Identifier | Référence logique vers la ressource (dossier de décisions d’orientation) pour laquelle s’applique cet accord |
| use | ?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official |
| value | Σ | 1..1 | string | Valeur de l’identifier vers lequel la ressource Consent doit pointer (identifier officiel du documentReference = idNat_Decision) Example General: 123456 |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Consent.status | required | Fixed Value: activehttp://hl7.org/fhir/ValueSet/consent-state-codes|4.0.1from the FHIR Standard | |
| Consent.scope | extensible | Fixed Value: patient-privacy("Privacy Consent")http://hl7.org/fhir/ValueSet/consent-scopefrom the FHIR Standard | |
| Consent.category | extensible | Fixed Value: LOINC code 59284-0("Consent")http://hl7.org/fhir/ValueSet/consent-categoryfrom the FHIR Standard | |
| Consent.policyRule | extensible | ConsentPolicyRuleCodeshttp://hl7.org/fhir/ValueSet/consent-policyfrom the FHIR Standard | |
| Consent.provision.data.meaning | required | Fixed Value: relatedhttp://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1from the FHIR Standard | |
| Consent.provision.data.reference.identifier.use | required | Fixed Value: officialhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Consent | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Consent | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Consent | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Consent | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Consent | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** elements | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ppc-1 | error | Consent | Either a Policy or PolicyRule : policy.exists() or policyRule.exists() | |
| ppc-2 | error | Consent | IF Scope=privacy, there must be a patient : patient.exists() or scope.coding.where(system='something' and code='patient-privacy').exists().not() | |
| ppc-3 | error | Consent | IF Scope=research, there must be a patient : patient.exists() or scope.coding.where(system='something' and code='research').exists().not() | |
| ppc-4 | error | Consent | IF Scope=adr, there must be a patient : patient.exists() or scope.coding.where(system='something' and code='adr').exists().not() | |
| ppc-5 | error | Consent | IF Scope=treatment, there must be a patient : patient.exists() or scope.coding.where(system='something' and code='treatment').exists().not() | |
| ref-1 | error | Consent.provision.data.reference | SHALL have a contained resource if a local reference is provided : reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Consent | C | 0..* | Consent | A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time | ||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 1..1 | Meta | Metadata about the resource | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
 extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| versionId | Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated | Σ | 0..1 | instant | When the resource version last changed | ||||
| source | Σ | 1..1 | uri | Identifiant de l’ESMS créant la ressource (=idNat_Struct). Il s’agit de la structure bénéficiant de l’accord. | ||||
| profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
| security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| modifierExtension | ?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url | ||||
| identifier | Σ | 0..* | Identifier | Identifier for this record (external references) Example General: {"system":"http://acme.org/identifier/local/eCMS","value":"Local eCMS identifier"} | ||||
| status | ?!Σ | 1..1 | code | draft | proposed | active | rejected | inactive | entered-in-error Binding: ConsentState (required): Indicates the state of the consent. Fixed Value: active | ||||
| scope | ?!Σ | 1..1 | CodeableConcept | Which of the four areas this resource covers (extensible) Binding: ConsentScopeCodes (extensible): The four anticipated uses for the Consent Resource. Fixed Value: As shown | ||||
| id | 0..0 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | Extension | Additional content defined by implementations | |||||
| coding | 1..1 | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..0 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/consentscope | |||||
| version | 0..0 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: patient-privacy | |||||
| display | 1..1 | string | Representation defined by the system Fixed Value: Privacy Consent | |||||
| userSelected | 0..0 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..0 | string | Plain text representation of the concept | |||||
| category | Σ | 1..* | CodeableConcept | Classification of the consent statement - for indexing/retrieval Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement. Fixed Value: As shown | ||||
| id | 0..0 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | Extension | Additional content defined by implementations | |||||
| coding | 1..1 | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..0 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |||||
| version | 0..0 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 59284-0 | |||||
| display | 1..1 | string | Representation defined by the system Fixed Value: Consent | |||||
| userSelected | 0..0 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..0 | string | Plain text representation of the concept | |||||
| patient | ΣC | 0..1 | Reference(Patient) | Who the consent applies to | ||||
| dateTime | Σ | 1..1 | dateTime | Date de recueil de l'accord de la personne orientée par l’ESMS. | ||||
| performer | ΣC | 0..* | Reference(Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | Who is agreeing to the policy and rules | ||||
| organization | ΣC | 0..* | Reference(Organization) | Custodian of the consent | ||||
 source[x] | Σ | 0..1 | Source from which this consent is taken | |||||
| sourceAttachment | Attachment | |||||||
| sourceReference | Reference(Consent | DocumentReference | Contract | QuestionnaireResponse) | |||||||
| policy | 0..* | BackboneElement | Policies covered by this consent | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| authority | C | 0..1 | uri | Enforcement source for policy | ||||
| uri | C | 0..1 | uri | Specific policy covered by this consent | ||||
| policyRule | ΣC | 0..1 | CodeableConcept | Regulation that this consents to Binding: ConsentPolicyRuleCodes (extensible): Regulatory policy examples. | ||||
| verification | Σ | 0..* | BackboneElement | Consent Verified by patient or family | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| verified | Σ | 1..1 | boolean | Has been verified | ||||
| verifiedWith | C | 0..1 | Reference(Patient | RelatedPerson) | Person who verified | ||||
| verificationDate | 0..1 | dateTime | When consent verified | |||||
| provision | Σ | 1..1 | BackboneElement | Constraints to the base Consent.policyRule | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type | Σ | 0..1 | code | deny | permit Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent. | ||||
| period | ΣC | 0..1 | Period | Timeframe for this rule | ||||
| actor | 0..* | BackboneElement | Who|what controlled by this rule (or group, by role) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| role | 1..1 | CodeableConcept | How the actor is involved Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations. | |||||
| reference | C | 1..1 | Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | Resource for the actor (or group, by role) | ||||
| action | Σ | 0..* | CodeableConcept | Actions controlled by this rule Binding: ConsentActionCodes (example): Detailed codes for the consent action. | ||||
| securityLabel | Σ | 0..* | Coding | Security Labels that define affected resources Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| purpose | Σ | 0..* | Coding | Context of activities covered by this rule Binding: PurposeOfUse (extensible): What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels. | ||||
| class | Σ | 0..* | Coding | e.g. Resource Type, Profile, CDA, etc. Binding: ConsentContentClass (extensible): The class (type) of information a consent rule covers. | ||||
| code | Σ | 0..* | CodeableConcept | e.g. LOINC or SNOMED CT code, etc. in the content Binding: ConsentContentCodes (example): If this code is found in an instance, then the exception applies. | ||||
| dataPeriod | ΣC | 0..1 | Period | Timeframe for data controlled by this rule | ||||
| data | Σ | 1..1 | BackboneElement | Data controlled by this rule | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| meaning | Σ | 1..1 | code | instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions. Fixed Value: related | ||||
| reference | ΣC | 1..1 | Reference(https://hl7.org/fhir/R4/documentreference.html) | Référence à la ressource DocumentReference (dossier de décisions d’orientation) concernée par l’accord. | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier | Σ | 1..1 | Identifier | Référence logique vers la ressource (dossier de décisions d’orientation) pour laquelle s’applique cet accord | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| use | ?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official | ||||
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value | Σ | 1..1 | string | Valeur de l’identifier vers lequel la ressource Consent doit pointer (identifier officiel du documentReference = idNat_Decision) Example General: 123456 | ||||
| period | ΣC | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner | ΣC | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| display | Σ | 0..1 | string | Text alternative for the resource | ||||
| provision | 0..* | See provision (Consent) | Nested Exception Rules | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Consent.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard | ||||
| Consent.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tagsfrom the FHIR Standard | ||||
| Consent.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Consent.status | required | Fixed Value: activehttp://hl7.org/fhir/ValueSet/consent-state-codes|4.0.1from the FHIR Standard | ||||
| Consent.scope | extensible | Fixed Value: patient-privacy("Privacy Consent")http://hl7.org/fhir/ValueSet/consent-scopefrom the FHIR Standard | ||||
| Consent.category | extensible | Fixed Value: LOINC code 59284-0("Consent")http://hl7.org/fhir/ValueSet/consent-categoryfrom the FHIR Standard | ||||
| Consent.policyRule | extensible | ConsentPolicyRuleCodeshttp://hl7.org/fhir/ValueSet/consent-policyfrom the FHIR Standard | ||||
| Consent.provision.type | required | ConsentProvisionTypehttp://hl7.org/fhir/ValueSet/consent-provision-type|4.0.1from the FHIR Standard | ||||
| Consent.provision.actor.role | extensible | SecurityRoleTypehttp://hl7.org/fhir/ValueSet/security-role-typefrom the FHIR Standard | ||||
| Consent.provision.action | example | ConsentActionCodeshttp://hl7.org/fhir/ValueSet/consent-actionfrom the FHIR Standard | ||||
| Consent.provision.securityLabel | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard | ||||
| Consent.provision.purpose | extensible | PurposeOfUsehttp://terminology.hl7.org/ValueSet/v3-PurposeOfUse | ||||
| Consent.provision.class | extensible | ConsentContentClasshttp://hl7.org/fhir/ValueSet/consent-content-classfrom the FHIR Standard | ||||
| Consent.provision.code | example | ConsentContentCodes (a valid code from LOINC)http://hl7.org/fhir/ValueSet/consent-content-codefrom the FHIR Standard | ||||
| Consent.provision.data.meaning | required | Fixed Value: relatedhttp://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1from the FHIR Standard | ||||
| Consent.provision.data.reference.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types | ||||
| Consent.provision.data.reference.identifier.use | required | Fixed Value: officialhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | ||||
| Consent.provision.data.reference.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Consent | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Consent | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Consent | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Consent | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Consent | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** elements | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| per-1 | error | Consent.provision.period, Consent.provision.dataPeriod, Consent.provision.data.reference.identifier.period | If present, start SHALL have a lower value than end : start.hasValue().not() or end.hasValue().not() or (start <= end) | |
| ppc-1 | error | Consent | Either a Policy or PolicyRule : policy.exists() or policyRule.exists() | |
| ppc-2 | error | Consent | IF Scope=privacy, there must be a patient : patient.exists() or scope.coding.where(system='something' and code='patient-privacy').exists().not() | |
| ppc-3 | error | Consent | IF Scope=research, there must be a patient : patient.exists() or scope.coding.where(system='something' and code='research').exists().not() | |
| ppc-4 | error | Consent | IF Scope=adr, there must be a patient : patient.exists() or scope.coding.where(system='something' and code='adr').exists().not() | |
| ppc-5 | error | Consent | IF Scope=treatment, there must be a patient : patient.exists() or scope.coding.where(system='something' and code='treatment').exists().not() | |
| ref-1 | error | Consent.patient, Consent.performer, Consent.organization, Consent.verification.verifiedWith, Consent.provision.actor.reference, Consent.provision.data.reference, Consent.provision.data.reference.identifier.assigner | SHALL have a contained resource if a local reference is provided : reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) |
This structure is derived from Consent
Differential View
This structure is derived from Consent
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Consent | 0..* | Consent | A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time | |
| meta | 1..1 | Meta | Metadata about the resource | |
| source | 1..1 | uri | Identifiant de l’ESMS créant la ressource (=idNat_Struct). Il s’agit de la structure bénéficiant de l’accord. | |
| status | 1..1 | code | draft | proposed | active | rejected | inactive | entered-in-error Fixed Value: active | |
| scope | 1..1 | CodeableConcept | Which of the four areas this resource covers (extensible) Fixed Value: As shown | |
| coding | 1..1 | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/consentscope | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: patient-privacy | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Privacy Consent | |
| category | 1..* | CodeableConcept | Classification of the consent statement - for indexing/retrieval Fixed Value: As shown | |
| coding | 1..1 | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 59284-0 | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Consent | |
| dateTime | 1..1 | dateTime | Date de recueil de l'accord de la personne orientée par l’ESMS. | |
| provision | 1..1 | BackboneElement | Constraints to the base Consent.policyRule | |
| data | 1..1 | BackboneElement | Data controlled by this rule | |
| meaning | 1..1 | code | instance | related | dependents | authoredby Fixed Value: related | |
| reference | 1..1 | Reference(https://hl7.org/fhir/R4/documentreference.html) | Référence à la ressource DocumentReference (dossier de décisions d’orientation) concernée par l’accord. | |
| identifier | 1..1 | Identifier | Référence logique vers la ressource (dossier de décisions d’orientation) pour laquelle s’applique cet accord | |
| use | 1..1 | code | usual | official | temp | secondary | old (If known) Fixed Value: official | |
| value | 1..1 | string | Valeur de l’identifier vers lequel la ressource Consent doit pointer (identifier officiel du documentReference = idNat_Decision) | |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Consent | C | 0..* | Consent | A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time |
| meta | Σ | 1..1 | Meta | Metadata about the resource |
| source | Σ | 1..1 | uri | Identifiant de l’ESMS créant la ressource (=idNat_Struct). Il s’agit de la structure bénéficiant de l’accord. |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| modifierExtension | ?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url |
| status | ?!Σ | 1..1 | code | draft | proposed | active | rejected | inactive | entered-in-error Binding: ConsentState (required): Indicates the state of the consent. Fixed Value: active |
| scope | ?!Σ | 1..1 | CodeableConcept | Which of the four areas this resource covers (extensible) Binding: ConsentScopeCodes (extensible): The four anticipated uses for the Consent Resource. Fixed Value: As shown |
| id | 0..0 | string | Unique id for inter-element referencing | |
| extension | 0..0 | Extension | Additional content defined by implementations | |
| coding | 1..1 | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| id | 0..0 | string | Unique id for inter-element referencing | |
| extension | 0..0 | Extension | Additional content defined by implementations | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/consentscope | |
| version | 0..0 | string | Version of the system - if relevant | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: patient-privacy | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Privacy Consent | |
| userSelected | 0..0 | boolean | If this coding was chosen directly by the user | |
| text | 0..0 | string | Plain text representation of the concept | |
| category | Σ | 1..* | CodeableConcept | Classification of the consent statement - for indexing/retrieval Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement. Fixed Value: As shown |
| id | 0..0 | string | Unique id for inter-element referencing | |
| extension | 0..0 | Extension | Additional content defined by implementations | |
| coding | 1..1 | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| id | 0..0 | string | Unique id for inter-element referencing | |
| extension | 0..0 | Extension | Additional content defined by implementations | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
| version | 0..0 | string | Version of the system - if relevant | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 59284-0 | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Consent | |
| userSelected | 0..0 | boolean | If this coding was chosen directly by the user | |
| text | 0..0 | string | Plain text representation of the concept | |
| dateTime | Σ | 1..1 | dateTime | Date de recueil de l'accord de la personne orientée par l’ESMS. |
| policyRule | ΣC | 0..1 | CodeableConcept | Regulation that this consents to Binding: ConsentPolicyRuleCodes (extensible): Regulatory policy examples. |
| provision | Σ | 1..1 | BackboneElement | Constraints to the base Consent.policyRule |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| data | Σ | 1..1 | BackboneElement | Data controlled by this rule |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| meaning | Σ | 1..1 | code | instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions. Fixed Value: related |
| reference | ΣC | 1..1 | Reference(https://hl7.org/fhir/R4/documentreference.html) | Référence à la ressource DocumentReference (dossier de décisions d’orientation) concernée par l’accord. |
| reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| identifier | Σ | 1..1 | Identifier | Référence logique vers la ressource (dossier de décisions d’orientation) pour laquelle s’applique cet accord |
| use | ?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official |
| value | Σ | 1..1 | string | Valeur de l’identifier vers lequel la ressource Consent doit pointer (identifier officiel du documentReference = idNat_Decision) Example General: 123456 |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Consent.status | required | Fixed Value: activehttp://hl7.org/fhir/ValueSet/consent-state-codes|4.0.1from the FHIR Standard | |
| Consent.scope | extensible | Fixed Value: patient-privacy("Privacy Consent")http://hl7.org/fhir/ValueSet/consent-scopefrom the FHIR Standard | |
| Consent.category | extensible | Fixed Value: LOINC code 59284-0("Consent")http://hl7.org/fhir/ValueSet/consent-categoryfrom the FHIR Standard | |
| Consent.policyRule | extensible | ConsentPolicyRuleCodeshttp://hl7.org/fhir/ValueSet/consent-policyfrom the FHIR Standard | |
| Consent.provision.data.meaning | required | Fixed Value: relatedhttp://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1from the FHIR Standard | |
| Consent.provision.data.reference.identifier.use | required | Fixed Value: officialhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Consent | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Consent | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Consent | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Consent | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Consent | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** elements | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ppc-1 | error | Consent | Either a Policy or PolicyRule : policy.exists() or policyRule.exists() | |
| ppc-2 | error | Consent | IF Scope=privacy, there must be a patient : patient.exists() or scope.coding.where(system='something' and code='patient-privacy').exists().not() | |
| ppc-3 | error | Consent | IF Scope=research, there must be a patient : patient.exists() or scope.coding.where(system='something' and code='research').exists().not() | |
| ppc-4 | error | Consent | IF Scope=adr, there must be a patient : patient.exists() or scope.coding.where(system='something' and code='adr').exists().not() | |
| ppc-5 | error | Consent | IF Scope=treatment, there must be a patient : patient.exists() or scope.coding.where(system='something' and code='treatment').exists().not() | |
| ref-1 | error | Consent.provision.data.reference | SHALL have a contained resource if a local reference is provided : reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Consent | C | 0..* | Consent | A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time | ||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 1..1 | Meta | Metadata about the resource | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| versionId | Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated | Σ | 0..1 | instant | When the resource version last changed | ||||
| source | Σ | 1..1 | uri | Identifiant de l’ESMS créant la ressource (=idNat_Struct). Il s’agit de la structure bénéficiant de l’accord. | ||||
| profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
| security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| modifierExtension | ?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url | ||||
| identifier | Σ | 0..* | Identifier | Identifier for this record (external references) Example General: {"system":"http://acme.org/identifier/local/eCMS","value":"Local eCMS identifier"} | ||||
| status | ?!Σ | 1..1 | code | draft | proposed | active | rejected | inactive | entered-in-error Binding: ConsentState (required): Indicates the state of the consent. Fixed Value: active | ||||
| scope | ?!Σ | 1..1 | CodeableConcept | Which of the four areas this resource covers (extensible) Binding: ConsentScopeCodes (extensible): The four anticipated uses for the Consent Resource. Fixed Value: As shown | ||||
| id | 0..0 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | Extension | Additional content defined by implementations | |||||
| coding | 1..1 | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..0 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/consentscope | |||||
| version | 0..0 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: patient-privacy | |||||
| display | 1..1 | string | Representation defined by the system Fixed Value: Privacy Consent | |||||
| userSelected | 0..0 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..0 | string | Plain text representation of the concept | |||||
| category | Σ | 1..* | CodeableConcept | Classification of the consent statement - for indexing/retrieval Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement. Fixed Value: As shown | ||||
| id | 0..0 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | Extension | Additional content defined by implementations | |||||
| coding | 1..1 | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..0 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |||||
| version | 0..0 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 59284-0 | |||||
| display | 1..1 | string | Representation defined by the system Fixed Value: Consent | |||||
| userSelected | 0..0 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..0 | string | Plain text representation of the concept | |||||
| patient | ΣC | 0..1 | Reference(Patient) | Who the consent applies to | ||||
| dateTime | Σ | 1..1 | dateTime | Date de recueil de l'accord de la personne orientée par l’ESMS. | ||||
| performer | ΣC | 0..* | Reference(Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | Who is agreeing to the policy and rules | ||||
| organization | ΣC | 0..* | Reference(Organization) | Custodian of the consent | ||||
| source[x] | Σ | 0..1 | Source from which this consent is taken | |||||
| sourceAttachment | Attachment | |||||||
| sourceReference | Reference(Consent | DocumentReference | Contract | QuestionnaireResponse) | |||||||
| policy | 0..* | BackboneElement | Policies covered by this consent | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| authority | C | 0..1 | uri | Enforcement source for policy | ||||
| uri | C | 0..1 | uri | Specific policy covered by this consent | ||||
| policyRule | ΣC | 0..1 | CodeableConcept | Regulation that this consents to Binding: ConsentPolicyRuleCodes (extensible): Regulatory policy examples. | ||||
| verification | Σ | 0..* | BackboneElement | Consent Verified by patient or family | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| verified | Σ | 1..1 | boolean | Has been verified | ||||
| verifiedWith | C | 0..1 | Reference(Patient | RelatedPerson) | Person who verified | ||||
| verificationDate | 0..1 | dateTime | When consent verified | |||||
| provision | Σ | 1..1 | BackboneElement | Constraints to the base Consent.policyRule | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type | Σ | 0..1 | code | deny | permit Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent. | ||||
| period | ΣC | 0..1 | Period | Timeframe for this rule | ||||
| actor | 0..* | BackboneElement | Who|what controlled by this rule (or group, by role) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| role | 1..1 | CodeableConcept | How the actor is involved Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations. | |||||
| reference | C | 1..1 | Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | Resource for the actor (or group, by role) | ||||
| action | Σ | 0..* | CodeableConcept | Actions controlled by this rule Binding: ConsentActionCodes (example): Detailed codes for the consent action. | ||||
| securityLabel | Σ | 0..* | Coding | Security Labels that define affected resources Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| purpose | Σ | 0..* | Coding | Context of activities covered by this rule Binding: PurposeOfUse (extensible): What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels. | ||||
| class | Σ | 0..* | Coding | e.g. Resource Type, Profile, CDA, etc. Binding: ConsentContentClass (extensible): The class (type) of information a consent rule covers. | ||||
| code | Σ | 0..* | CodeableConcept | e.g. LOINC or SNOMED CT code, etc. in the content Binding: ConsentContentCodes (example): If this code is found in an instance, then the exception applies. | ||||
| dataPeriod | ΣC | 0..1 | Period | Timeframe for data controlled by this rule | ||||
| data | Σ | 1..1 | BackboneElement | Data controlled by this rule | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| meaning | Σ | 1..1 | code | instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions. Fixed Value: related | ||||
| reference | ΣC | 1..1 | Reference(https://hl7.org/fhir/R4/documentreference.html) | Référence à la ressource DocumentReference (dossier de décisions d’orientation) concernée par l’accord. | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier | Σ | 1..1 | Identifier | Référence logique vers la ressource (dossier de décisions d’orientation) pour laquelle s’applique cet accord | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| use | ?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official | ||||
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value | Σ | 1..1 | string | Valeur de l’identifier vers lequel la ressource Consent doit pointer (identifier officiel du documentReference = idNat_Decision) Example General: 123456 | ||||
| period | ΣC | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner | ΣC | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| display | Σ | 0..1 | string | Text alternative for the resource | ||||
| provision | 0..* | See provision (Consent) | Nested Exception Rules | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Consent.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard | ||||
| Consent.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tagsfrom the FHIR Standard | ||||
| Consent.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Consent.status | required | Fixed Value: activehttp://hl7.org/fhir/ValueSet/consent-state-codes|4.0.1from the FHIR Standard | ||||
| Consent.scope | extensible | Fixed Value: patient-privacy("Privacy Consent")http://hl7.org/fhir/ValueSet/consent-scopefrom the FHIR Standard | ||||
| Consent.category | extensible | Fixed Value: LOINC code 59284-0("Consent")http://hl7.org/fhir/ValueSet/consent-categoryfrom the FHIR Standard | ||||
| Consent.policyRule | extensible | ConsentPolicyRuleCodeshttp://hl7.org/fhir/ValueSet/consent-policyfrom the FHIR Standard | ||||
| Consent.provision.type | required | ConsentProvisionTypehttp://hl7.org/fhir/ValueSet/consent-provision-type|4.0.1from the FHIR Standard | ||||
| Consent.provision.actor.role | extensible | SecurityRoleTypehttp://hl7.org/fhir/ValueSet/security-role-typefrom the FHIR Standard | ||||
| Consent.provision.action | example | ConsentActionCodeshttp://hl7.org/fhir/ValueSet/consent-actionfrom the FHIR Standard | ||||
| Consent.provision.securityLabel | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard | ||||
| Consent.provision.purpose | extensible | PurposeOfUsehttp://terminology.hl7.org/ValueSet/v3-PurposeOfUse | ||||
| Consent.provision.class | extensible | ConsentContentClasshttp://hl7.org/fhir/ValueSet/consent-content-classfrom the FHIR Standard | ||||
| Consent.provision.code | example | ConsentContentCodes (a valid code from LOINC)http://hl7.org/fhir/ValueSet/consent-content-codefrom the FHIR Standard | ||||
| Consent.provision.data.meaning | required | Fixed Value: relatedhttp://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1from the FHIR Standard | ||||
| Consent.provision.data.reference.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types | ||||
| Consent.provision.data.reference.identifier.use | required | Fixed Value: officialhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | ||||
| Consent.provision.data.reference.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Consent | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Consent | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Consent | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Consent | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Consent | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** elements | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| per-1 | error | Consent.provision.period, Consent.provision.dataPeriod, Consent.provision.data.reference.identifier.period | If present, start SHALL have a lower value than end : start.hasValue().not() or end.hasValue().not() or (start <= end) | |
| ppc-1 | error | Consent | Either a Policy or PolicyRule : policy.exists() or policyRule.exists() | |
| ppc-2 | error | Consent | IF Scope=privacy, there must be a patient : patient.exists() or scope.coding.where(system='something' and code='patient-privacy').exists().not() | |
| ppc-3 | error | Consent | IF Scope=research, there must be a patient : patient.exists() or scope.coding.where(system='something' and code='research').exists().not() | |
| ppc-4 | error | Consent | IF Scope=adr, there must be a patient : patient.exists() or scope.coding.where(system='something' and code='adr').exists().not() | |
| ppc-5 | error | Consent | IF Scope=treatment, there must be a patient : patient.exists() or scope.coding.where(system='something' and code='treatment').exists().not() | |
| ref-1 | error | Consent.patient, Consent.performer, Consent.organization, Consent.verification.verifiedWith, Consent.provision.actor.reference, Consent.provision.data.reference, Consent.provision.data.reference.identifier.assigner | SHALL have a contained resource if a local reference is provided : reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) |
This structure is derived from Consent
Other representations of profile: CSV, Excel, Schematron