ProvenanceStatusSe

Introduction

The ProvenanceStatusSe profile is used to manipulate the status of other resources. This means that ProvenanceStatusSe does not represent an individual resource in the system.

Intended Use

If the external system is considered the master system of the information, ProvenanceStatusSe can be used to nullify (invalidate) the data in COSMIC if it is nullified (invalidated) in the master system. Intended user of the API is a healthcare professional with a specified HSA ID. The healthcare professional should have their assignment (medarbetaruppdrag) and be connected to the specified unit. The specified unit should also be identified with HSA ID.

Specific Rules and Limitations

Type Description
Rule The API should not be used by patients who wishes to nullify (invalidate) a QuestionnaireResponse or Observation. This needs to be handled with business routines outside the API communication.
Rule The API should not be used to transfer data between caregivers.
Rule The API for nullifying (invalidating) should be implemented for real-time use by external system due to the patient risk with having wrong information in COSMIC.
Limitation The only supported target is QuestionnaireResponse or Observation.
Limitation The only supported activity code is NULLIFY.
Limitation Reason.coding is not applicable for QuestionnaireResponse, only reason.text.
Limitation The only supported reason.coding for Observation is EIE.

Profile Overview

ProvenanceStatusSe

idΣ1..1string
id0..1string
extensionI0..*Extension
versionIdΣ0..1id
lastUpdatedΣ0..1instant
sourceΣ0..1uri
profileΣ1..1canonical(StructureDefinition)
securityΣ0..*CodingBinding
tagΣ0..*Coding
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
extensionI0..*Extension
modifierExtension?! I0..*Extension
targetΣ I1..*Reference(QuestionnaireResponseSe | Observation)
recordedΣ1..1instant
policy0..0uri
locationI0..0Reference(Location)
id0..1string
extensionI0..*Extension
codingΣ0..1Coding
textΣ1..1string
id0..1string
extensionI0..*Extension
codingΣ1..1Coding
textΣ0..1string
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
typeΣ0..1CodeableConceptBinding
role0..*CodeableConcept
id0..1string
extensionI0..*Extension
referenceΣ I0..1string
typeΣ1..1uriBindingFixed Value
id0..1string
extensionI0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uriFixed Value
valueΣ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
displayΣ0..1string
id0..1string
extensionI0..*Extension
referenceΣ I0..1string
typeΣ1..1uriBindingFixed Value
identifierΣ0..1Identifier
displayΣ0..1string
onBehalfOfI0..0Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization)
signature0..*Signature

Versions

COS version Profile version Required COSMIC version Date Description
4.1.0 1.0.0 R8.3.05 July 2021 Initial version, support for POST

Supported Operations

HTTP Methods

Method Description
POST Support to POST Provenance with target QuestionnaireResponse or Observation

Query Operations

Supported Queries

  1. POST [baseURL]/Provenance (Post)

Error Codes

In the table below, a few error messages specific for Provenance are listed.

Code Description Comment
400 Not supported target Occurs when provenance.target is something else than QuestionnaireResponse or Observation
400 Not supported activity Occurs when provenance.activity is something else than NULLIFY