Update DocumentReference Resource
put
/oracle-fhir-server/fhir/DocumentReference/{id}
This api lets you create a new current version for an existing DocumentReference resource or creates an initial version if no DocumentReference resource already exists for the given id.
Request
Path Parameters
Root Schema : DocumentReference
Type:
Show Source
object-
authenticator:
object Account_coverage
-
author:
array author
Minimum Number of Items:
1Unique Items Required:true -
category:
array category
Minimum Number of Items:
1Unique Items Required:true -
contained:
array contained
Minimum Number of Items:
1Unique Items Required:true -
content:
array content
Minimum Number of Items:
1Unique Items Required:true -
context:
object DocumentReference_context
-
custodian:
object Account_coverage
-
date:
string
Minimum Length:
1 -
description:
string
Minimum Length:
1 -
docStatus:
string
Minimum Length:
1 -
id:
string
Minimum Length:
1 -
identifier:
array identifier
Minimum Number of Items:
1Unique Items Required:true -
masterIdentifier:
object Account_identifier
-
meta:
object Account_meta
-
relatesTo:
array relatesTo
Minimum Number of Items:
1Unique Items Required:true -
resourceType:
string
Minimum Length:
1 -
securityLabel:
array securityLabel
Minimum Number of Items:
1Unique Items Required:true -
status:
string
Minimum Length:
1 -
subject:
object Account_coverage
-
text:
object Account_text
-
type:
object ActivityDefinition_valueCodeableConcept
Nested Schema : category
Type:
arrayMinimum Number of Items:
1Unique Items Required:
Show Source
trueNested Schema : contained
Type:
arrayMinimum Number of Items:
1Unique Items Required:
Show Source
trueNested Schema : content
Type:
arrayMinimum Number of Items:
1Unique Items Required:
Show Source
trueNested Schema : DocumentReference_context
Type:
Show Source
object-
encounter:
array encounter
Minimum Number of Items:
1Unique Items Required:true -
event:
array event
Minimum Number of Items:
1Unique Items Required:true -
facilityType:
object ActivityDefinition_valueCodeableConcept
-
period:
object Account_servicePeriod
-
practiceSetting:
object ActivityDefinition_valueCodeableConcept
- related: array related
-
sourcePatientInfo:
object Account_coverage
Nested Schema : identifier
Type:
arrayMinimum Number of Items:
1Unique Items Required:
Show Source
trueNested Schema : Account_identifier
Type:
Show Source
object-
system:
string
Minimum Length:
1 -
value:
string
Minimum Length:
1
Nested Schema : Account_meta
Type:
Show Source
object-
tag:
array tag
Minimum Number of Items:
1Unique Items Required:true
Nested Schema : relatesTo
Type:
arrayMinimum Number of Items:
1Unique Items Required:
Show Source
trueNested Schema : securityLabel
Type:
arrayMinimum Number of Items:
1Unique Items Required:
Show Source
trueNested Schema : Account_text
Type:
Show Source
object-
div:
string
Minimum Length:
1 -
status:
string
Minimum Length:
1
Nested Schema : ActivityDefinition_valueCodeableConcept
Type:
Show Source
object-
coding:
array coding
Minimum Number of Items:
1Unique Items Required:true
Nested Schema : AdverseEvent_category
Type:
Show Source
object-
coding(optional):
array coding
Minimum Number of Items:
1Unique Items Required:true
Nested Schema : coding
Type:
arrayMinimum Number of Items:
1Unique Items Required:
Show Source
trueNested Schema : Account_type_coding
Type:
Show Source
object-
code:
string
Minimum Length:
1 -
display:
string
Minimum Length:
1 -
system:
string
Minimum Length:
1
Nested Schema : CareTeam_contained
Type:
Show Source
object-
id:
string
Minimum Length:
1 -
name(optional):
array name
Minimum Number of Items:
1Unique Items Required:true -
resourceType:
string
Minimum Length:
1
Nested Schema : CareTeam_name
Type:
Show Source
object-
family:
string
Minimum Length:
1 -
given(optional):
array given
Nested Schema : DocumentReference_attachment
Type:
Show Source
object-
contentType:
string
Minimum Length:
1 -
creation:
string
Minimum Length:
1 -
hash:
string
Minimum Length:
1 -
language:
string
Minimum Length:
1 -
size:
number
-
title:
string
Minimum Length:
1 -
url:
string
Minimum Length:
1
Nested Schema : encounter
Type:
arrayMinimum Number of Items:
1Unique Items Required:
Show Source
trueNested Schema : event
Type:
arrayMinimum Number of Items:
1Unique Items Required:
Show Source
trueNested Schema : Account_servicePeriod
Type:
Show Source
object-
end:
string
Minimum Length:
1 -
start:
string
Minimum Length:
1
Nested Schema : DocumentReference_relatesTo
Type:
Show Source
object-
code:
string
Minimum Length:
1 -
target(optional):
object Account_coverage
Nested Schema : coding
Type:
arrayMinimum Number of Items:
1Unique Items Required:
Show Source
trueResponse
200 Response
Success