1. FHIR R4 APIs for Oracle Health Millennium Platform
  2. Tasks
  3. Provenance

Create a provenance

post

/Provenance

Creates a new provenance.

Note:

  • Only the body fields mentioned below are supported. Unsupported fields are ignored or can result in errors.
  • The Provenance.write scope must be provided to create a provenance with an observation measurement target.

Authorization Types

This operation supports the following authorization types:

Request

Supported Media Types
Header Parameters
Body ()
The body of the create operation
Root Schema : ProvenanceCreate
Type: object
A summary representation of the create (POST) operation for a provenance.
Show Source
  • agent
    An actor with a role in an activity who can be assigned some degree of responsibility for the activity.
    Note: Provide at least one agent.
    Example: 
    {
  "agent": [
    {
      "type": {
        "coding": [
          {
            "system": "http://hl7.org/fhir/us/core/CodeSystem/us-core-provenance-participant-type",
            "code": "transmitter"
          }
        ]
      },
      "role": [
        {
          "coding": [
            {
              "system": "http://terminology.hl7.org/CodeSystem/contractsignertypecodes",
              "code": "SOURCE"
            }
          ]
        }
      ],
      "who": {
        "reference": "Organization/619848"
      }
    }
  ]
}
  • entity
    An entity used in this activity.
    Example: 
    {
  "entity": [
    {
      "role": "source",
      "what": {
        "reference": "DocumentReference/S-201"
      }
    }
  ]
}
  • The time at which the activity was recorded.
    Example: 
    {
  "recorded": "2019-10-25T14:57:43Z"
}
  • Allowed Values: [ "Provenance" ]
    The type of the FHIR resource.
  • target
    The references that were generated or updated by the activity described in this resource.
    Note:
    • Only one target may be provided.
    • The following resources are supported:
      • AllergyIntolerance
      • CarePlan
      • CareTeam
      • Condition
      • DiagnosticReport
      • DocumentReference
      • Encounter
      • Goal
      • Immunization
      • MedicationRequest
      • Observation
      • Patient
      • Procedure
    Example: 
    {
  "target": [
    {
      "reference": "DocumentReference/881049"
    }
  ]
}
Nested Schema : agent
Type: array
An actor with a role in an activity who can be assigned some degree of responsibility for the activity.
Note: Provide at least one agent.
Example: 
{
  "agent": [
    {
      "type": {
        "coding": [
          {
            "system": "http://hl7.org/fhir/us/core/CodeSystem/us-core-provenance-participant-type",
            "code": "transmitter"
          }
        ]
      },
      "role": [
        {
          "coding": [
            {
              "system": "http://terminology.hl7.org/CodeSystem/contractsignertypecodes",
              "code": "SOURCE"
            }
          ]
        }
      ],
      "who": {
        "reference": "Organization/619848"
      }
    }
  ]
}
Show Source
Nested Schema : entity
Type: array
An entity used in this activity.
Example: 
{
  "entity": [
    {
      "role": "source",
      "what": {
        "reference": "DocumentReference/S-201"
      }
    }
  ]
}
Show Source
Nested Schema : target
Type: object
The references that were generated or updated by the activity described in this resource.
Note:
  • Only one target may be provided.
  • The following resources are supported:
    • AllergyIntolerance
    • CarePlan
    • CareTeam
    • Condition
    • DiagnosticReport
    • DocumentReference
    • Encounter
    • Goal
    • Immunization
    • MedicationRequest
    • Observation
    • Patient
    • Procedure
Example: 
{
  "target": [
    {
      "reference": "DocumentReference/881049"
    }
  ]
}
Show Source
Nested Schema : items
Type: object
Show Source
  • agent.role
    The function of the agent with respect to the activity.
    Example: 
    {
  "role": [
    {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/contractsignertypecodes",
          "code": "SOURCE"
        }
      ]
    }
  ]
}
  • agent.type
    The participation the agent had with respect to the activity.
    Example: 
    {
  "type": {
    "coding": [
      {
        "system": "http://hl7.org/fhir/us/core/CodeSystem/us-core-provenance-participant-type",
        "code": "transmitter"
      }
    ]
  }
}
  • agent.who
    The individual, device, or organization that participated in the event.
    Example: 
    {
  "who": {
    "reference": "Organization/619848"
  }
}
Nested Schema : agent.role
Type: object
The function of the agent with respect to the activity.
Example: 
{
  "role": [
    {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/contractsignertypecodes",
          "code": "SOURCE"
        }
      ]
    }
  ]
}
Show Source
Nested Schema : agent.type
Type: object
The participation the agent had with respect to the activity.
Example: 
{
  "type": {
    "coding": [
      {
        "system": "http://hl7.org/fhir/us/core/CodeSystem/us-core-provenance-participant-type",
        "code": "transmitter"
      }
    ]
  }
}
Show Source
Nested Schema : agent.who
Type: object
The individual, device, or organization that participated in the event.
Example: 
{
  "who": {
    "reference": "Organization/619848"
  }
}
Show Source
Nested Schema : coding
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : coding
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : entity.what
Type: object
The identity of the entity used.
Example: 
{
  "what": {
    "reference": "DocumentReference/S-201"
  }
}
Show Source
Back to Top

Response

Supported Media Types

Default Response

Example Request: 
POST https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Provenance
Example Request Body: 
{
    'resourceType': 'Provenance',
    'target': [
      {
        'reference': 'DocumentReference/881049'
      }
    ],
    'recorded': '2019-10-25T14:57:43Z',
    'agent': [
      {
        'type': {
          'coding': [
            {
              'system': 'http://hl7.org/fhir/us/core/CodeSystem/us-core-provenance-participant-type',
              'code': 'transmitter'
            }
          ]
        },
        'role': [
          {
            'coding': [
              {
                'system': 'http://terminology.hl7.org/CodeSystem/contractsignertypecodes',
                'code': 'SOURCE'
              }
            ]
          }
        ],
        'who': {
          'reference': 'Organization/619848'
        }
      }
    ],
    'entity': [
      {
        'role': 'source',
        'what': {
          'reference': 'DocumentReference/S-201'
        }
      }
    ]
  }
Example Response: 
  Cache-Control: no-cache
  Content-Length: 0
  Content-Type: text/html
  Date: Tue, 31 Mar 2020 15:37:25 GMT
  Etag: W/"881057"
  Location: https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Provenance/doc-881057
  Last-Modified: Tue, 31 Mar 2020 15:37:25 GMT
  Vary: Origin
  opc-request-id: /11111111111111111111111111111111/11111111111111111111111111111111
  X-Request-Id: 11111111-1111-1111-1111-111111111111
The ETag response header indicates the current If-Match version to use on a subsequent update.
Headers
  • For Update or Patch versioning controls. Related to If-Match. When a resource performs an operation that creates or updates a record, an Etag value is returned as a header. This same value should be included in request headers as an If-Match for any subsequent update to that record.
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the X-Request-Id, if present.
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the opc-Request-Id, if present.
Back to Top