Create a procedure

post

/Procedure

Creates a new procedure.

Request

Supported Media Types
Header Parameters
Body ()
Root Schema : ProcedureCreateBody
Type: object
Show Source
  • basedOn
    A reference to a resource that contains details of the request for this procedure.
    Note: Must only include references to ServiceRequest.
    Example:
    {
      "basedOn": {
        "reference":"ServiceRequest/361330415"
      }
    }
    
  • category
    A code that classifies the procedure for searching, sorting, and display purposes.
    Example:
    {
      "category": {
        "coding": [
          {
            "system": "http://hl7.org/fhir/us/core/CodeSystem/us-core-category",
            "code": "sdoh"
          }
        ]
      }
    }
    
  • code
    A code to identify a specific procedure.
    Note: Must be provided.
    Example:
    {
      "code": {
        "coding": [
          {
            "system": "http://snomed.info/sct",
            "code": "119954001",
            "display": "Adenoid excision (procedure)",
            "userSelected": true
          }
        ],
        "text": "Adenoid excision (text)"
      }
    }
    
  • encounter
    Indicates the encounter when the procedure was performed.
    Note: Must only include references to Encounter.
    Example:
    {
      "encounter": {
        "reference":"Encounter/26070829"
      }
    }
    
  • location
    The location where the procedure actually happened.
    Note: Must only include references to Location.
    Example:
    {
      "location": {
        "reference":"Location/1693915",
        "display": "Baseline East"
      }
    }
    
  • note
    Any other notes and comments about the procedure.
    Example:
    {
      "note": [
        {
          "authorReference": {
            "reference": "Practitioner/4594011",
            "display": "Leroux, Erik"
          },
          "text": "Test Comment"
        }
      ]
    }
    
  • Estimated or actual date or date and time when the procedure was performed.
    Note:
    • Only a type of dateTime is supported.
    • The dateTime is converted to a GMT date.
    Example:
    {
      "performedDateTime": "2015-10-14T13:13:20-06:00"
    }
    
  • performedPeriod
    Estimated or actual period when the procedure was performed.
    Note:
    • Only a period with valid start and end dateTimes is supported.
    • Either performedPeriod or performedDateTime can be supplied. If both are present, performedPeriod will take precedence.
    • The dateTimes are converted to a GMT date.
    Example:
    {
      "performedPeriod": {
        "start": "2015-10-14T13:13:20-06:00",
        "end": "2015-10-14T14:12:20-06:00"
      }
    }
    
  • performer
    Limited to "real" people rather than equipment.
    Example:
    {
      "performer": [
        {
          "function": {
            "coding": [
              {
                "system": "http://snomed.info/sct",
                "code": "223366009",
                "display": "Healthcare professional (occupation)",
                "userSelected": true
              }
            ],
            "text": "Healthcare professional (occupation)"
          },
          "actor": {
            "reference": "Practitioner/2150097",
            "display": "Strecker, Bradley"
          }
        }
      ]
    }
    
  • performer.actor
    The practitioner who was involved in the procedure.
    Note: Must only include references to Practitioner.
    Example:
    {
      "actor": {
        "reference": "Practitioner/2150097",
        "display": "Strecker, Bradley"
      }
    }
    
  • performer.function
    Distinguishes the type of involvement of the performer in the procedure.
    Example:
    {
      "function": {
        "coding": [
          {
            "system": "http://snomed.info/sct",
            "code": "223366009",
            "display": "Healthcare professional (occupation)",
            "userSelected": true
          }
        ],
        "text": "Healthcare professional (occupation)"
      }
    }
    
    {
      "severity": {
        "coding": [
          {
            "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/388",
            "code": "1207",
            "display": "Anesthesiologist",
            "userSelected": true
          }
        ],
        "text": "Anesthesiologist"
      }
    }
    
  • The type of the FHIR resource. Must be Procedure.
  • Codes that identify the lifecycle stage of an event.
    Note: Only a status code completed is supported.
    Example:
    {
      "status": "completed"
    }
    
  • subject
    Indicates the patient who the procedure record is associated with.
    Note: Must only include references to Patient.
    Example:
    {
      "subject": {
        "reference": "Patient/631923",
        "display": "Nilsson, Christine"
      }
    }
    
Example:
{
  "resourceType": "Procedure",
  "status": "completed",
  "subject": {
    "reference": "Patient/12724066"
  },
  "code": {
    "coding": [
      {
        "system": "http://snomed.info/sct",
        "code": "119954001",
        "display": "Adenoid excision (procedure)",
        "userSelected": true
      }
    ],
    "text": "Adenoid excision (text)"
  },
  "encounter": {
    "reference": "Encounter/97953477"
  },
  "location": {
    "display": "Baseline East"
  },
  "performedDateTime": "2019-04-05T20:21:46Z",
  "performedPeriod": {
    "start": "2019-04-05T20:21:46Z",
    "end": "2019-04-05T21:21:46Z"
  },
  "performer": [
    {
      "function": {
        "coding": [
          {
            "system": "http://snomed.info/sct",
            "code": "223366009",
            "display": "Healthcare professional (occupation)",
            "userSelected": true
          }
        ],
        "text": "Healthcare professional (occupation)"
      },
      "actor": {
        "reference": "Practitioner/4122630"
      }
    }
  ],
  "note": [
    {
      "text": "Procedure comment",
      "time": "2019-04-05T20:21:46Z",
      "authorReference": {
        "reference": "Practitioner/4122630"
      }
    }
  ]
}
Nested Schema : basedOn
Type: object
A reference to a resource that contains details of the request for this procedure.
Note: Must only include references to ServiceRequest.
Example:
{
  "basedOn": {
    "reference":"ServiceRequest/361330415"
  }
}
Nested Schema : category
Type: object
A code that classifies the procedure for searching, sorting, and display purposes.
Example:
{
  "category": {
    "coding": [
      {
        "system": "http://hl7.org/fhir/us/core/CodeSystem/us-core-category",
        "code": "sdoh"
      }
    ]
  }
}
Nested Schema : code
Type: object
A code to identify a specific procedure.
Note: Must be provided.
Example:
{
  "code": {
    "coding": [
      {
        "system": "http://snomed.info/sct",
        "code": "119954001",
        "display": "Adenoid excision (procedure)",
        "userSelected": true
      }
    ],
    "text": "Adenoid excision (text)"
  }
}
Show Source
Nested Schema : encounter
Type: object
Indicates the encounter when the procedure was performed.
Note: Must only include references to Encounter.
Example:
{
  "encounter": {
    "reference":"Encounter/26070829"
  }
}
Show Source
Nested Schema : location
Type: object
The location where the procedure actually happened.
Note: Must only include references to Location.
Example:
{
  "location": {
    "reference":"Location/1693915",
    "display": "Baseline East"
  }
}
Show Source
Nested Schema : note
Type: array
Any other notes and comments about the procedure.
Example:
{
  "note": [
    {
      "authorReference": {
        "reference": "Practitioner/4594011",
        "display": "Leroux, Erik"
      },
      "text": "Test Comment"
    }
  ]
}
Show Source
Nested Schema : performedPeriod
Type: object
Estimated or actual period when the procedure was performed.
Note:
  • Only a period with valid start and end dateTimes is supported.
  • Either performedPeriod or performedDateTime can be supplied. If both are present, performedPeriod will take precedence.
  • The dateTimes are converted to a GMT date.
Example:
{
  "performedPeriod": {
    "start": "2015-10-14T13:13:20-06:00",
    "end": "2015-10-14T14:12:20-06:00"
  }
}
Show Source
Nested Schema : performer
Type: array
Limited to "real" people rather than equipment.
Example:
{
  "performer": [
    {
      "function": {
        "coding": [
          {
            "system": "http://snomed.info/sct",
            "code": "223366009",
            "display": "Healthcare professional (occupation)",
            "userSelected": true
          }
        ],
        "text": "Healthcare professional (occupation)"
      },
      "actor": {
        "reference": "Practitioner/2150097",
        "display": "Strecker, Bradley"
      }
    }
  ]
}
Show Source
Nested Schema : performer.actor
Type: object
The practitioner who was involved in the procedure.
Note: Must only include references to Practitioner.
Example:
{
  "actor": {
    "reference": "Practitioner/2150097",
    "display": "Strecker, Bradley"
  }
}
Show Source
Nested Schema : performer.function
Type: object
Distinguishes the type of involvement of the performer in the procedure.
Example:
{
  "function": {
    "coding": [
      {
        "system": "http://snomed.info/sct",
        "code": "223366009",
        "display": "Healthcare professional (occupation)",
        "userSelected": true
      }
    ],
    "text": "Healthcare professional (occupation)"
  }
}
{
  "severity": {
    "coding": [
      {
        "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/388",
        "code": "1207",
        "display": "Anesthesiologist",
        "userSelected": true
      }
    ],
    "text": "Anesthesiologist"
  }
}
Show Source
Nested Schema : subject
Type: object
Indicates the patient who the procedure record is associated with.
Note: Must only include references to Patient.
Example:
{
  "subject": {
    "reference": "Patient/631923",
    "display": "Nilsson, Christine"
  }
}
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 : authorReference
Type: object
Show Source
Nested Schema : items
Type: object
Nested Schema : coding
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top

Response

Supported Media Types

201 Response

**OK**
Headers
  • The identifier for a specific version of a resource. This identifier is formatted as W/"" and is used to specify the If-Match header value on subsequent updates.
  • The URL location of the created entity.
    Example: https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Procedure/642774
  • Oracle troubleshooting identifier.
  • Oracle troubleshooting identifier.

Default Response

Example Request:
POST https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Procedure
Example Response:
  Cache-Control: no-cache
  Content-Length: 0
  Content-Type: text/html
  Date: Mon, 06 Apr 2020 19:00:43 GMT
  Etag: W/"1"
  Location: https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Procedure/17228728
  Last-Modified: Mon, 06 Apr 2020 19:00:43 GMT
  Vary: Origin
  X-Request-Id: 11111111111111111111111111111111
The ETag response header indicates the current If-Match version to use on a subsequent update.
Back to Top