ResMed Core Implementation Guide
0.37.0 - ci-build International flag

ResMed Core Implementation Guide - Local Development build (v0.37.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: Patient Alert Raised Provenance

Official URL: http://resmed.com/fhir/core/StructureDefinition/patient-alert-raised Version: 0.37.0
Draft as of 2024-01-11 Computable Name: ResMedAlertStatus

Profile for provenance resource used to track alerts being raised

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from ResMedPatientProvenance

NameFlagsCard.TypeDescription & Constraintsdoco
.. Provenance 0..*ResMedPatientProvenanceWho, What, When for a set of resources
... contained 1..1ResMedContainedIssueClinical issue with action
.... status 1..1coderegistered | preliminary | final | amended +
Required Pattern: preliminary
... agent
.... who 1..1Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization)Who participated
Required Pattern: At least the following
..... reference1..1stringLiteral reference, Relative, internal or absolute URL
Fixed Value: Device/device-ACE-example
... entity 1..1BackboneElementAn entity used in this activity
.... role 1..1codederivation | revision | quotation | source | removal
Required Pattern: source
.... what 1..1Reference(DetectedIssue)Identity of entity

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Provenance 0..*ResMedPatientProvenanceWho, What, When for a set of resources
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... contained 1..1ResMedContainedIssueClinical issue with action
.... implicitRules ?!Σ0..1uriA set of rules under which this content was created
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... status ?!Σ1..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required): Indicates the status of the identified issue.


Required Pattern: preliminary
.... code Σ1..1CodeableConceptIssue Category, e.g. drug-drug, duplicate therapy, etc.
Binding: ResMed DetectedIssue code ValueSet (extensible)
.... detail 1..1stringDescription and context
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... recorded Σ1..1instantWhen the activity was recorded / updated
... Slices for reason 1..*CodeableConceptReason the activity is occurring
Slice: Unordered, Open by pattern:$this
Binding: PurposeOfUse (extensible): The reason the activity took place.


.... reason:coordOfCare 1..1CodeableConceptReason the activity is occurring
Binding: PurposeOfUse (extensible): The reason the activity took place.



Required Pattern: At least the following
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActReason
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: COC
... activity 1..1CodeableConceptActivity that occurred
Binding: ResMed Provenance activity type ValueSet (extensible)
... agent 1..1BackboneElementActor involved
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type Σ1..1CodeableConceptHow the agent participated
Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity.


Required Pattern: At least the following
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: PRF
.... Slices for role 1..*CodeableConceptWhat the agents role was
Slice: Unordered, Open by pattern:$this
Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity.


..... role:provider 1..1CodeableConceptWhat the agents role was
Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity.



Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleClass
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: PROV
.... who Σ1..1Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization)Who participated
Required Pattern: At least the following
..... reference1..1stringLiteral reference, Relative, internal or absolute URL
Fixed Value: Device/device-ACE-example
... entity 1..1BackboneElementAn entity used in this activity
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... role Σ1..1codederivation | revision | quotation | source | removal
Binding: ProvenanceEntityRole (required): How an entity was used in an activity.


Required Pattern: source
.... what Σ1..1Reference(DetectedIssue)Identity of entity

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Provenance.contained.statusrequiredPattern: preliminary
Provenance.contained.codeextensibleResMedDetectedIssueCodeValueSet
Provenance.reasonextensiblePurposeOfUse
Provenance.reason:coordOfCareextensiblePattern: COC
Provenance.activityextensibleResMedProvenanceActivityTypeValueSet
Provenance.agent.typeextensiblePattern: PRF
Provenance.agent.roleexampleSecurityRoleType
Provenance.agent.role:providerexamplePattern: PROV
Provenance.entity.rolerequiredPattern: source

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorProvenance, Provenance.containedIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorProvenance, Provenance.containedIf 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-4errorProvenance, Provenance.containedIf 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-5errorProvenance, Provenance.containedIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceProvenance, Provenance.containedA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Provenance 0..*ResMedPatientProvenanceWho, What, When for a set of resources
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 1..1ResMedContainedIssueClinical issue with action
.... id Σ0..1idLogical id of this artifact
.... meta Σ0..1MetaMetadata about the resource
.... implicitRules ?!Σ0..1uriA set of rules under which this content was created
.... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
.... text 0..1NarrativeText summary of the resource, for human interpretation
.... contained 0..*ResourceContained, inline Resources
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... identifier Σ0..*IdentifierUnique id for the detected issue
.... status ?!Σ1..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required): Indicates the status of the identified issue.


Required Pattern: preliminary
.... code Σ1..1CodeableConceptIssue Category, e.g. drug-drug, duplicate therapy, etc.
Binding: ResMed DetectedIssue code ValueSet (extensible)
.... severity Σ0..1codehigh | moderate | low
Binding: DetectedIssueSeverity (required): Indicates the potential degree of impact of the identified issue on the patient.

.... patient Σ0..1Reference(Patient)Associated patient
.... identified[x] Σ0..1When identified
..... identifiedDateTimedateTime
..... identifiedPeriodPeriod
.... author Σ0..1Reference(Practitioner | PractitionerRole | Device)The provider or device that identified the issue
.... implicated Σ0..*Reference(Resource)Problem resource
.... evidence 0..*BackboneElementSupporting evidence
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code 0..*CodeableConceptManifestation
Binding: ManifestationAndSymptomCodes (example): Codes that describes the types of evidence for a detected issue.


..... detail 0..*Reference(Resource)Supporting information
.... detail 1..1stringDescription and context
.... reference 0..1uriAuthority for issue
.... mitigation 0..*BackboneElementStep taken to address
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... action 1..1CodeableConceptWhat mitigation?
Binding: DetectedIssueMitigationAction (preferred): Codes describing steps taken to resolve the issue or other circumstances that mitigate the risk associated with the issue; e.g. 'added concurrent therapy', 'prior therapy documented', etc.

..... date 0..1dateTimeDate committed
..... author 0..1Reference(Practitioner | PractitionerRole)Who is committing?
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... target Σ1..1Reference(Patient)Target Reference(s) (usually version specific)
... occurred[x] 0..1When the activity occurred
.... occurredPeriodPeriod
.... occurredDateTimedateTime
... recorded Σ1..1instantWhen the activity was recorded / updated
... policy 0..*uriPolicy or plan the activity was defined by
... location 0..1Reference(Location)Where the activity occurred, if relevant
... Slices for reason 1..*CodeableConceptReason the activity is occurring
Slice: Unordered, Open by pattern:$this
Binding: PurposeOfUse (extensible): The reason the activity took place.


.... reason:coordOfCare 1..1CodeableConceptReason the activity is occurring
Binding: PurposeOfUse (extensible): The reason the activity took place.



Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActReason
...... version0..1stringVersion of the system - if relevant
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: COC
...... display0..1stringRepresentation defined by the system
...... userSelected0..1booleanIf this coding was chosen directly by the user
..... text0..1stringPlain text representation of the concept
... activity 1..1CodeableConceptActivity that occurred
Binding: ResMed Provenance activity type ValueSet (extensible)
... agent 1..1BackboneElementActor involved
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type Σ1..1CodeableConceptHow the agent participated
Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity.


Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
...... version0..1stringVersion of the system - if relevant
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: PRF
...... display0..1stringRepresentation defined by the system
...... userSelected0..1booleanIf this coding was chosen directly by the user
..... text0..1stringPlain text representation of the concept
.... Slices for role 1..*CodeableConceptWhat the agents role was
Slice: Unordered, Open by pattern:$this
Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity.


..... role:provider 1..1CodeableConceptWhat the agents role was
Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity.



Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleClass
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: PROV
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
.... who Σ1..1Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization)Who participated
Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... reference1..1stringLiteral reference, Relative, internal or absolute URL
Fixed Value: Device/device-ACE-example
..... type0..1uriType the reference refers to (e.g. "Patient")
..... identifier0..1IdentifierLogical reference, when literal reference is not known
..... display0..1stringText alternative for the resource
.... onBehalfOf 0..1Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization)Who the agent is representing
... entity 1..1BackboneElementAn entity used in this activity
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... role Σ1..1codederivation | revision | quotation | source | removal
Binding: ProvenanceEntityRole (required): How an entity was used in an activity.


Required Pattern: source
.... what Σ1..1Reference(DetectedIssue)Identity of entity
.... agent 0..*See agent (Provenance)Entity is attributed to this agent
... signature 0..*SignatureSignature on target

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Provenance.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Provenance.contained.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Provenance.contained.statusrequiredPattern: preliminary
Provenance.contained.codeextensibleResMedDetectedIssueCodeValueSet
Provenance.contained.severityrequiredDetectedIssueSeverity
Provenance.contained.evidence.codeexampleManifestationAndSymptomCodes
Provenance.contained.mitigation.actionpreferredDetectedIssueMitigationAction
Provenance.reasonextensiblePurposeOfUse
Provenance.reason:coordOfCareextensiblePattern: COC
Provenance.activityextensibleResMedProvenanceActivityTypeValueSet
Provenance.agent.typeextensiblePattern: PRF
Provenance.agent.roleexampleSecurityRoleType
Provenance.agent.role:providerexamplePattern: PROV
Provenance.entity.rolerequiredPattern: source

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorProvenance, Provenance.containedIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorProvenance, Provenance.containedIf 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-4errorProvenance, Provenance.containedIf 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-5errorProvenance, Provenance.containedIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceProvenance, Provenance.containedA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from ResMedPatientProvenance

Summary

Mandatory: 1 element

Structures

This structure refers to these other structures:

Differential View

This structure is derived from ResMedPatientProvenance

NameFlagsCard.TypeDescription & Constraintsdoco
.. Provenance 0..*ResMedPatientProvenanceWho, What, When for a set of resources
... contained 1..1ResMedContainedIssueClinical issue with action
.... status 1..1coderegistered | preliminary | final | amended +
Required Pattern: preliminary
... agent
.... who 1..1Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization)Who participated
Required Pattern: At least the following
..... reference1..1stringLiteral reference, Relative, internal or absolute URL
Fixed Value: Device/device-ACE-example
... entity 1..1BackboneElementAn entity used in this activity
.... role 1..1codederivation | revision | quotation | source | removal
Required Pattern: source
.... what 1..1Reference(DetectedIssue)Identity of entity

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Provenance 0..*ResMedPatientProvenanceWho, What, When for a set of resources
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... contained 1..1ResMedContainedIssueClinical issue with action
.... implicitRules ?!Σ0..1uriA set of rules under which this content was created
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... status ?!Σ1..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required): Indicates the status of the identified issue.


Required Pattern: preliminary
.... code Σ1..1CodeableConceptIssue Category, e.g. drug-drug, duplicate therapy, etc.
Binding: ResMed DetectedIssue code ValueSet (extensible)
.... detail 1..1stringDescription and context
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... recorded Σ1..1instantWhen the activity was recorded / updated
... Slices for reason 1..*CodeableConceptReason the activity is occurring
Slice: Unordered, Open by pattern:$this
Binding: PurposeOfUse (extensible): The reason the activity took place.


.... reason:coordOfCare 1..1CodeableConceptReason the activity is occurring
Binding: PurposeOfUse (extensible): The reason the activity took place.



Required Pattern: At least the following
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActReason
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: COC
... activity 1..1CodeableConceptActivity that occurred
Binding: ResMed Provenance activity type ValueSet (extensible)
... agent 1..1BackboneElementActor involved
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type Σ1..1CodeableConceptHow the agent participated
Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity.


Required Pattern: At least the following
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: PRF
.... Slices for role 1..*CodeableConceptWhat the agents role was
Slice: Unordered, Open by pattern:$this
Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity.


..... role:provider 1..1CodeableConceptWhat the agents role was
Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity.



Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleClass
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: PROV
.... who Σ1..1Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization)Who participated
Required Pattern: At least the following
..... reference1..1stringLiteral reference, Relative, internal or absolute URL
Fixed Value: Device/device-ACE-example
... entity 1..1BackboneElementAn entity used in this activity
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... role Σ1..1codederivation | revision | quotation | source | removal
Binding: ProvenanceEntityRole (required): How an entity was used in an activity.


Required Pattern: source
.... what Σ1..1Reference(DetectedIssue)Identity of entity

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Provenance.contained.statusrequiredPattern: preliminary
Provenance.contained.codeextensibleResMedDetectedIssueCodeValueSet
Provenance.reasonextensiblePurposeOfUse
Provenance.reason:coordOfCareextensiblePattern: COC
Provenance.activityextensibleResMedProvenanceActivityTypeValueSet
Provenance.agent.typeextensiblePattern: PRF
Provenance.agent.roleexampleSecurityRoleType
Provenance.agent.role:providerexamplePattern: PROV
Provenance.entity.rolerequiredPattern: source

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorProvenance, Provenance.containedIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorProvenance, Provenance.containedIf 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-4errorProvenance, Provenance.containedIf 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-5errorProvenance, Provenance.containedIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceProvenance, Provenance.containedA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Provenance 0..*ResMedPatientProvenanceWho, What, When for a set of resources
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 1..1ResMedContainedIssueClinical issue with action
.... id Σ0..1idLogical id of this artifact
.... meta Σ0..1MetaMetadata about the resource
.... implicitRules ?!Σ0..1uriA set of rules under which this content was created
.... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
.... text 0..1NarrativeText summary of the resource, for human interpretation
.... contained 0..*ResourceContained, inline Resources
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... identifier Σ0..*IdentifierUnique id for the detected issue
.... status ?!Σ1..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required): Indicates the status of the identified issue.


Required Pattern: preliminary
.... code Σ1..1CodeableConceptIssue Category, e.g. drug-drug, duplicate therapy, etc.
Binding: ResMed DetectedIssue code ValueSet (extensible)
.... severity Σ0..1codehigh | moderate | low
Binding: DetectedIssueSeverity (required): Indicates the potential degree of impact of the identified issue on the patient.

.... patient Σ0..1Reference(Patient)Associated patient
.... identified[x] Σ0..1When identified
..... identifiedDateTimedateTime
..... identifiedPeriodPeriod
.... author Σ0..1Reference(Practitioner | PractitionerRole | Device)The provider or device that identified the issue
.... implicated Σ0..*Reference(Resource)Problem resource
.... evidence 0..*BackboneElementSupporting evidence
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code 0..*CodeableConceptManifestation
Binding: ManifestationAndSymptomCodes (example): Codes that describes the types of evidence for a detected issue.


..... detail 0..*Reference(Resource)Supporting information
.... detail 1..1stringDescription and context
.... reference 0..1uriAuthority for issue
.... mitigation 0..*BackboneElementStep taken to address
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... action 1..1CodeableConceptWhat mitigation?
Binding: DetectedIssueMitigationAction (preferred): Codes describing steps taken to resolve the issue or other circumstances that mitigate the risk associated with the issue; e.g. 'added concurrent therapy', 'prior therapy documented', etc.

..... date 0..1dateTimeDate committed
..... author 0..1Reference(Practitioner | PractitionerRole)Who is committing?
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... target Σ1..1Reference(Patient)Target Reference(s) (usually version specific)
... occurred[x] 0..1When the activity occurred
.... occurredPeriodPeriod
.... occurredDateTimedateTime
... recorded Σ1..1instantWhen the activity was recorded / updated
... policy 0..*uriPolicy or plan the activity was defined by
... location 0..1Reference(Location)Where the activity occurred, if relevant
... Slices for reason 1..*CodeableConceptReason the activity is occurring
Slice: Unordered, Open by pattern:$this
Binding: PurposeOfUse (extensible): The reason the activity took place.


.... reason:coordOfCare 1..1CodeableConceptReason the activity is occurring
Binding: PurposeOfUse (extensible): The reason the activity took place.



Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActReason
...... version0..1stringVersion of the system - if relevant
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: COC
...... display0..1stringRepresentation defined by the system
...... userSelected0..1booleanIf this coding was chosen directly by the user
..... text0..1stringPlain text representation of the concept
... activity 1..1CodeableConceptActivity that occurred
Binding: ResMed Provenance activity type ValueSet (extensible)
... agent 1..1BackboneElementActor involved
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type Σ1..1CodeableConceptHow the agent participated
Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity.


Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
...... version0..1stringVersion of the system - if relevant
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: PRF
...... display0..1stringRepresentation defined by the system
...... userSelected0..1booleanIf this coding was chosen directly by the user
..... text0..1stringPlain text representation of the concept
.... Slices for role 1..*CodeableConceptWhat the agents role was
Slice: Unordered, Open by pattern:$this
Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity.


..... role:provider 1..1CodeableConceptWhat the agents role was
Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity.



Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleClass
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: PROV
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
.... who Σ1..1Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization)Who participated
Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... reference1..1stringLiteral reference, Relative, internal or absolute URL
Fixed Value: Device/device-ACE-example
..... type0..1uriType the reference refers to (e.g. "Patient")
..... identifier0..1IdentifierLogical reference, when literal reference is not known
..... display0..1stringText alternative for the resource
.... onBehalfOf 0..1Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization)Who the agent is representing
... entity 1..1BackboneElementAn entity used in this activity
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... role Σ1..1codederivation | revision | quotation | source | removal
Binding: ProvenanceEntityRole (required): How an entity was used in an activity.


Required Pattern: source
.... what Σ1..1Reference(DetectedIssue)Identity of entity
.... agent 0..*See agent (Provenance)Entity is attributed to this agent
... signature 0..*SignatureSignature on target

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Provenance.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Provenance.contained.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Provenance.contained.statusrequiredPattern: preliminary
Provenance.contained.codeextensibleResMedDetectedIssueCodeValueSet
Provenance.contained.severityrequiredDetectedIssueSeverity
Provenance.contained.evidence.codeexampleManifestationAndSymptomCodes
Provenance.contained.mitigation.actionpreferredDetectedIssueMitigationAction
Provenance.reasonextensiblePurposeOfUse
Provenance.reason:coordOfCareextensiblePattern: COC
Provenance.activityextensibleResMedProvenanceActivityTypeValueSet
Provenance.agent.typeextensiblePattern: PRF
Provenance.agent.roleexampleSecurityRoleType
Provenance.agent.role:providerexamplePattern: PROV
Provenance.entity.rolerequiredPattern: source

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorProvenance, Provenance.containedIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorProvenance, Provenance.containedIf 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-4errorProvenance, Provenance.containedIf 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-5errorProvenance, Provenance.containedIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceProvenance, Provenance.containedA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from ResMedPatientProvenance

Summary

Mandatory: 1 element

Structures

This structure refers to these other structures:

 

Other representations of profile: CSV, Excel, Schematron