Package org.ehrbase.rest.openehr.experimental

Class ItemTagController

java.lang.Object

org.ehrbase.rest.BaseController

org.ehrbase.rest.openehr.experimental.ItemTagController

All Implemented Interfaces:

ItemTagApiSpecification

@ConditionalOnMissingBean(name="primaryopenehritemtagcontroller")
@RestController
@RequestMapping(path="${ehrbase.rest.experimental.tags.context-path:/rest/experimental/tags}/ehr",
                produces="application/json")
@ConditionalOnProperty(name="ehrbase.rest.experimental.tags.enabled",
                       havingValue="true")
public class ItemTagController
extends BaseController
implements ItemTagApiSpecification

Experimental REST interface for

invalid @link

{@link <a href="https://specifications.openehr.org/releases/RM/latest/ehr.html#tags">4.2.6.

Tags}

Nested Class Summary

Nested classes/interfaces inherited from interface org.ehrbase.rest.openehr.specification.experimental.ItemTagApiSpecification

ItemTagApiSpecification.OperationTagsDelete, ItemTagApiSpecification.OperationTagsGet, ItemTagApiSpecification.OperationTagUpsert, ItemTagApiSpecification.ParameterDeleteIDs, ItemTagApiSpecification.ParameterEhrId, ItemTagApiSpecification.ParameterFilterIds, ItemTagApiSpecification.ParameterFilterKeys, ItemTagApiSpecification.ParameterPrefer, ItemTagApiSpecification.ParameterVersionedObjectId

Field Summary

Fields inherited from class org.ehrbase.rest.BaseController

ACCEPT, ADMIN_API_CONTEXT_PATH, API_CONTEXT_PATH, API_CONTEXT_PATH_WITH_VERSION, apiContextPathWithVersion, COMPOSITION, CONTENT_TYPE, CONTRIBUTION, DEFINITION, DIRECTORY, EHR, EHR_STATUS, ETAG, IF_MATCH, LAST_MODIFIED, LOCATION, OPENEHR_AUDIT_DETAILS, OPENEHR_VERSION, PREFER, QUERY, REQ_ACCEPT, REQ_CONTENT_TYPE, RESP_CONTENT_TYPE_DESC, RETURN_MINIMAL, RETURN_REPRESENTATION, TEMPLATE, VERSIONED_COMPOSITION, VERSIONED_EHR_STATUS

Constructor Summary

Constructors

Constructor	Description
ItemTagController(ItemTagService itemTagService)

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<Void>	deleteCompositionItemTags(String openehrVersion, String openehrAuditDetails, String ehrIdString, String versionedObjectUid, List<Object> itemTagsOrUUIDs)
org.springframework.http.ResponseEntity<Void>	deleteEhrStatusItemTags(String openehrVersion, String openehrAuditDetails, String ehrIdString, String versionedObjectUid, List<Object> itemTagsOrUUIDs)
org.springframework.http.ResponseEntity<List<ItemTagDto>>	getCompositionItemTags(String openehrVersion, String openehrAuditDetails, String ehrIdString, String versionedObjectUid, List<String> ids, List<String> keys)
org.springframework.http.ResponseEntity<List<ItemTagDto>>	getEhrStatusItemTags(String openehrVersion, String openehrAuditDetails, String ehrIdString, String versionedObjectUid, List<String> ids, List<String> keys)
org.springframework.http.ResponseEntity<Object>	upsertCompositionItemTags(String openehrVersion, String openehrAuditDetails, String prefer, String ehrIdString, String versionedObjectUid, List<ItemTagDto> itemTags)
org.springframework.http.ResponseEntity<Object>	upsertEhrStatusItemTags(String openehrVersion, String openehrAuditDetails, String prefer, String ehrIdString, String versionedObjectUid, List<ItemTagDto> itemTags)

Methods inherited from class org.ehrbase.rest.BaseController

createLocationUri, decodeVersionAtTime, extractCompositionRepresentation, extractVersionedObjectUidFromVersionUid, extractVersionFromVersionUid, getCompositionVersionedObjectUidString, getContextPath, getContributionVersionedObjectUidString, getEhrUuid, parseUUID, resolveContentType, resolveContentType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ItemTagController

public ItemTagController(ItemTagService itemTagService)

Method Details

upsertEhrStatusItemTags

@PutMapping(value="/{ehr_id}/ehr_status/{versioned_object_uid}/item_tag",
            consumes="application/json")
@ResponseStatus(OK)
public org.springframework.http.ResponseEntity<Object> upsertEhrStatusItemTags(@RequestHeader(value="openEHR-VERSION",required=false)
 String openehrVersion,
 @RequestHeader(value="openEHR-AUDIT_DETAILS",required=false)
 String openehrAuditDetails,
 @RequestHeader(value="Prefer",required=false)
 String prefer,
 @PathVariable("ehr_id")
 String ehrIdString,
 @PathVariable("versioned_object_uid")
 String versionedObjectUid,
 @RequestBody
 List<ItemTagDto> itemTags)

Specified by:

upsertEhrStatusItemTags in interface ItemTagApiSpecification

getEhrStatusItemTags

@GetMapping("/{ehr_id}/ehr_status/{versioned_object_uid}/item_tag")
@ResponseStatus(OK)
public org.springframework.http.ResponseEntity<List<ItemTagDto>> getEhrStatusItemTags(@RequestHeader(value="openEHR-VERSION",required=false)
 String openehrVersion,
 @RequestHeader(value="openEHR-AUDIT_DETAILS",required=false)
 String openehrAuditDetails,
 @PathVariable("ehr_id")
 String ehrIdString,
 @PathVariable("versioned_object_uid")
 String versionedObjectUid,
 @RequestParam(value="ids",required=false)
 List<String> ids,
 @RequestParam(value="keys",required=false)
 List<String> keys)

Specified by:

getEhrStatusItemTags in interface ItemTagApiSpecification

deleteEhrStatusItemTags

@DeleteMapping("/{ehr_id}/ehr_status/{versioned_object_uid}/item_tag")
@ResponseStatus(NO_CONTENT)
public org.springframework.http.ResponseEntity<Void> deleteEhrStatusItemTags(@RequestHeader(value="openEHR-VERSION",required=false)
 String openehrVersion,
 @RequestHeader(value="openEHR-AUDIT_DETAILS",required=false)
 String openehrAuditDetails,
 @PathVariable("ehr_id")
 String ehrIdString,
 @PathVariable("versioned_object_uid")
 String versionedObjectUid,
 @RequestBody
 List<Object> itemTagsOrUUIDs)

Specified by:

deleteEhrStatusItemTags in interface ItemTagApiSpecification

upsertCompositionItemTags

@PutMapping(value="/{ehr_id}/composition/{versioned_object_uid}/item_tag",
            consumes="application/json")
@ResponseStatus(OK)
public org.springframework.http.ResponseEntity<Object> upsertCompositionItemTags(@RequestHeader(value="openEHR-VERSION",required=false)
 String openehrVersion,
 @RequestHeader(value="openEHR-AUDIT_DETAILS",required=false)
 String openehrAuditDetails,
 @RequestHeader(value="Prefer",required=false)
 String prefer,
 @PathVariable("ehr_id")
 String ehrIdString,
 @PathVariable("versioned_object_uid")
 String versionedObjectUid,
 @RequestBody
 List<ItemTagDto> itemTags)

Specified by:

upsertCompositionItemTags in interface ItemTagApiSpecification

getCompositionItemTags

@GetMapping("/{ehr_id}/composition/{versioned_object_uid}/item_tag")
@ResponseStatus(OK)
public org.springframework.http.ResponseEntity<List<ItemTagDto>> getCompositionItemTags(@RequestHeader(value="openEHR-VERSION",required=false)
 String openehrVersion,
 @RequestHeader(value="openEHR-AUDIT_DETAILS",required=false)
 String openehrAuditDetails,
 @PathVariable("ehr_id")
 String ehrIdString,
 @PathVariable("versioned_object_uid")
 String versionedObjectUid,
 @RequestParam(value="ids",required=false)
 List<String> ids,
 @RequestParam(value="keys",required=false)
 List<String> keys)

Specified by:

getCompositionItemTags in interface ItemTagApiSpecification

deleteCompositionItemTags

@DeleteMapping("/{ehr_id}/composition/{versioned_object_uid}/item_tag")
@ResponseStatus(NO_CONTENT)
public org.springframework.http.ResponseEntity<Void> deleteCompositionItemTags(@RequestHeader(value="openEHR-VERSION",required=false)
 String openehrVersion,
 @RequestHeader(value="openEHR-AUDIT_DETAILS",required=false)
 String openehrAuditDetails,
 @PathVariable("ehr_id")
 String ehrIdString,
 @PathVariable("versioned_object_uid")
 String versionedObjectUid,
 @RequestBody
 List<Object> itemTagsOrUUIDs)

Specified by:

deleteCompositionItemTags in interface ItemTagApiSpecification