CH ATC (R4)
3.2.0 - Draft
CH ATC (R4)
3.2.0 - Draft
This page is part of the CH ATC (R4) (v3.2.0: Draft Ballot 4) 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: http://fhir.ch/ig/ch-atc/StructureDefinition/DocumentAuditEvent | Version: 3.2.0 | |||
| Active as of 2018-05-28 | Computable Name: DocumentAuditEvent | |||
Copyright/Legal: CC0-1.0 |
||||
This profile defines the content of the document audit events which a community has to provide for a patients audit trail.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from AuditEvent
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  AuditEvent | C | 0..* | AuditEvent | Document Audit Trail Content Profile ch-atc-dae-1: subtype needs to be fixed to ValueSet DocumentAuditEventType |
  type | 1..1 | Coding | Type/identifier of event Binding: AuditEventID (extensible): Type of event. | |
  Slices for subtype | 1..* | Coding | More specific type/id for the event Slice: Unordered, Open by value:system | |
   subtype:DocumentAuditEventType | 1..1 | Coding | DocumentAuditEventType Binding: DocumentAuditEventType (required): Document Audit Event Type | |
  system | 1..1 | uri | Identity of the terminology system Fixed Value: urn:oid:2.16.756.5.30.1.127.3.10.7 | |
| recorded | 1..1 | instant | Time when the event was recorded | |
| purposeOfEvent | 1..1 | CodeableConcept | The purposeOfUse of the event Binding: EprPurposeOfUse (required): EPR Purpose of Use | |
| agent | 1..* | BackboneElement | Participants | |
| role | 1..1 | CodeableConcept | Agent role in the event Binding: EprParticipant (required): EPR Participant | |
| who | ||||
  identifier | 1..1 | Identifier | Logical reference, when literal reference is not known | |
| name | 1..1 | string | Human friendly name for the agent | |
| requestor | 1..1 | boolean | Whether user is initiator | |
 Slices for entity | 0..* | BackboneElement | Data or objects used Slice: Unordered, Open by value:type.code, value:role.code | |
 entity:Patient | 1..1 | BackboneElement | Patient | |
  what | ||||
 identifier | 1..1 | Identifier | Patient Id (EPR-SPID) | |
| system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.756.5.30.1.127.3.10.3 | |
| type | 1..1 | Coding | Type of entity involved | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1 | |
 role | 1..1 | Coding | What role the entity played | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1 | |
| entity:Document | 0..1 | BackboneElement | Document | |
| what | ||||
| identifier | 1..1 | Identifier | XDSDocumentEntry.uniqueId | |
| type | 1..1 | Coding | Type of entity involved | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 2 | |
| role | 1..1 | Coding | What role the entity played | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 3 | |
| Slices for detail | 4..* | BackboneElement | Additional Information about the entity Slice: Unordered, Open by value:type | |
| detail:repositoryUniqueId | 1..1 | BackboneElement | repositoryUniqueId | |
 type | 1..1 | string | Name of the property Fixed Value: Repository Unique Id | |
 value | 1..1 | base64Binary | Property value | |
| detail:homeCommunityID | 1..1 | BackboneElement | homeCommunityID | |
| type | 1..1 | string | Name of the property Fixed Value: homeCommunityID | |
| value | 1..1 | base64Binary | Property value | |
| detail:EprDocumentTypeCode | 1..1 | BackboneElement | EprDocumentTypeCode | |
| type | 1..1 | string | Name of the property Fixed Value: EprDocumentTypeCode | |
| value | 1..1 | base64Binary | Property value | |
| detail:title | 1..1 | BackboneElement | title | |
| type | 1..1 | string | Name of the property Fixed Value: title | |
| value | 1..1 | base64Binary | Property value | |
| entity:Query | 0..1 | BackboneElement | Query | |
| what | ||||
| identifier | 1..1 | Identifier | Query ID (UUID) | |
| type | 1..1 | Coding | Type of entity involved | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 2 | |
| role | 1..1 | Coding | What role the entity played | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 24 | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| AuditEvent.type | extensible | AuditEventIDhttp://hl7.org/fhir/ValueSet/audit-event-typefrom the FHIR Standard | |
| AuditEvent.subtype:DocumentAuditEventType | required | DocumentAuditEventTypehttp://fhir.ch/ig/ch-atc/ValueSet/DocumentAuditEventTypefrom this IG | |
| AuditEvent.purposeOfEvent | required | EprPurposeOfUsehttp://fhir.ch/ig/ch-epr-term/ValueSet/EprPurposeOfUse | |
| AuditEvent.agent.role | required | EprParticipanthttp://fhir.ch/ig/ch-atc/ValueSet/EprParticipantfrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| ch-atc-dae-1 | error | AuditEvent | subtype needs to be fixed to ValueSet DocumentAuditEventType : subtype.exists() and subtype.count()=1 and subtype[0].code.startsWith('ATC_DOC') |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| AuditEvent | C | 0..* | AuditEvent | Document Audit Trail Content Profile ch-atc-dae-1: subtype needs to be fixed to ValueSet DocumentAuditEventType |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| type | Σ | 1..1 | Coding | Type/identifier of event Binding: AuditEventID (extensible): Type of event. |
| Slices for subtype | Σ | 1..* | Coding | More specific type/id for the event Slice: Unordered, Open by value:system Binding: AuditEventSub-Type (extensible): Sub-type of event. |
| subtype:DocumentAuditEventType | Σ | 1..1 | Coding | DocumentAuditEventType Binding: DocumentAuditEventType (required): Document Audit Event Type |
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: urn:oid:2.16.756.5.30.1.127.3.10.7 |
| recorded | Σ | 1..1 | instant | Time when the event was recorded |
| purposeOfEvent | Σ | 1..1 | CodeableConcept | The purposeOfUse of the event Binding: EprPurposeOfUse (required): EPR Purpose of Use |
| agent | 1..* | BackboneElement | Participants | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| role | 1..1 | CodeableConcept | Agent role in the event Binding: EprParticipant (required): EPR Participant | |
| name | 1..1 | string | Human friendly name for the agent | |
| requestor | Σ | 1..1 | boolean | Whether user is initiator |
| source | 1..1 | BackboneElement | Audit Event Reporter | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
 observer | Σ | 1..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | The identity of source detecting the event |
| Slices for entity | C | 0..* | BackboneElement | Data or objects used Slice: Unordered, Open by value:type.code, value:role.code |
| entity:All Slices | Content/Rules for all slices | |||
 modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| entity:Patient | C | 1..1 | BackboneElement | Patient |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type | 1..1 | Coding | Type of entity involved Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event. | |
| code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1 |
| role | 1..1 | Coding | What role the entity played Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event. | |
| code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1 |
| entity:Document | C | 0..1 | BackboneElement | Document |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type | 1..1 | Coding | Type of entity involved Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event. | |
| code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 2 |
| role | 1..1 | Coding | What role the entity played Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event. | |
| code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 3 |
| Slices for detail | 4..* | BackboneElement | Additional Information about the entity Slice: Unordered, Open by value:type | |
| detail:All Slices | Content/Rules for all slices | |||
 modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type | 1..1 | string | Name of the property | |
 value[x] | 1..1 | Property value | ||
| valueString | string | |||
| valueBase64Binary | base64Binary | |||
| detail:repositoryUniqueId | 1..1 | BackboneElement | repositoryUniqueId | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type | 1..1 | string | Name of the property Fixed Value: Repository Unique Id | |
| value[x] | 1..1 | base64Binary | Property value | |
| detail:homeCommunityID | 1..1 | BackboneElement | homeCommunityID | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type | 1..1 | string | Name of the property Fixed Value: homeCommunityID | |
| value[x] | 1..1 | base64Binary | Property value | |
| detail:EprDocumentTypeCode | 1..1 | BackboneElement | EprDocumentTypeCode | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type | 1..1 | string | Name of the property Fixed Value: EprDocumentTypeCode | |
| value[x] | 1..1 | base64Binary | Property value | |
| detail:title | 1..1 | BackboneElement | title | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type | 1..1 | string | Name of the property Fixed Value: title | |
| value[x] | 1..1 | base64Binary | Property value | |
| entity:Query | C | 0..1 | BackboneElement | Query |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type | 1..1 | Coding | Type of entity involved Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event. | |
| code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 2 |
| role | 1..1 | Coding | What role the entity played Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event. | |
| code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 24 |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| AuditEvent.type | extensible | AuditEventIDhttp://hl7.org/fhir/ValueSet/audit-event-typefrom the FHIR Standard | |
| AuditEvent.subtype | extensible | AuditEventSub-Typehttp://hl7.org/fhir/ValueSet/audit-event-sub-typefrom the FHIR Standard | |
| AuditEvent.subtype:DocumentAuditEventType | required | DocumentAuditEventTypehttp://fhir.ch/ig/ch-atc/ValueSet/DocumentAuditEventTypefrom this IG | |
| AuditEvent.purposeOfEvent | required | EprPurposeOfUsehttp://fhir.ch/ig/ch-epr-term/ValueSet/EprPurposeOfUse | |
| AuditEvent.agent.role | required | EprParticipanthttp://fhir.ch/ig/ch-atc/ValueSet/EprParticipantfrom this IG | |
| AuditEvent.entity:Patient.type | extensible | AuditEventEntityTypehttp://hl7.org/fhir/ValueSet/audit-entity-typefrom the FHIR Standard | |
| AuditEvent.entity:Patient.role | extensible | AuditEventEntityRolehttp://hl7.org/fhir/ValueSet/object-rolefrom the FHIR Standard | |
| AuditEvent.entity:Document.type | extensible | AuditEventEntityTypehttp://hl7.org/fhir/ValueSet/audit-entity-typefrom the FHIR Standard | |
| AuditEvent.entity:Document.role | extensible | AuditEventEntityRolehttp://hl7.org/fhir/ValueSet/object-rolefrom the FHIR Standard | |
| AuditEvent.entity:Query.type | extensible | AuditEventEntityTypehttp://hl7.org/fhir/ValueSet/audit-entity-typefrom the FHIR Standard | |
| AuditEvent.entity:Query.role | extensible | AuditEventEntityRolehttp://hl7.org/fhir/ValueSet/object-rolefrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| ch-atc-dae-1 | error | AuditEvent | subtype needs to be fixed to ValueSet DocumentAuditEventType : subtype.exists() and subtype.count()=1 and subtype[0].code.startsWith('ATC_DOC') | |
| dom-2 | error | AuditEvent | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | AuditEvent | 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 | AuditEvent | 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 | AuditEvent | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | AuditEvent | 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** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| sev-1 | error | AuditEvent.entity, AuditEvent.entity:Patient, AuditEvent.entity:Document, AuditEvent.entity:Query | Either a name or a query (NOT both) : name.empty() or query.empty() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| AuditEvent | C | 0..* | AuditEvent | Document Audit Trail Content Profile ch-atc-dae-1: subtype needs to be fixed to ValueSet DocumentAuditEventType | ||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| 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 | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| type | Σ | 1..1 | Coding | Type/identifier of event Binding: AuditEventID (extensible): Type of event. | ||||
| Slices for subtype | Σ | 1..* | Coding | More specific type/id for the event Slice: Unordered, Open by value:system Binding: AuditEventSub-Type (extensible): Sub-type of event. | ||||
| subtype:DocumentAuditEventType | Σ | 1..1 | Coding | DocumentAuditEventType Binding: DocumentAuditEventType (required): Document Audit Event Type | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: urn:oid:2.16.756.5.30.1.127.3.10.7 | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
| display | Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| action | Σ | 0..1 | code | Type of action performed during the event Binding: AuditEventAction (required): Indicator for type of action performed during the event that generated the event. | ||||
| period | 0..1 | Period | When the activity occurred | |||||
| recorded | Σ | 1..1 | instant | Time when the event was recorded | ||||
| outcome | Σ | 0..1 | code | Whether the event succeeded or failed Binding: AuditEventOutcome (required): Indicates whether the event succeeded or failed. | ||||
| outcomeDesc | Σ | 0..1 | string | Description of the event outcome | ||||
| purposeOfEvent | Σ | 1..1 | CodeableConcept | The purposeOfUse of the event Binding: EprPurposeOfUse (required): EPR Purpose of Use | ||||
| agent | 1..* | BackboneElement | Participants | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type | 0..1 | CodeableConcept | How agent participated Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event. | |||||
| role | 1..1 | CodeableConcept | Agent role in the event Binding: EprParticipant (required): EPR Participant | |||||
| who | Σ | 0..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | Identifier of who | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 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 | Logical reference, when literal reference is not known | ||||
| display | Σ | 0..1 | string | Text alternative for the resource | ||||
| altId | 0..1 | string | Alternative User identity | |||||
| name | 1..1 | string | Human friendly name for the agent | |||||
| requestor | Σ | 1..1 | boolean | Whether user is initiator | ||||
| location | 0..1 | Reference(Location) | Where | |||||
| policy | 0..* | uri | Policy that authorized event | |||||
| media | 0..1 | Coding | Type of media Binding: MediaTypeCode (extensible): Used when the event is about exporting/importing onto media. | |||||
| network | 0..1 | BackboneElement | Logical network location for application activity | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| address | 0..1 | string | Identifier for the network access point of the user device | |||||
| type | 0..1 | code | The type of network access point Binding: AuditEventAgentNetworkType (required): The type of network access point of this agent in the audit event. | |||||
| purposeOfUse | 0..* | CodeableConcept | Reason given for this user Binding: PurposeOfUse (extensible): The reason the activity took place. | |||||
| source | 1..1 | BackboneElement | Audit Event Reporter | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| site | 0..1 | string | Logical source location within the enterprise | |||||
| observer | Σ | 1..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | The identity of source detecting the event | ||||
| type | 0..* | Coding | The type of source where event originated Binding: AuditEventSourceType (extensible): Code specifying the type of system that detected and recorded the event. | |||||
| Slices for entity | C | 0..* | BackboneElement | Data or objects used Slice: Unordered, Open by value:type.code, value:role.code | ||||
| entity:All Slices | Content/Rules for all slices | |||||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| what | Σ | 0..1 | Reference(Resource) | Specific instance of resource | ||||
| type | 0..1 | Coding | Type of entity involved Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event. | |||||
| role | 0..1 | Coding | What role the entity played Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event. | |||||
| lifecycle | 0..1 | Coding | Life-cycle stage for the entity Binding: ObjectLifecycleEvents (extensible): Identifier for the data life-cycle stage for the entity. | |||||
| securityLabel | 0..* | Coding | Security labels on the entity Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | |||||
| name | ΣC | 0..1 | string | Descriptor for entity | ||||
| description | 0..1 | string | Descriptive text | |||||
| query | ΣC | 0..1 | base64Binary | Query parameters | ||||
| detail | 0..* | BackboneElement | Additional Information about the entity | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type | 1..1 | string | Name of the property | |||||
| value[x] | 1..1 | Property value | ||||||
| valueString | string | |||||||
| valueBase64Binary | base64Binary | |||||||
| entity:Patient | C | 1..1 | BackboneElement | Patient | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| what | Σ | 0..1 | Reference(Resource) | Specific instance of resource | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 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 | Patient Id (EPR-SPID) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| 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 | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.756.5.30.1.127.3.10.3 | ||||
| value | Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| display | Σ | 0..1 | string | Text alternative for the resource | ||||
| type | 1..1 | Coding | Type of entity involved Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event. | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | Σ | 0..1 | uri | Identity of the terminology system | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1 | ||||
| display | Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| role | 1..1 | Coding | What role the entity played Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event. | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | Σ | 0..1 | uri | Identity of the terminology system | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1 | ||||
| display | Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| lifecycle | 0..1 | Coding | Life-cycle stage for the entity Binding: ObjectLifecycleEvents (extensible): Identifier for the data life-cycle stage for the entity. | |||||
| securityLabel | 0..* | Coding | Security labels on the entity Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | |||||
| name | ΣC | 0..1 | string | Descriptor for entity | ||||
| description | 0..1 | string | Descriptive text | |||||
| query | ΣC | 0..1 | base64Binary | Query parameters | ||||
| detail | 0..* | BackboneElement | Additional Information about the entity | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type | 1..1 | string | Name of the property | |||||
| value[x] | 1..1 | Property value | ||||||
| valueString | string | |||||||
| valueBase64Binary | base64Binary | |||||||
| entity:Document | C | 0..1 | BackboneElement | Document | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| what | Σ | 0..1 | Reference(Resource) | Specific instance of resource | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 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 | XDSDocumentEntry.uniqueId | ||||
| display | Σ | 0..1 | string | Text alternative for the resource | ||||
| type | 1..1 | Coding | Type of entity involved Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event. | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | Σ | 0..1 | uri | Identity of the terminology system | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 2 | ||||
| display | Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| role | 1..1 | Coding | What role the entity played Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event. | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | Σ | 0..1 | uri | Identity of the terminology system | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 3 | ||||
| display | Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| lifecycle | 0..1 | Coding | Life-cycle stage for the entity Binding: ObjectLifecycleEvents (extensible): Identifier for the data life-cycle stage for the entity. | |||||
| securityLabel | 0..* | Coding | Security labels on the entity Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | |||||
| name | ΣC | 0..1 | string | Descriptor for entity | ||||
| description | 0..1 | string | Descriptive text | |||||
| query | ΣC | 0..1 | base64Binary | Query parameters | ||||
| Slices for detail | 4..* | BackboneElement | Additional Information about the entity Slice: Unordered, Open by value:type | |||||
| detail:All Slices | Content/Rules for all slices | |||||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type | 1..1 | string | Name of the property | |||||
| value[x] | 1..1 | Property value | ||||||
| valueString | string | |||||||
| valueBase64Binary | base64Binary | |||||||
| detail:repositoryUniqueId | 1..1 | BackboneElement | repositoryUniqueId | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type | 1..1 | string | Name of the property Fixed Value: Repository Unique Id | |||||
| value[x] | 1..1 | base64Binary | Property value | |||||
| detail:homeCommunityID | 1..1 | BackboneElement | homeCommunityID | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type | 1..1 | string | Name of the property Fixed Value: homeCommunityID | |||||
| value[x] | 1..1 | base64Binary | Property value | |||||
| detail:EprDocumentTypeCode | 1..1 | BackboneElement | EprDocumentTypeCode | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type | 1..1 | string | Name of the property Fixed Value: EprDocumentTypeCode | |||||
| value[x] | 1..1 | base64Binary | Property value | |||||
| detail:title | 1..1 | BackboneElement | title | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type | 1..1 | string | Name of the property Fixed Value: title | |||||
| value[x] | 1..1 | base64Binary | Property value | |||||
| entity:Query | C | 0..1 | BackboneElement | Query | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| what | Σ | 0..1 | Reference(Resource) | Specific instance of resource | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 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 | Query ID (UUID) | ||||
| display | Σ | 0..1 | string | Text alternative for the resource | ||||
| type | 1..1 | Coding | Type of entity involved Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event. | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | Σ | 0..1 | uri | Identity of the terminology system | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 2 | ||||
| display | Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| role | 1..1 | Coding | What role the entity played Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event. | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | Σ | 0..1 | uri | Identity of the terminology system | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 24 | ||||
| display | Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| lifecycle | 0..1 | Coding | Life-cycle stage for the entity Binding: ObjectLifecycleEvents (extensible): Identifier for the data life-cycle stage for the entity. | |||||
| securityLabel | 0..* | Coding | Security labels on the entity Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | |||||
| name | ΣC | 0..1 | string | Descriptor for entity | ||||
| description | 0..1 | string | Descriptive text | |||||
| query | ΣC | 0..1 | base64Binary | Query parameters | ||||
| detail | 0..* | BackboneElement | Additional Information about the entity | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type | 1..1 | string | Name of the property | |||||
| value[x] | 1..1 | Property value | ||||||
| valueString | string | |||||||
| valueBase64Binary | base64Binary | |||||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| AuditEvent.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| AuditEvent.type | extensible | AuditEventIDhttp://hl7.org/fhir/ValueSet/audit-event-typefrom the FHIR Standard | ||||
| AuditEvent.subtype | extensible | AuditEventSub-Typehttp://hl7.org/fhir/ValueSet/audit-event-sub-typefrom the FHIR Standard | ||||
| AuditEvent.subtype:DocumentAuditEventType | required | DocumentAuditEventTypehttp://fhir.ch/ig/ch-atc/ValueSet/DocumentAuditEventTypefrom this IG | ||||
| AuditEvent.action | required | AuditEventActionhttp://hl7.org/fhir/ValueSet/audit-event-action|4.0.1from the FHIR Standard | ||||
| AuditEvent.outcome | required | AuditEventOutcomehttp://hl7.org/fhir/ValueSet/audit-event-outcome|4.0.1from the FHIR Standard | ||||
| AuditEvent.purposeOfEvent | required | EprPurposeOfUsehttp://fhir.ch/ig/ch-epr-term/ValueSet/EprPurposeOfUse | ||||
| AuditEvent.agent.type | extensible | ParticipationRoleTypehttp://hl7.org/fhir/ValueSet/participation-role-typefrom the FHIR Standard | ||||
| AuditEvent.agent.role | required | EprParticipanthttp://fhir.ch/ig/ch-atc/ValueSet/EprParticipantfrom this IG | ||||
| AuditEvent.agent.who.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types | ||||
| AuditEvent.agent.media | extensible | MediaTypeCodehttp://hl7.org/fhir/ValueSet/dicm-405-mediatypefrom the FHIR Standard | ||||
| AuditEvent.agent.network.type | required | AuditEventAgentNetworkTypehttp://hl7.org/fhir/ValueSet/network-type|4.0.1from the FHIR Standard | ||||
| AuditEvent.agent.purposeOfUse | extensible | PurposeOfUsehttp://terminology.hl7.org/ValueSet/v3-PurposeOfUse | ||||
| AuditEvent.source.type | extensible | AuditEventSourceTypehttp://hl7.org/fhir/ValueSet/audit-source-typefrom the FHIR Standard | ||||
| AuditEvent.entity.type | extensible | AuditEventEntityTypehttp://hl7.org/fhir/ValueSet/audit-entity-typefrom the FHIR Standard | ||||
| AuditEvent.entity.role | extensible | AuditEventEntityRolehttp://hl7.org/fhir/ValueSet/object-rolefrom the FHIR Standard | ||||
| AuditEvent.entity.lifecycle | extensible | ObjectLifecycleEventshttp://hl7.org/fhir/ValueSet/object-lifecycle-eventsfrom the FHIR Standard | ||||
| AuditEvent.entity.securityLabel | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard | ||||
| AuditEvent.entity:Patient.what.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types | ||||
| AuditEvent.entity:Patient.what.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | ||||
| AuditEvent.entity:Patient.what.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | ||||
| AuditEvent.entity:Patient.type | extensible | AuditEventEntityTypehttp://hl7.org/fhir/ValueSet/audit-entity-typefrom the FHIR Standard | ||||
| AuditEvent.entity:Patient.role | extensible | AuditEventEntityRolehttp://hl7.org/fhir/ValueSet/object-rolefrom the FHIR Standard | ||||
| AuditEvent.entity:Patient.lifecycle | extensible | ObjectLifecycleEventshttp://hl7.org/fhir/ValueSet/object-lifecycle-eventsfrom the FHIR Standard | ||||
| AuditEvent.entity:Patient.securityLabel | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard | ||||
| AuditEvent.entity:Document.what.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types | ||||
| AuditEvent.entity:Document.type | extensible | AuditEventEntityTypehttp://hl7.org/fhir/ValueSet/audit-entity-typefrom the FHIR Standard | ||||
| AuditEvent.entity:Document.role | extensible | AuditEventEntityRolehttp://hl7.org/fhir/ValueSet/object-rolefrom the FHIR Standard | ||||
| AuditEvent.entity:Document.lifecycle | extensible | ObjectLifecycleEventshttp://hl7.org/fhir/ValueSet/object-lifecycle-eventsfrom the FHIR Standard | ||||
| AuditEvent.entity:Document.securityLabel | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard | ||||
| AuditEvent.entity:Query.what.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types | ||||
| AuditEvent.entity:Query.type | extensible | AuditEventEntityTypehttp://hl7.org/fhir/ValueSet/audit-entity-typefrom the FHIR Standard | ||||
| AuditEvent.entity:Query.role | extensible | AuditEventEntityRolehttp://hl7.org/fhir/ValueSet/object-rolefrom the FHIR Standard | ||||
| AuditEvent.entity:Query.lifecycle | extensible | ObjectLifecycleEventshttp://hl7.org/fhir/ValueSet/object-lifecycle-eventsfrom the FHIR Standard | ||||
| AuditEvent.entity:Query.securityLabel | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| ch-atc-dae-1 | error | AuditEvent | subtype needs to be fixed to ValueSet DocumentAuditEventType : subtype.exists() and subtype.count()=1 and subtype[0].code.startsWith('ATC_DOC') | |
| dom-2 | error | AuditEvent | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | AuditEvent | 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 | AuditEvent | 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 | AuditEvent | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | AuditEvent | 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** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| sev-1 | error | AuditEvent.entity, AuditEvent.entity:Patient, AuditEvent.entity:Document, AuditEvent.entity:Query | Either a name or a query (NOT both) : name.empty() or query.empty() |
This structure is derived from AuditEvent
Summary
Mandatory: 11 elements (17 nested mandatory elements)
Fixed Value: 12 elements
Slices
This structure defines the following Slices:
Differential View
This structure is derived from AuditEvent
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| AuditEvent | C | 0..* | AuditEvent | Document Audit Trail Content Profile ch-atc-dae-1: subtype needs to be fixed to ValueSet DocumentAuditEventType |
| type | 1..1 | Coding | Type/identifier of event Binding: AuditEventID (extensible): Type of event. | |
| Slices for subtype | 1..* | Coding | More specific type/id for the event Slice: Unordered, Open by value:system | |
| subtype:DocumentAuditEventType | 1..1 | Coding | DocumentAuditEventType Binding: DocumentAuditEventType (required): Document Audit Event Type | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: urn:oid:2.16.756.5.30.1.127.3.10.7 | |
| recorded | 1..1 | instant | Time when the event was recorded | |
| purposeOfEvent | 1..1 | CodeableConcept | The purposeOfUse of the event Binding: EprPurposeOfUse (required): EPR Purpose of Use | |
| agent | 1..* | BackboneElement | Participants | |
| role | 1..1 | CodeableConcept | Agent role in the event Binding: EprParticipant (required): EPR Participant | |
| who | ||||
| identifier | 1..1 | Identifier | Logical reference, when literal reference is not known | |
| name | 1..1 | string | Human friendly name for the agent | |
| requestor | 1..1 | boolean | Whether user is initiator | |
| Slices for entity | 0..* | BackboneElement | Data or objects used Slice: Unordered, Open by value:type.code, value:role.code | |
| entity:Patient | 1..1 | BackboneElement | Patient | |
| what | ||||
| identifier | 1..1 | Identifier | Patient Id (EPR-SPID) | |
| system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.756.5.30.1.127.3.10.3 | |
| type | 1..1 | Coding | Type of entity involved | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1 | |
| role | 1..1 | Coding | What role the entity played | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1 | |
| entity:Document | 0..1 | BackboneElement | Document | |
| what | ||||
| identifier | 1..1 | Identifier | XDSDocumentEntry.uniqueId | |
| type | 1..1 | Coding | Type of entity involved | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 2 | |
| role | 1..1 | Coding | What role the entity played | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 3 | |
| Slices for detail | 4..* | BackboneElement | Additional Information about the entity Slice: Unordered, Open by value:type | |
| detail:repositoryUniqueId | 1..1 | BackboneElement | repositoryUniqueId | |
| type | 1..1 | string | Name of the property Fixed Value: Repository Unique Id | |
| value | 1..1 | base64Binary | Property value | |
| detail:homeCommunityID | 1..1 | BackboneElement | homeCommunityID | |
| type | 1..1 | string | Name of the property Fixed Value: homeCommunityID | |
| value | 1..1 | base64Binary | Property value | |
| detail:EprDocumentTypeCode | 1..1 | BackboneElement | EprDocumentTypeCode | |
| type | 1..1 | string | Name of the property Fixed Value: EprDocumentTypeCode | |
| value | 1..1 | base64Binary | Property value | |
| detail:title | 1..1 | BackboneElement | title | |
| type | 1..1 | string | Name of the property Fixed Value: title | |
| value | 1..1 | base64Binary | Property value | |
| entity:Query | 0..1 | BackboneElement | Query | |
| what | ||||
| identifier | 1..1 | Identifier | Query ID (UUID) | |
| type | 1..1 | Coding | Type of entity involved | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 2 | |
| role | 1..1 | Coding | What role the entity played | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 24 | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| AuditEvent.type | extensible | AuditEventIDhttp://hl7.org/fhir/ValueSet/audit-event-typefrom the FHIR Standard | |
| AuditEvent.subtype:DocumentAuditEventType | required | DocumentAuditEventTypehttp://fhir.ch/ig/ch-atc/ValueSet/DocumentAuditEventTypefrom this IG | |
| AuditEvent.purposeOfEvent | required | EprPurposeOfUsehttp://fhir.ch/ig/ch-epr-term/ValueSet/EprPurposeOfUse | |
| AuditEvent.agent.role | required | EprParticipanthttp://fhir.ch/ig/ch-atc/ValueSet/EprParticipantfrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| ch-atc-dae-1 | error | AuditEvent | subtype needs to be fixed to ValueSet DocumentAuditEventType : subtype.exists() and subtype.count()=1 and subtype[0].code.startsWith('ATC_DOC') |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| AuditEvent | C | 0..* | AuditEvent | Document Audit Trail Content Profile ch-atc-dae-1: subtype needs to be fixed to ValueSet DocumentAuditEventType |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| type | Σ | 1..1 | Coding | Type/identifier of event Binding: AuditEventID (extensible): Type of event. |
| Slices for subtype | Σ | 1..* | Coding | More specific type/id for the event Slice: Unordered, Open by value:system Binding: AuditEventSub-Type (extensible): Sub-type of event. |
| subtype:DocumentAuditEventType | Σ | 1..1 | Coding | DocumentAuditEventType Binding: DocumentAuditEventType (required): Document Audit Event Type |
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: urn:oid:2.16.756.5.30.1.127.3.10.7 |
| recorded | Σ | 1..1 | instant | Time when the event was recorded |
| purposeOfEvent | Σ | 1..1 | CodeableConcept | The purposeOfUse of the event Binding: EprPurposeOfUse (required): EPR Purpose of Use |
| agent | 1..* | BackboneElement | Participants | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| role | 1..1 | CodeableConcept | Agent role in the event Binding: EprParticipant (required): EPR Participant | |
| name | 1..1 | string | Human friendly name for the agent | |
| requestor | Σ | 1..1 | boolean | Whether user is initiator |
| source | 1..1 | BackboneElement | Audit Event Reporter | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| observer | Σ | 1..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | The identity of source detecting the event |
| Slices for entity | C | 0..* | BackboneElement | Data or objects used Slice: Unordered, Open by value:type.code, value:role.code |
| entity:All Slices | Content/Rules for all slices | |||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| entity:Patient | C | 1..1 | BackboneElement | Patient |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type | 1..1 | Coding | Type of entity involved Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event. | |
| code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1 |
| role | 1..1 | Coding | What role the entity played Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event. | |
| code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1 |
| entity:Document | C | 0..1 | BackboneElement | Document |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type | 1..1 | Coding | Type of entity involved Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event. | |
| code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 2 |
| role | 1..1 | Coding | What role the entity played Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event. | |
| code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 3 |
| Slices for detail | 4..* | BackboneElement | Additional Information about the entity Slice: Unordered, Open by value:type | |
| detail:All Slices | Content/Rules for all slices | |||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type | 1..1 | string | Name of the property | |
| value[x] | 1..1 | Property value | ||
| valueString | string | |||
| valueBase64Binary | base64Binary | |||
| detail:repositoryUniqueId | 1..1 | BackboneElement | repositoryUniqueId | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type | 1..1 | string | Name of the property Fixed Value: Repository Unique Id | |
| value[x] | 1..1 | base64Binary | Property value | |
| detail:homeCommunityID | 1..1 | BackboneElement | homeCommunityID | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type | 1..1 | string | Name of the property Fixed Value: homeCommunityID | |
| value[x] | 1..1 | base64Binary | Property value | |
| detail:EprDocumentTypeCode | 1..1 | BackboneElement | EprDocumentTypeCode | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type | 1..1 | string | Name of the property Fixed Value: EprDocumentTypeCode | |
| value[x] | 1..1 | base64Binary | Property value | |
| detail:title | 1..1 | BackboneElement | title | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type | 1..1 | string | Name of the property Fixed Value: title | |
| value[x] | 1..1 | base64Binary | Property value | |
| entity:Query | C | 0..1 | BackboneElement | Query |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type | 1..1 | Coding | Type of entity involved Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event. | |
| code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 2 |
| role | 1..1 | Coding | What role the entity played Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event. | |
| code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 24 |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| AuditEvent.type | extensible | AuditEventIDhttp://hl7.org/fhir/ValueSet/audit-event-typefrom the FHIR Standard | |
| AuditEvent.subtype | extensible | AuditEventSub-Typehttp://hl7.org/fhir/ValueSet/audit-event-sub-typefrom the FHIR Standard | |
| AuditEvent.subtype:DocumentAuditEventType | required | DocumentAuditEventTypehttp://fhir.ch/ig/ch-atc/ValueSet/DocumentAuditEventTypefrom this IG | |
| AuditEvent.purposeOfEvent | required | EprPurposeOfUsehttp://fhir.ch/ig/ch-epr-term/ValueSet/EprPurposeOfUse | |
| AuditEvent.agent.role | required | EprParticipanthttp://fhir.ch/ig/ch-atc/ValueSet/EprParticipantfrom this IG | |
| AuditEvent.entity:Patient.type | extensible | AuditEventEntityTypehttp://hl7.org/fhir/ValueSet/audit-entity-typefrom the FHIR Standard | |
| AuditEvent.entity:Patient.role | extensible | AuditEventEntityRolehttp://hl7.org/fhir/ValueSet/object-rolefrom the FHIR Standard | |
| AuditEvent.entity:Document.type | extensible | AuditEventEntityTypehttp://hl7.org/fhir/ValueSet/audit-entity-typefrom the FHIR Standard | |
| AuditEvent.entity:Document.role | extensible | AuditEventEntityRolehttp://hl7.org/fhir/ValueSet/object-rolefrom the FHIR Standard | |
| AuditEvent.entity:Query.type | extensible | AuditEventEntityTypehttp://hl7.org/fhir/ValueSet/audit-entity-typefrom the FHIR Standard | |
| AuditEvent.entity:Query.role | extensible | AuditEventEntityRolehttp://hl7.org/fhir/ValueSet/object-rolefrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| ch-atc-dae-1 | error | AuditEvent | subtype needs to be fixed to ValueSet DocumentAuditEventType : subtype.exists() and subtype.count()=1 and subtype[0].code.startsWith('ATC_DOC') | |
| dom-2 | error | AuditEvent | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | AuditEvent | 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 | AuditEvent | 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 | AuditEvent | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | AuditEvent | 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** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| sev-1 | error | AuditEvent.entity, AuditEvent.entity:Patient, AuditEvent.entity:Document, AuditEvent.entity:Query | Either a name or a query (NOT both) : name.empty() or query.empty() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| AuditEvent | C | 0..* | AuditEvent | Document Audit Trail Content Profile ch-atc-dae-1: subtype needs to be fixed to ValueSet DocumentAuditEventType | ||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| 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 | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| type | Σ | 1..1 | Coding | Type/identifier of event Binding: AuditEventID (extensible): Type of event. | ||||
| Slices for subtype | Σ | 1..* | Coding | More specific type/id for the event Slice: Unordered, Open by value:system Binding: AuditEventSub-Type (extensible): Sub-type of event. | ||||
| subtype:DocumentAuditEventType | Σ | 1..1 | Coding | DocumentAuditEventType Binding: DocumentAuditEventType (required): Document Audit Event Type | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: urn:oid:2.16.756.5.30.1.127.3.10.7 | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
| display | Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| action | Σ | 0..1 | code | Type of action performed during the event Binding: AuditEventAction (required): Indicator for type of action performed during the event that generated the event. | ||||
| period | 0..1 | Period | When the activity occurred | |||||
| recorded | Σ | 1..1 | instant | Time when the event was recorded | ||||
| outcome | Σ | 0..1 | code | Whether the event succeeded or failed Binding: AuditEventOutcome (required): Indicates whether the event succeeded or failed. | ||||
| outcomeDesc | Σ | 0..1 | string | Description of the event outcome | ||||
| purposeOfEvent | Σ | 1..1 | CodeableConcept | The purposeOfUse of the event Binding: EprPurposeOfUse (required): EPR Purpose of Use | ||||
| agent | 1..* | BackboneElement | Participants | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type | 0..1 | CodeableConcept | How agent participated Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event. | |||||
| role | 1..1 | CodeableConcept | Agent role in the event Binding: EprParticipant (required): EPR Participant | |||||
| who | Σ | 0..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | Identifier of who | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 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 | Logical reference, when literal reference is not known | ||||
| display | Σ | 0..1 | string | Text alternative for the resource | ||||
| altId | 0..1 | string | Alternative User identity | |||||
| name | 1..1 | string | Human friendly name for the agent | |||||
| requestor | Σ | 1..1 | boolean | Whether user is initiator | ||||
| location | 0..1 | Reference(Location) | Where | |||||
| policy | 0..* | uri | Policy that authorized event | |||||
| media | 0..1 | Coding | Type of media Binding: MediaTypeCode (extensible): Used when the event is about exporting/importing onto media. | |||||
| network | 0..1 | BackboneElement | Logical network location for application activity | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| address | 0..1 | string | Identifier for the network access point of the user device | |||||
| type | 0..1 | code | The type of network access point Binding: AuditEventAgentNetworkType (required): The type of network access point of this agent in the audit event. | |||||
| purposeOfUse | 0..* | CodeableConcept | Reason given for this user Binding: PurposeOfUse (extensible): The reason the activity took place. | |||||
| source | 1..1 | BackboneElement | Audit Event Reporter | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| site | 0..1 | string | Logical source location within the enterprise | |||||
| observer | Σ | 1..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | The identity of source detecting the event | ||||
| type | 0..* | Coding | The type of source where event originated Binding: AuditEventSourceType (extensible): Code specifying the type of system that detected and recorded the event. | |||||
| Slices for entity | C | 0..* | BackboneElement | Data or objects used Slice: Unordered, Open by value:type.code, value:role.code | ||||
| entity:All Slices | Content/Rules for all slices | |||||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| what | Σ | 0..1 | Reference(Resource) | Specific instance of resource | ||||
| type | 0..1 | Coding | Type of entity involved Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event. | |||||
| role | 0..1 | Coding | What role the entity played Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event. | |||||
| lifecycle | 0..1 | Coding | Life-cycle stage for the entity Binding: ObjectLifecycleEvents (extensible): Identifier for the data life-cycle stage for the entity. | |||||
| securityLabel | 0..* | Coding | Security labels on the entity Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | |||||
| name | ΣC | 0..1 | string | Descriptor for entity | ||||
| description | 0..1 | string | Descriptive text | |||||
| query | ΣC | 0..1 | base64Binary | Query parameters | ||||
| detail | 0..* | BackboneElement | Additional Information about the entity | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type | 1..1 | string | Name of the property | |||||
| value[x] | 1..1 | Property value | ||||||
| valueString | string | |||||||
| valueBase64Binary | base64Binary | |||||||
| entity:Patient | C | 1..1 | BackboneElement | Patient | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| what | Σ | 0..1 | Reference(Resource) | Specific instance of resource | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 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 | Patient Id (EPR-SPID) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| 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 | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.756.5.30.1.127.3.10.3 | ||||
| value | Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| display | Σ | 0..1 | string | Text alternative for the resource | ||||
| type | 1..1 | Coding | Type of entity involved Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event. | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | Σ | 0..1 | uri | Identity of the terminology system | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1 | ||||
| display | Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| role | 1..1 | Coding | What role the entity played Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event. | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | Σ | 0..1 | uri | Identity of the terminology system | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1 | ||||
| display | Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| lifecycle | 0..1 | Coding | Life-cycle stage for the entity Binding: ObjectLifecycleEvents (extensible): Identifier for the data life-cycle stage for the entity. | |||||
| securityLabel | 0..* | Coding | Security labels on the entity Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | |||||
| name | ΣC | 0..1 | string | Descriptor for entity | ||||
| description | 0..1 | string | Descriptive text | |||||
| query | ΣC | 0..1 | base64Binary | Query parameters | ||||
| detail | 0..* | BackboneElement | Additional Information about the entity | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type | 1..1 | string | Name of the property | |||||
| value[x] | 1..1 | Property value | ||||||
| valueString | string | |||||||
| valueBase64Binary | base64Binary | |||||||
| entity:Document | C | 0..1 | BackboneElement | Document | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| what | Σ | 0..1 | Reference(Resource) | Specific instance of resource | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 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 | XDSDocumentEntry.uniqueId | ||||
| display | Σ | 0..1 | string | Text alternative for the resource | ||||
| type | 1..1 | Coding | Type of entity involved Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event. | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | Σ | 0..1 | uri | Identity of the terminology system | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 2 | ||||
| display | Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| role | 1..1 | Coding | What role the entity played Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event. | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | Σ | 0..1 | uri | Identity of the terminology system | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 3 | ||||
| display | Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| lifecycle | 0..1 | Coding | Life-cycle stage for the entity Binding: ObjectLifecycleEvents (extensible): Identifier for the data life-cycle stage for the entity. | |||||
| securityLabel | 0..* | Coding | Security labels on the entity Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | |||||
| name | ΣC | 0..1 | string | Descriptor for entity | ||||
| description | 0..1 | string | Descriptive text | |||||
| query | ΣC | 0..1 | base64Binary | Query parameters | ||||
| Slices for detail | 4..* | BackboneElement | Additional Information about the entity Slice: Unordered, Open by value:type | |||||
| detail:All Slices | Content/Rules for all slices | |||||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type | 1..1 | string | Name of the property | |||||
| value[x] | 1..1 | Property value | ||||||
| valueString | string | |||||||
| valueBase64Binary | base64Binary | |||||||
| detail:repositoryUniqueId | 1..1 | BackboneElement | repositoryUniqueId | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type | 1..1 | string | Name of the property Fixed Value: Repository Unique Id | |||||
| value[x] | 1..1 | base64Binary | Property value | |||||
| detail:homeCommunityID | 1..1 | BackboneElement | homeCommunityID | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type | 1..1 | string | Name of the property Fixed Value: homeCommunityID | |||||
| value[x] | 1..1 | base64Binary | Property value | |||||
| detail:EprDocumentTypeCode | 1..1 | BackboneElement | EprDocumentTypeCode | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type | 1..1 | string | Name of the property Fixed Value: EprDocumentTypeCode | |||||
| value[x] | 1..1 | base64Binary | Property value | |||||
| detail:title | 1..1 | BackboneElement | title | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type | 1..1 | string | Name of the property Fixed Value: title | |||||
| value[x] | 1..1 | base64Binary | Property value | |||||
| entity:Query | C | 0..1 | BackboneElement | Query | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| what | Σ | 0..1 | Reference(Resource) | Specific instance of resource | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 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 | Query ID (UUID) | ||||
| display | Σ | 0..1 | string | Text alternative for the resource | ||||
| type | 1..1 | Coding | Type of entity involved Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event. | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | Σ | 0..1 | uri | Identity of the terminology system | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 2 | ||||
| display | Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| role | 1..1 | Coding | What role the entity played Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event. | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | Σ | 0..1 | uri | Identity of the terminology system | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 24 | ||||
| display | Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| lifecycle | 0..1 | Coding | Life-cycle stage for the entity Binding: ObjectLifecycleEvents (extensible): Identifier for the data life-cycle stage for the entity. | |||||
| securityLabel | 0..* | Coding | Security labels on the entity Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | |||||
| name | ΣC | 0..1 | string | Descriptor for entity | ||||
| description | 0..1 | string | Descriptive text | |||||
| query | ΣC | 0..1 | base64Binary | Query parameters | ||||
| detail | 0..* | BackboneElement | Additional Information about the entity | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type | 1..1 | string | Name of the property | |||||
| value[x] | 1..1 | Property value | ||||||
| valueString | string | |||||||
| valueBase64Binary | base64Binary | |||||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| AuditEvent.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| AuditEvent.type | extensible | AuditEventIDhttp://hl7.org/fhir/ValueSet/audit-event-typefrom the FHIR Standard | ||||
| AuditEvent.subtype | extensible | AuditEventSub-Typehttp://hl7.org/fhir/ValueSet/audit-event-sub-typefrom the FHIR Standard | ||||
| AuditEvent.subtype:DocumentAuditEventType | required | DocumentAuditEventTypehttp://fhir.ch/ig/ch-atc/ValueSet/DocumentAuditEventTypefrom this IG | ||||
| AuditEvent.action | required | AuditEventActionhttp://hl7.org/fhir/ValueSet/audit-event-action|4.0.1from the FHIR Standard | ||||
| AuditEvent.outcome | required | AuditEventOutcomehttp://hl7.org/fhir/ValueSet/audit-event-outcome|4.0.1from the FHIR Standard | ||||
| AuditEvent.purposeOfEvent | required | EprPurposeOfUsehttp://fhir.ch/ig/ch-epr-term/ValueSet/EprPurposeOfUse | ||||
| AuditEvent.agent.type | extensible | ParticipationRoleTypehttp://hl7.org/fhir/ValueSet/participation-role-typefrom the FHIR Standard | ||||
| AuditEvent.agent.role | required | EprParticipanthttp://fhir.ch/ig/ch-atc/ValueSet/EprParticipantfrom this IG | ||||
| AuditEvent.agent.who.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types | ||||
| AuditEvent.agent.media | extensible | MediaTypeCodehttp://hl7.org/fhir/ValueSet/dicm-405-mediatypefrom the FHIR Standard | ||||
| AuditEvent.agent.network.type | required | AuditEventAgentNetworkTypehttp://hl7.org/fhir/ValueSet/network-type|4.0.1from the FHIR Standard | ||||
| AuditEvent.agent.purposeOfUse | extensible | PurposeOfUsehttp://terminology.hl7.org/ValueSet/v3-PurposeOfUse | ||||
| AuditEvent.source.type | extensible | AuditEventSourceTypehttp://hl7.org/fhir/ValueSet/audit-source-typefrom the FHIR Standard | ||||
| AuditEvent.entity.type | extensible | AuditEventEntityTypehttp://hl7.org/fhir/ValueSet/audit-entity-typefrom the FHIR Standard | ||||
| AuditEvent.entity.role | extensible | AuditEventEntityRolehttp://hl7.org/fhir/ValueSet/object-rolefrom the FHIR Standard | ||||
| AuditEvent.entity.lifecycle | extensible | ObjectLifecycleEventshttp://hl7.org/fhir/ValueSet/object-lifecycle-eventsfrom the FHIR Standard | ||||
| AuditEvent.entity.securityLabel | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard | ||||
| AuditEvent.entity:Patient.what.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types | ||||
| AuditEvent.entity:Patient.what.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | ||||
| AuditEvent.entity:Patient.what.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | ||||
| AuditEvent.entity:Patient.type | extensible | AuditEventEntityTypehttp://hl7.org/fhir/ValueSet/audit-entity-typefrom the FHIR Standard | ||||
| AuditEvent.entity:Patient.role | extensible | AuditEventEntityRolehttp://hl7.org/fhir/ValueSet/object-rolefrom the FHIR Standard | ||||
| AuditEvent.entity:Patient.lifecycle | extensible | ObjectLifecycleEventshttp://hl7.org/fhir/ValueSet/object-lifecycle-eventsfrom the FHIR Standard | ||||
| AuditEvent.entity:Patient.securityLabel | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard | ||||
| AuditEvent.entity:Document.what.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types | ||||
| AuditEvent.entity:Document.type | extensible | AuditEventEntityTypehttp://hl7.org/fhir/ValueSet/audit-entity-typefrom the FHIR Standard | ||||
| AuditEvent.entity:Document.role | extensible | AuditEventEntityRolehttp://hl7.org/fhir/ValueSet/object-rolefrom the FHIR Standard | ||||
| AuditEvent.entity:Document.lifecycle | extensible | ObjectLifecycleEventshttp://hl7.org/fhir/ValueSet/object-lifecycle-eventsfrom the FHIR Standard | ||||
| AuditEvent.entity:Document.securityLabel | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard | ||||
| AuditEvent.entity:Query.what.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types | ||||
| AuditEvent.entity:Query.type | extensible | AuditEventEntityTypehttp://hl7.org/fhir/ValueSet/audit-entity-typefrom the FHIR Standard | ||||
| AuditEvent.entity:Query.role | extensible | AuditEventEntityRolehttp://hl7.org/fhir/ValueSet/object-rolefrom the FHIR Standard | ||||
| AuditEvent.entity:Query.lifecycle | extensible | ObjectLifecycleEventshttp://hl7.org/fhir/ValueSet/object-lifecycle-eventsfrom the FHIR Standard | ||||
| AuditEvent.entity:Query.securityLabel | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| ch-atc-dae-1 | error | AuditEvent | subtype needs to be fixed to ValueSet DocumentAuditEventType : subtype.exists() and subtype.count()=1 and subtype[0].code.startsWith('ATC_DOC') | |
| dom-2 | error | AuditEvent | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | AuditEvent | 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 | AuditEvent | 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 | AuditEvent | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | AuditEvent | 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** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| sev-1 | error | AuditEvent.entity, AuditEvent.entity:Patient, AuditEvent.entity:Document, AuditEvent.entity:Query | Either a name or a query (NOT both) : name.empty() or query.empty() |
This structure is derived from AuditEvent
Summary
Mandatory: 11 elements (17 nested mandatory elements)
Fixed Value: 12 elements
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron