HeyDonto FHIR R4 API Documentation (1.0)

API documentation for HeyDonto API users

Languages
Servers
Mock server
https://docs.heydonto.com/_mock/apis/fhir/openapi/
Sandbox
https://api-staging.heydonto.com/
Production
https://api.heydonto.com/

Account

Operations

ActivityDefinition

Operations

AdverseEvent

Operations

AllergyIntolerance

Operations

Appointment

Operations

AppointmentResponse

Operations

AuditEvent

Operations

Basic

Operations

Binary

Operations

BiologicallyDerivedProduct

Operations

BodyStructure

Operations

Bundle

Operations

CapabilityStatement

Operations

CarePlan

Operations

CareTeam

Operations

CatalogEntry

Operations

ChargeItem

Operations

ChargeItemDefinition

Operations

Claim

Operations

ClaimResponse

Operations

ClinicalImpression

Operations

CodeSystem

Operations

Communication

Operations

CommunicationRequest

Operations

CompartmentDefinition

Operations

Composition

Operations

ConceptMap

Operations

Condition

Operations

Contract

Operations

Coverage

Operations

CoverageEligibilityRequest

Operations

CoverageEligibilityResponse

Operations

DetectedIssue

Operations

Device

Operations

DeviceDefinition

Operations

DeviceMetric

Operations

DeviceRequest

Operations

DeviceUseStatement

Operations

DiagnosticReport

Operations

DocumentManifest

Operations

DocumentReference

Operations

EffectEvidenceSynthesis

Operations

Encounter

Operations

Endpoint

Operations

EnrollmentRequest

Operations

EnrollmentResponse

Operations

EpisodeOfCare

Operations

EventDefinition

Operations

Evidence

Operations

EvidenceVariable

Operations

ExampleScenario

Operations

ExplanationOfBenefit

Operations

FamilyMemberHistory

Operations

Flag

Operations

Goal

Operations

GraphDefinition

Operations

Group

Operations

GuidanceResponse

Operations

HealthcareService

Operations

ImagingStudy

Operations

Immunization

Operations

ImmunizationEvaluation

Operations

ImmunizationRecommendation

Operations

ImplementationGuide

Operations

InsurancePlan

Operations

Invoice

Operations

Library

Operations

Linkage

Operations

List

Operations

Location

Operations

Measure

Operations

MeasureReport

Operations

Media

Operations

Medication

Operations

MedicationAdministration

Operations

MedicationDispense

Operations

MedicationKnowledge

Operations

MedicationRequest

Operations

MedicationStatement

Operations

MedicinalProduct

Operations

MedicinalProductAuthorization

Operations

MedicinalProductContraindication

Operations

MedicinalProductIndication

Operations

MedicinalProductIngredient

Operations

MedicinalProductInteraction

Operations

MedicinalProductManufactured

Operations

MedicinalProductPackaged

Operations

MedicinalProductPharmaceutical

Operations

MedicinalProductUndesirableEffect

Operations

MessageDefinition

Operations

MessageHeader

Operations

MolecularSequence

Operations

NamingSystem

Operations

NutritionOrder

Operations

Observation

Operations

ObservationDefinition

Operations

OperationDefinition

Operations

OperationOutcome

Operations

Organization

Operations

OrganizationAffiliation

Operations

Parameters

Operations

Patient

Operations

PaymentNotice

Operations

PaymentReconciliation

Operations

Person

Operations

PlanDefinition

Operations

Practitioner

Operations

PractitionerRole

Operations

Procedure

Operations

Get FHIR R4 Procedures

Request

Query
_countnumber

Number of items to return

_page_tokenstring

Page token for fetching the next set of items

curl -i -X GET \
  'https://docs.heydonto.com/_mock/apis/fhir/openapi/fhir/procedure?_count=0&_page_token=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json
resourceTypeanyrequired

This is a Bundle resource

Value"Bundle"
Example: "Bundle"
idstring(id)^[A-Za-z0-9\-\.]{1,64}$

Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.

metaobject(Meta)

The metadata about a resource. This is content in the resource that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

implicitRulesstring(uri)^\S*$

String of characters used to identify a name or a resource

_implicitRulesobject(Element)

Base definition for all elements in a resource.

languagestring(code)^[^\s]+(\s[^\s]+)*$

A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents

_languageobject(Element)

Base definition for all elements in a resource.

identifierobject(Identifier)

An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.

typeany

Indicates the purpose of this bundle - how it is intended to be used.

Enum"document""message""transaction""transaction-response""batch""batch-response""history""searchset""collection"
Example: "searchset"
_typeobject(Element)

Base definition for all elements in a resource.

timestampstring(instant)^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-...

An instant in time - known at least to the second

_timestampobject(Element)

Base definition for all elements in a resource.

totalnumber(unsignedInt)^[0]|([1-9][0-9]*)$

An integer with a value that is not negative (e.g. >= 0)

_totalobject(Element)

Base definition for all elements in a resource.

linkArray of objects(Bundle_Link)

A series of links that provide context to this bundle.

Example: [{"relation":"search","url":"https://api.heydonto.com/fhir/procedure/?_count=20"},{"relation":"next","url":"https://api.heydonto.com/fhir/procedure/?_count=20&_page_token=TOKEN"},{"relation":"first","url":"https://api.heydonto.com/fhir/procedure/?_count=20"},{"relation":"self","url":"https://api.heydonto.com/fhir/procedure/?_count=20"}]
entryArray of objects(Procedure)

An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).

Example: [{"resourceType":"Procedure","id":"example","text":{"status":"generated","div":"<div xmlns=\"http://www.w3.org/1999/xhtml\">Routine Appendectomy</div>"},"status":"completed","code":{"coding":[{"system":"http://snomed.info/sct","code":"80146002","display":"Appendectomy (Procedure)"}],"text":"Appendectomy"},"subject":{"reference":"Patient/example"},"performedDateTime":"2013-04-05","recorder":{"reference":"Practitioner/example","display":"Dr Cecil Surgeon"},"asserter":{"reference":"Practitioner/example","display":"Dr Cecil Surgeon"},"performer":[{"actor":{"reference":"Practitioner/example","display":"Dr Cecil Surgeon"}}],"reasonCode":[{"text":"Generalized abdominal pain 24 hours. Localized in RIF with rebound and guarding"}],"followUp":[{"text":"ROS 5 days - 2013-04-10"}],"note":[{"text":"Routine Appendectomy. Appendix was inflamed and in retro-caecal position"}]}]
signatureobject(Signature)

A signature along with supporting context. The signature may be a digital signature that is cryptographic in nature, or some other signature acceptable to the domain. This other signature may be as simple as a graphical image representing a hand-written signature, or a signature ceremony Different signature approaches have different utilities.

Response
application/json
{ "resourceType": "Bundle", "type": "searchset", "total": 100, "link": [ { … }, { … }, { … }, { … } ], "entry": [ { … } ] }

Create FHIR R4 Procedure

Request

Bodyapplication/jsonrequired
resourceTypeanyrequired

This is a Procedure resource

Value"Procedure"
Example: "Procedure"
idstring(id)^[A-Za-z0-9\-\.]{1,64}$

Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.

metaobject(Meta)

The metadata about a resource. This is content in the resource that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

implicitRulesstring(uri)^\S*$

String of characters used to identify a name or a resource

_implicitRulesobject(Element)

Base definition for all elements in a resource.

languagestring(code)^[^\s]+(\s[^\s]+)*$

A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents

_languageobject(Element)

Base definition for all elements in a resource.

textobject(Narrative)

A human-readable summary of the resource conveying the essential clinical and business information for the resource.

containedArray of #Account (object) or #ActivityDefinition (object) or #AdverseEvent (object) or #AllergyIntolerance (object) or #Appointment (object) or #AppointmentResponse (object) or #AuditEvent (object) or #Basic (object) or #Binary (object) or #BiologicallyDerivedProduct (object) or #BodyStructure (object) or #Bundle (object) or #CapabilityStatement (object) or #CarePlan (object) or #CareTeam (object) or #CatalogEntry (object) or #ChargeItem (object) or #ChargeItemDefinition (object) or #Claim (object) or #ClaimResponse (object) or #ClinicalImpression (object) or #CodeSystem (object) or #Communication (object) or #CommunicationRequest (object) or #CompartmentDefinition (object) or #Composition (object) or #ConceptMap (object) or #Condition (object) or #Consent (object) or #Contract (object) or #Coverage (object) or #CoverageEligibilityRequest (object) or #CoverageEligibilityResponse (object) or #DetectedIssue (object) or #Device (object) or #DeviceDefinition (object) or #DeviceMetric (object) or #DeviceRequest (object) or #DeviceUseStatement (object) or #DiagnosticReport (object) or #DocumentManifest (object) or #DocumentReference (object) or #EffectEvidenceSynthesis (object) or #Encounter (object) or #Endpoint (object) or #EnrollmentRequest (object) or #EnrollmentResponse (object) or #EpisodeOfCare (object) or #EventDefinition (object) or #Evidence (object) or #EvidenceVariable (object) or #ExampleScenario (object) or #ExplanationOfBenefit (object) or #FamilyMemberHistory (object) or #Flag (object) or #Goal (object) or #GraphDefinition (object) or #Group (object) or #GuidanceResponse (object) or #HealthcareService (object) or #ImagingStudy (object) or #Immunization (object) or #ImmunizationEvaluation (object) or #ImmunizationRecommendation (object) or #ImplementationGuide (object) or #InsurancePlan (object) or #Invoice (object) or #Library (object) or #Linkage (object) or #List (object) or #Location (object) or #Measure (object) or #MeasureReport (object) or #Media (object) or #Medication (object) or #MedicationAdministration (object) or #MedicationDispense (object) or #MedicationKnowledge (object) or #MedicationRequest (object) or #MedicationStatement (object) or #MedicinalProduct (object) or #MedicinalProductAuthorization (object) or #MedicinalProductContraindication (object) or #MedicinalProductIndication (object) or #MedicinalProductIngredient (object) or #MedicinalProductInteraction (object) or #MedicinalProductManufactured (object) or #MedicinalProductPackaged (object) or #MedicinalProductPharmaceutical (object) or #MedicinalProductUndesirableEffect (object) or #MessageDefinition (object) or #MessageHeader (object) or #MolecularSequence (object) or #NamingSystem (object) or #NutritionOrder (object) or #Observation (object) or #ObservationDefinition (object) or #OperationDefinition (object) or #OperationOutcome (object) or #Organization (object) or #OrganizationAffiliation (object) or #Parameters (object) or #Patient (object) or #PaymentNotice (object) or #PaymentReconciliation (object) or #Person (object) or #PlanDefinition (object) or #Practitioner (object) or #PractitionerRole (object) or #Procedure (object) or #Provenance (object) or #Questionnaire (object) or #QuestionnaireResponse (object) or #RelatedPerson (object) or #RequestGroup (object) or #ResearchDefinition (object) or #ResearchElementDefinition (object) or #ResearchStudy (object) or #ResearchSubject (object) or #RiskAssessment (object) or #RiskEvidenceSynthesis (object) or #Schedule (object) or #SearchParameter (object) or #ServiceRequest (object) or #Slot (object) or #Specimen (object) or #SpecimenDefinition (object) or #StructureDefinition (object) or #StructureMap (object) or #Subscription (object) or #Substance (object) or #SubstanceNucleicAcid (object) or #SubstancePolymer (object) or #SubstanceProtein (object) or #SubstanceReferenceInformation (object) or #SubstanceSourceMaterial (object) or #SubstanceSpecification (object) or #SupplyDelivery (object) or #SupplyRequest (object) or #Task (object) or #TerminologyCapabilities (object) or #TestReport (object) or #TestScript (object) or #ValueSet (object) or #VerificationResult (object) or #VisionPrescription (object)(ResourceList)

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

extensionArray of objects(Extension)

May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

modifierExtensionArray of objects(Extension)

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

identifierArray of objects(Identifier)

Business identifiers assigned to this procedure by the performer or other systems which remain constant as the resource is updated and is propagated from server to server.

instantiatesCanonicalArray of strings(canonical)

The URL pointing to a FHIR-defined protocol, guideline, order set or other definition that is adhered to in whole or in part by this Procedure.

instantiatesUriArray of strings(uri)

The URL pointing to an externally maintained protocol, guideline, order set or other definition that is adhered to in whole or in part by this Procedure.

_instantiatesUriArray of objects(Element)

Extensions for instantiatesUri

basedOnArray of objects(Reference)

A reference to a resource that contains details of the request for this procedure.

partOfArray of objects(Reference)

A larger event of which this particular procedure is a component or step.

statusstring(code)^[^\s]+(\s[^\s]+)*$

A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents

_statusobject(Element)

Base definition for all elements in a resource.

statusReasonobject(CodeableConcept)

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

categoryobject(CodeableConcept)

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

codeobject(CodeableConcept)

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

subjectobject(Reference)required

A reference from one resource to another.

subject.​idobject(#string)

An extension object type #string.

subject.​extensionArray of objects(#Extension)

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

subject.​referenceobject(#string)

An extension object type #string.

subject.​_referenceobject(#Element)

An extension object type #Element.

subject.​typeobject(#uri)

An extension object type #uri.

subject.​_typeobject(#Element)

An extension object type #Element.

subject.​identifierobject(#Identifier)

An extension object type #Identifier.

subject.​displayobject(#string)

An extension object type #string.

subject.​_displayobject(#Element)

An extension object type #Element.

encounterobject(Reference)

A reference from one resource to another.

performedDateTimestring^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-...

Estimated or actual date, date-time, period, or age when the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.

Example: "2013-04-05"
_performedDateTimeobject(Element)

Base definition for all elements in a resource.

performedPeriodobject(Period)

A time period defined by a start and end date and optionally time.

performedStringstring^[ \r\n\t\S]+$

Estimated or actual date, date-time, period, or age when the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.

_performedStringobject(Element)

Base definition for all elements in a resource.

performedAgeobject(Age)

A duration of time during which an organism (or a process) has existed.

performedRangeobject(Range)

A set of ordered Quantities defined by a low and high limit.

recorderobject(Reference)

A reference from one resource to another.

asserterobject(Reference)

A reference from one resource to another.

performerArray of objects(Procedure_Performer)

Limited to "real" people rather than equipment.

Example: [{"actor":{"reference":"Practitioner/example","display":"Dr Cecil Surgeon"}}]
locationobject(Reference)

A reference from one resource to another.

reasonCodeArray of objects(CodeableConcept)

The coded reason why the procedure was performed. This may be a coded entity of some type, or may simply be present as text.

Example: [{"text":"Generalized abdominal pain 24 hours. Localized in RIF with rebound and guarding"}]
reasonReferenceArray of objects(Reference)

The justification of why the procedure was performed.

bodySiteArray of objects(CodeableConcept)

Detailed and structured anatomical location information. Multiple locations are allowed - e.g. multiple punch biopsies of a lesion.

outcomeobject(CodeableConcept)

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

reportArray of objects(Reference)

This could be a histology result, pathology report, surgical report, etc.

complicationArray of objects(CodeableConcept)

Any complications that occurred during the procedure, or in the immediate post-performance period. These are generally tracked separately from the notes, which will typically describe the procedure itself rather than any 'post procedure' issues.

complicationDetailArray of objects(Reference)

Any complications that occurred during the procedure, or in the immediate post-performance period.

followUpArray of objects(CodeableConcept)

If the procedure required specific follow up - e.g. removal of sutures. The follow up may be represented as a simple note or could potentially be more complex, in which case the CarePlan resource can be used.

Example: [{"text":"ROS 5 days - 2013-04-10"}]
noteArray of objects(Annotation)

Any other notes and comments about the procedure.

Example: [{"text":"Routine Appendectomy. Appendix was inflamed and in retro-caecal position"}]
focalDeviceArray of objects(Procedure_FocalDevice)

A device that is implanted, removed or otherwise manipulated (calibration, battery replacement, fitting a prosthesis, attaching a wound-vac, etc.) as a focal portion of the Procedure.

usedReferenceArray of objects(Reference)

Identifies medications, devices and any other substance used as part of the procedure.

usedCodeArray of objects(CodeableConcept)

Identifies coded items that were used as part of the procedure.

curl -i -X POST \
  https://docs.heydonto.com/_mock/apis/fhir/openapi/fhir/procedure \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "resourceType": "Procedure",
    "id": "example",
    "text": {
      "status": "generated",
      "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Routine Appendectomy</div>"
    },
    "status": "completed",
    "code": {
      "coding": [
        {
          "system": "http://snomed.info/sct",
          "code": "80146002",
          "display": "Appendectomy (Procedure)"
        }
      ],
      "text": "Appendectomy"
    },
    "subject": {
      "reference": "Patient/example"
    },
    "performedDateTime": "2013-04-05",
    "recorder": {
      "reference": "Practitioner/example",
      "display": "Dr Cecil Surgeon"
    },
    "asserter": {
      "reference": "Practitioner/example",
      "display": "Dr Cecil Surgeon"
    },
    "performer": [
      {
        "actor": {
          "reference": "Practitioner/example",
          "display": "Dr Cecil Surgeon"
        }
      }
    ],
    "reasonCode": [
      {
        "text": "Generalized abdominal pain 24 hours. Localized in RIF with rebound and guarding"
      }
    ],
    "followUp": [
      {
        "text": "ROS 5 days  - 2013-04-10"
      }
    ],
    "note": [
      {
        "text": "Routine Appendectomy. Appendix was inflamed and in retro-caecal position"
      }
    ]
  }'

Responses

Bodyapplication/json
resourceTypeanyrequired

This is a Procedure resource

Value"Procedure"
Example: "Procedure"
idstring(id)^[A-Za-z0-9\-\.]{1,64}$

Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.

metaobject(Meta)

The metadata about a resource. This is content in the resource that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

implicitRulesstring(uri)^\S*$

String of characters used to identify a name or a resource

_implicitRulesobject(Element)

Base definition for all elements in a resource.

languagestring(code)^[^\s]+(\s[^\s]+)*$

A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents

_languageobject(Element)

Base definition for all elements in a resource.

textobject(Narrative)

A human-readable summary of the resource conveying the essential clinical and business information for the resource.

containedArray of #Account (object) or #ActivityDefinition (object) or #AdverseEvent (object) or #AllergyIntolerance (object) or #Appointment (object) or #AppointmentResponse (object) or #AuditEvent (object) or #Basic (object) or #Binary (object) or #BiologicallyDerivedProduct (object) or #BodyStructure (object) or #Bundle (object) or #CapabilityStatement (object) or #CarePlan (object) or #CareTeam (object) or #CatalogEntry (object) or #ChargeItem (object) or #ChargeItemDefinition (object) or #Claim (object) or #ClaimResponse (object) or #ClinicalImpression (object) or #CodeSystem (object) or #Communication (object) or #CommunicationRequest (object) or #CompartmentDefinition (object) or #Composition (object) or #ConceptMap (object) or #Condition (object) or #Consent (object) or #Contract (object) or #Coverage (object) or #CoverageEligibilityRequest (object) or #CoverageEligibilityResponse (object) or #DetectedIssue (object) or #Device (object) or #DeviceDefinition (object) or #DeviceMetric (object) or #DeviceRequest (object) or #DeviceUseStatement (object) or #DiagnosticReport (object) or #DocumentManifest (object) or #DocumentReference (object) or #EffectEvidenceSynthesis (object) or #Encounter (object) or #Endpoint (object) or #EnrollmentRequest (object) or #EnrollmentResponse (object) or #EpisodeOfCare (object) or #EventDefinition (object) or #Evidence (object) or #EvidenceVariable (object) or #ExampleScenario (object) or #ExplanationOfBenefit (object) or #FamilyMemberHistory (object) or #Flag (object) or #Goal (object) or #GraphDefinition (object) or #Group (object) or #GuidanceResponse (object) or #HealthcareService (object) or #ImagingStudy (object) or #Immunization (object) or #ImmunizationEvaluation (object) or #ImmunizationRecommendation (object) or #ImplementationGuide (object) or #InsurancePlan (object) or #Invoice (object) or #Library (object) or #Linkage (object) or #List (object) or #Location (object) or #Measure (object) or #MeasureReport (object) or #Media (object) or #Medication (object) or #MedicationAdministration (object) or #MedicationDispense (object) or #MedicationKnowledge (object) or #MedicationRequest (object) or #MedicationStatement (object) or #MedicinalProduct (object) or #MedicinalProductAuthorization (object) or #MedicinalProductContraindication (object) or #MedicinalProductIndication (object) or #MedicinalProductIngredient (object) or #MedicinalProductInteraction (object) or #MedicinalProductManufactured (object) or #MedicinalProductPackaged (object) or #MedicinalProductPharmaceutical (object) or #MedicinalProductUndesirableEffect (object) or #MessageDefinition (object) or #MessageHeader (object) or #MolecularSequence (object) or #NamingSystem (object) or #NutritionOrder (object) or #Observation (object) or #ObservationDefinition (object) or #OperationDefinition (object) or #OperationOutcome (object) or #Organization (object) or #OrganizationAffiliation (object) or #Parameters (object) or #Patient (object) or #PaymentNotice (object) or #PaymentReconciliation (object) or #Person (object) or #PlanDefinition (object) or #Practitioner (object) or #PractitionerRole (object) or #Procedure (object) or #Provenance (object) or #Questionnaire (object) or #QuestionnaireResponse (object) or #RelatedPerson (object) or #RequestGroup (object) or #ResearchDefinition (object) or #ResearchElementDefinition (object) or #ResearchStudy (object) or #ResearchSubject (object) or #RiskAssessment (object) or #RiskEvidenceSynthesis (object) or #Schedule (object) or #SearchParameter (object) or #ServiceRequest (object) or #Slot (object) or #Specimen (object) or #SpecimenDefinition (object) or #StructureDefinition (object) or #StructureMap (object) or #Subscription (object) or #Substance (object) or #SubstanceNucleicAcid (object) or #SubstancePolymer (object) or #SubstanceProtein (object) or #SubstanceReferenceInformation (object) or #SubstanceSourceMaterial (object) or #SubstanceSpecification (object) or #SupplyDelivery (object) or #SupplyRequest (object) or #Task (object) or #TerminologyCapabilities (object) or #TestReport (object) or #TestScript (object) or #ValueSet (object) or #VerificationResult (object) or #VisionPrescription (object)(ResourceList)

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

extensionArray of objects(Extension)

May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

modifierExtensionArray of objects(Extension)

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

identifierArray of objects(Identifier)

Business identifiers assigned to this procedure by the performer or other systems which remain constant as the resource is updated and is propagated from server to server.

instantiatesCanonicalArray of strings(canonical)

The URL pointing to a FHIR-defined protocol, guideline, order set or other definition that is adhered to in whole or in part by this Procedure.

instantiatesUriArray of strings(uri)

The URL pointing to an externally maintained protocol, guideline, order set or other definition that is adhered to in whole or in part by this Procedure.

_instantiatesUriArray of objects(Element)

Extensions for instantiatesUri

basedOnArray of objects(Reference)

A reference to a resource that contains details of the request for this procedure.

partOfArray of objects(Reference)

A larger event of which this particular procedure is a component or step.

statusstring(code)^[^\s]+(\s[^\s]+)*$

A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents

_statusobject(Element)

Base definition for all elements in a resource.

statusReasonobject(CodeableConcept)

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

categoryobject(CodeableConcept)

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

codeobject(CodeableConcept)

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

subjectobject(Reference)required

A reference from one resource to another.

subject.​idobject(#string)

An extension object type #string.

subject.​extensionArray of objects(#Extension)

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

subject.​referenceobject(#string)

An extension object type #string.

subject.​_referenceobject(#Element)

An extension object type #Element.

subject.​typeobject(#uri)

An extension object type #uri.

subject.​_typeobject(#Element)

An extension object type #Element.

subject.​identifierobject(#Identifier)

An extension object type #Identifier.

subject.​displayobject(#string)

An extension object type #string.

subject.​_displayobject(#Element)

An extension object type #Element.

encounterobject(Reference)

A reference from one resource to another.

performedDateTimestring^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-...

Estimated or actual date, date-time, period, or age when the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.

Example: "2013-04-05"
_performedDateTimeobject(Element)

Base definition for all elements in a resource.

performedPeriodobject(Period)

A time period defined by a start and end date and optionally time.

performedStringstring^[ \r\n\t\S]+$

Estimated or actual date, date-time, period, or age when the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.

_performedStringobject(Element)

Base definition for all elements in a resource.

performedAgeobject(Age)

A duration of time during which an organism (or a process) has existed.

performedRangeobject(Range)

A set of ordered Quantities defined by a low and high limit.

recorderobject(Reference)

A reference from one resource to another.

asserterobject(Reference)

A reference from one resource to another.

performerArray of objects(Procedure_Performer)

Limited to "real" people rather than equipment.

Example: [{"actor":{"reference":"Practitioner/example","display":"Dr Cecil Surgeon"}}]
locationobject(Reference)

A reference from one resource to another.

reasonCodeArray of objects(CodeableConcept)

The coded reason why the procedure was performed. This may be a coded entity of some type, or may simply be present as text.

Example: [{"text":"Generalized abdominal pain 24 hours. Localized in RIF with rebound and guarding"}]
reasonReferenceArray of objects(Reference)

The justification of why the procedure was performed.

bodySiteArray of objects(CodeableConcept)

Detailed and structured anatomical location information. Multiple locations are allowed - e.g. multiple punch biopsies of a lesion.

outcomeobject(CodeableConcept)

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

reportArray of objects(Reference)

This could be a histology result, pathology report, surgical report, etc.

complicationArray of objects(CodeableConcept)

Any complications that occurred during the procedure, or in the immediate post-performance period. These are generally tracked separately from the notes, which will typically describe the procedure itself rather than any 'post procedure' issues.

complicationDetailArray of objects(Reference)

Any complications that occurred during the procedure, or in the immediate post-performance period.

followUpArray of objects(CodeableConcept)

If the procedure required specific follow up - e.g. removal of sutures. The follow up may be represented as a simple note or could potentially be more complex, in which case the CarePlan resource can be used.

Example: [{"text":"ROS 5 days - 2013-04-10"}]
noteArray of objects(Annotation)

Any other notes and comments about the procedure.

Example: [{"text":"Routine Appendectomy. Appendix was inflamed and in retro-caecal position"}]
focalDeviceArray of objects(Procedure_FocalDevice)

A device that is implanted, removed or otherwise manipulated (calibration, battery replacement, fitting a prosthesis, attaching a wound-vac, etc.) as a focal portion of the Procedure.

usedReferenceArray of objects(Reference)

Identifies medications, devices and any other substance used as part of the procedure.

usedCodeArray of objects(CodeableConcept)

Identifies coded items that were used as part of the procedure.

Response
application/json
{ "resourceType": "Procedure", "id": "example", "text": { "status": "generated", "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Routine Appendectomy</div>" }, "status": "completed", "code": { "coding": [ … ], "text": "Appendectomy" }, "subject": { "reference": "Patient/example" }, "performedDateTime": "2013-04-05", "recorder": { "reference": "Practitioner/example", "display": "Dr Cecil Surgeon" }, "asserter": { "reference": "Practitioner/example", "display": "Dr Cecil Surgeon" }, "performer": [ { … } ], "reasonCode": [ { … } ], "followUp": [ { … } ], "note": [ { … } ] }

Get FHIR R4 Procedure by ID

Request

Path
idstringrequired

ID of the Procedure

curl -i -X GET \
  'https://docs.heydonto.com/_mock/apis/fhir/openapi/fhir/procedure/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json
resourceTypeanyrequired

This is a Procedure resource

Value"Procedure"
Example: "Procedure"
idstring(id)^[A-Za-z0-9\-\.]{1,64}$

Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.

metaobject(Meta)

The metadata about a resource. This is content in the resource that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

implicitRulesstring(uri)^\S*$

String of characters used to identify a name or a resource

_implicitRulesobject(Element)

Base definition for all elements in a resource.

languagestring(code)^[^\s]+(\s[^\s]+)*$

A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents

_languageobject(Element)

Base definition for all elements in a resource.

textobject(Narrative)

A human-readable summary of the resource conveying the essential clinical and business information for the resource.

containedArray of #Account (object) or #ActivityDefinition (object) or #AdverseEvent (object) or #AllergyIntolerance (object) or #Appointment (object) or #AppointmentResponse (object) or #AuditEvent (object) or #Basic (object) or #Binary (object) or #BiologicallyDerivedProduct (object) or #BodyStructure (object) or #Bundle (object) or #CapabilityStatement (object) or #CarePlan (object) or #CareTeam (object) or #CatalogEntry (object) or #ChargeItem (object) or #ChargeItemDefinition (object) or #Claim (object) or #ClaimResponse (object) or #ClinicalImpression (object) or #CodeSystem (object) or #Communication (object) or #CommunicationRequest (object) or #CompartmentDefinition (object) or #Composition (object) or #ConceptMap (object) or #Condition (object) or #Consent (object) or #Contract (object) or #Coverage (object) or #CoverageEligibilityRequest (object) or #CoverageEligibilityResponse (object) or #DetectedIssue (object) or #Device (object) or #DeviceDefinition (object) or #DeviceMetric (object) or #DeviceRequest (object) or #DeviceUseStatement (object) or #DiagnosticReport (object) or #DocumentManifest (object) or #DocumentReference (object) or #EffectEvidenceSynthesis (object) or #Encounter (object) or #Endpoint (object) or #EnrollmentRequest (object) or #EnrollmentResponse (object) or #EpisodeOfCare (object) or #EventDefinition (object) or #Evidence (object) or #EvidenceVariable (object) or #ExampleScenario (object) or #ExplanationOfBenefit (object) or #FamilyMemberHistory (object) or #Flag (object) or #Goal (object) or #GraphDefinition (object) or #Group (object) or #GuidanceResponse (object) or #HealthcareService (object) or #ImagingStudy (object) or #Immunization (object) or #ImmunizationEvaluation (object) or #ImmunizationRecommendation (object) or #ImplementationGuide (object) or #InsurancePlan (object) or #Invoice (object) or #Library (object) or #Linkage (object) or #List (object) or #Location (object) or #Measure (object) or #MeasureReport (object) or #Media (object) or #Medication (object) or #MedicationAdministration (object) or #MedicationDispense (object) or #MedicationKnowledge (object) or #MedicationRequest (object) or #MedicationStatement (object) or #MedicinalProduct (object) or #MedicinalProductAuthorization (object) or #MedicinalProductContraindication (object) or #MedicinalProductIndication (object) or #MedicinalProductIngredient (object) or #MedicinalProductInteraction (object) or #MedicinalProductManufactured (object) or #MedicinalProductPackaged (object) or #MedicinalProductPharmaceutical (object) or #MedicinalProductUndesirableEffect (object) or #MessageDefinition (object) or #MessageHeader (object) or #MolecularSequence (object) or #NamingSystem (object) or #NutritionOrder (object) or #Observation (object) or #ObservationDefinition (object) or #OperationDefinition (object) or #OperationOutcome (object) or #Organization (object) or #OrganizationAffiliation (object) or #Parameters (object) or #Patient (object) or #PaymentNotice (object) or #PaymentReconciliation (object) or #Person (object) or #PlanDefinition (object) or #Practitioner (object) or #PractitionerRole (object) or #Procedure (object) or #Provenance (object) or #Questionnaire (object) or #QuestionnaireResponse (object) or #RelatedPerson (object) or #RequestGroup (object) or #ResearchDefinition (object) or #ResearchElementDefinition (object) or #ResearchStudy (object) or #ResearchSubject (object) or #RiskAssessment (object) or #RiskEvidenceSynthesis (object) or #Schedule (object) or #SearchParameter (object) or #ServiceRequest (object) or #Slot (object) or #Specimen (object) or #SpecimenDefinition (object) or #StructureDefinition (object) or #StructureMap (object) or #Subscription (object) or #Substance (object) or #SubstanceNucleicAcid (object) or #SubstancePolymer (object) or #SubstanceProtein (object) or #SubstanceReferenceInformation (object) or #SubstanceSourceMaterial (object) or #SubstanceSpecification (object) or #SupplyDelivery (object) or #SupplyRequest (object) or #Task (object) or #TerminologyCapabilities (object) or #TestReport (object) or #TestScript (object) or #ValueSet (object) or #VerificationResult (object) or #VisionPrescription (object)(ResourceList)

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

extensionArray of objects(Extension)

May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

modifierExtensionArray of objects(Extension)

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

identifierArray of objects(Identifier)

Business identifiers assigned to this procedure by the performer or other systems which remain constant as the resource is updated and is propagated from server to server.

instantiatesCanonicalArray of strings(canonical)

The URL pointing to a FHIR-defined protocol, guideline, order set or other definition that is adhered to in whole or in part by this Procedure.

instantiatesUriArray of strings(uri)

The URL pointing to an externally maintained protocol, guideline, order set or other definition that is adhered to in whole or in part by this Procedure.

_instantiatesUriArray of objects(Element)

Extensions for instantiatesUri

basedOnArray of objects(Reference)

A reference to a resource that contains details of the request for this procedure.

partOfArray of objects(Reference)

A larger event of which this particular procedure is a component or step.

statusstring(code)^[^\s]+(\s[^\s]+)*$

A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents

_statusobject(Element)

Base definition for all elements in a resource.

statusReasonobject(CodeableConcept)

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

categoryobject(CodeableConcept)

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

codeobject(CodeableConcept)

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

subjectobject(Reference)required

A reference from one resource to another.

subject.​idobject(#string)

An extension object type #string.

subject.​extensionArray of objects(#Extension)

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

subject.​referenceobject(#string)

An extension object type #string.

subject.​_referenceobject(#Element)

An extension object type #Element.

subject.​typeobject(#uri)

An extension object type #uri.

subject.​_typeobject(#Element)

An extension object type #Element.

subject.​identifierobject(#Identifier)

An extension object type #Identifier.

subject.​displayobject(#string)

An extension object type #string.

subject.​_displayobject(#Element)

An extension object type #Element.

encounterobject(Reference)

A reference from one resource to another.

performedDateTimestring^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-...

Estimated or actual date, date-time, period, or age when the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.

Example: "2013-04-05"
_performedDateTimeobject(Element)

Base definition for all elements in a resource.

performedPeriodobject(Period)

A time period defined by a start and end date and optionally time.

performedStringstring^[ \r\n\t\S]+$

Estimated or actual date, date-time, period, or age when the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.

_performedStringobject(Element)

Base definition for all elements in a resource.

performedAgeobject(Age)

A duration of time during which an organism (or a process) has existed.

performedRangeobject(Range)

A set of ordered Quantities defined by a low and high limit.

recorderobject(Reference)

A reference from one resource to another.

asserterobject(Reference)

A reference from one resource to another.

performerArray of objects(Procedure_Performer)

Limited to "real" people rather than equipment.

Example: [{"actor":{"reference":"Practitioner/example","display":"Dr Cecil Surgeon"}}]
locationobject(Reference)

A reference from one resource to another.

reasonCodeArray of objects(CodeableConcept)

The coded reason why the procedure was performed. This may be a coded entity of some type, or may simply be present as text.

Example: [{"text":"Generalized abdominal pain 24 hours. Localized in RIF with rebound and guarding"}]
reasonReferenceArray of objects(Reference)

The justification of why the procedure was performed.

bodySiteArray of objects(CodeableConcept)

Detailed and structured anatomical location information. Multiple locations are allowed - e.g. multiple punch biopsies of a lesion.

outcomeobject(CodeableConcept)

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

reportArray of objects(Reference)

This could be a histology result, pathology report, surgical report, etc.

complicationArray of objects(CodeableConcept)

Any complications that occurred during the procedure, or in the immediate post-performance period. These are generally tracked separately from the notes, which will typically describe the procedure itself rather than any 'post procedure' issues.

complicationDetailArray of objects(Reference)

Any complications that occurred during the procedure, or in the immediate post-performance period.

followUpArray of objects(CodeableConcept)

If the procedure required specific follow up - e.g. removal of sutures. The follow up may be represented as a simple note or could potentially be more complex, in which case the CarePlan resource can be used.

Example: [{"text":"ROS 5 days - 2013-04-10"}]
noteArray of objects(Annotation)

Any other notes and comments about the procedure.

Example: [{"text":"Routine Appendectomy. Appendix was inflamed and in retro-caecal position"}]
focalDeviceArray of objects(Procedure_FocalDevice)

A device that is implanted, removed or otherwise manipulated (calibration, battery replacement, fitting a prosthesis, attaching a wound-vac, etc.) as a focal portion of the Procedure.

usedReferenceArray of objects(Reference)

Identifies medications, devices and any other substance used as part of the procedure.

usedCodeArray of objects(CodeableConcept)

Identifies coded items that were used as part of the procedure.

Response
application/json
{ "resourceType": "Procedure", "id": "example", "text": { "status": "generated", "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Routine Appendectomy</div>" }, "status": "completed", "code": { "coding": [ … ], "text": "Appendectomy" }, "subject": { "reference": "Patient/example" }, "performedDateTime": "2013-04-05", "recorder": { "reference": "Practitioner/example", "display": "Dr Cecil Surgeon" }, "asserter": { "reference": "Practitioner/example", "display": "Dr Cecil Surgeon" }, "performer": [ { … } ], "reasonCode": [ { … } ], "followUp": [ { … } ], "note": [ { … } ] }

Update FHIR R4 Procedure

Request

Path
idstringrequired

ID of the Procedure to update

Bodyapplication/jsonrequired
resourceTypeanyrequired

This is a Procedure resource

Value"Procedure"
Example: "Procedure"
idstring(id)^[A-Za-z0-9\-\.]{1,64}$

Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.

metaobject(Meta)

The metadata about a resource. This is content in the resource that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

implicitRulesstring(uri)^\S*$

String of characters used to identify a name or a resource

_implicitRulesobject(Element)

Base definition for all elements in a resource.

languagestring(code)^[^\s]+(\s[^\s]+)*$

A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents

_languageobject(Element)

Base definition for all elements in a resource.

textobject(Narrative)

A human-readable summary of the resource conveying the essential clinical and business information for the resource.

containedArray of #Account (object) or #ActivityDefinition (object) or #AdverseEvent (object) or #AllergyIntolerance (object) or #Appointment (object) or #AppointmentResponse (object) or #AuditEvent (object) or #Basic (object) or #Binary (object) or #BiologicallyDerivedProduct (object) or #BodyStructure (object) or #Bundle (object) or #CapabilityStatement (object) or #CarePlan (object) or #CareTeam (object) or #CatalogEntry (object) or #ChargeItem (object) or #ChargeItemDefinition (object) or #Claim (object) or #ClaimResponse (object) or #ClinicalImpression (object) or #CodeSystem (object) or #Communication (object) or #CommunicationRequest (object) or #CompartmentDefinition (object) or #Composition (object) or #ConceptMap (object) or #Condition (object) or #Consent (object) or #Contract (object) or #Coverage (object) or #CoverageEligibilityRequest (object) or #CoverageEligibilityResponse (object) or #DetectedIssue (object) or #Device (object) or #DeviceDefinition (object) or #DeviceMetric (object) or #DeviceRequest (object) or #DeviceUseStatement (object) or #DiagnosticReport (object) or #DocumentManifest (object) or #DocumentReference (object) or #EffectEvidenceSynthesis (object) or #Encounter (object) or #Endpoint (object) or #EnrollmentRequest (object) or #EnrollmentResponse (object) or #EpisodeOfCare (object) or #EventDefinition (object) or #Evidence (object) or #EvidenceVariable (object) or #ExampleScenario (object) or #ExplanationOfBenefit (object) or #FamilyMemberHistory (object) or #Flag (object) or #Goal (object) or #GraphDefinition (object) or #Group (object) or #GuidanceResponse (object) or #HealthcareService (object) or #ImagingStudy (object) or #Immunization (object) or #ImmunizationEvaluation (object) or #ImmunizationRecommendation (object) or #ImplementationGuide (object) or #InsurancePlan (object) or #Invoice (object) or #Library (object) or #Linkage (object) or #List (object) or #Location (object) or #Measure (object) or #MeasureReport (object) or #Media (object) or #Medication (object) or #MedicationAdministration (object) or #MedicationDispense (object) or #MedicationKnowledge (object) or #MedicationRequest (object) or #MedicationStatement (object) or #MedicinalProduct (object) or #MedicinalProductAuthorization (object) or #MedicinalProductContraindication (object) or #MedicinalProductIndication (object) or #MedicinalProductIngredient (object) or #MedicinalProductInteraction (object) or #MedicinalProductManufactured (object) or #MedicinalProductPackaged (object) or #MedicinalProductPharmaceutical (object) or #MedicinalProductUndesirableEffect (object) or #MessageDefinition (object) or #MessageHeader (object) or #MolecularSequence (object) or #NamingSystem (object) or #NutritionOrder (object) or #Observation (object) or #ObservationDefinition (object) or #OperationDefinition (object) or #OperationOutcome (object) or #Organization (object) or #OrganizationAffiliation (object) or #Parameters (object) or #Patient (object) or #PaymentNotice (object) or #PaymentReconciliation (object) or #Person (object) or #PlanDefinition (object) or #Practitioner (object) or #PractitionerRole (object) or #Procedure (object) or #Provenance (object) or #Questionnaire (object) or #QuestionnaireResponse (object) or #RelatedPerson (object) or #RequestGroup (object) or #ResearchDefinition (object) or #ResearchElementDefinition (object) or #ResearchStudy (object) or #ResearchSubject (object) or #RiskAssessment (object) or #RiskEvidenceSynthesis (object) or #Schedule (object) or #SearchParameter (object) or #ServiceRequest (object) or #Slot (object) or #Specimen (object) or #SpecimenDefinition (object) or #StructureDefinition (object) or #StructureMap (object) or #Subscription (object) or #Substance (object) or #SubstanceNucleicAcid (object) or #SubstancePolymer (object) or #SubstanceProtein (object) or #SubstanceReferenceInformation (object) or #SubstanceSourceMaterial (object) or #SubstanceSpecification (object) or #SupplyDelivery (object) or #SupplyRequest (object) or #Task (object) or #TerminologyCapabilities (object) or #TestReport (object) or #TestScript (object) or #ValueSet (object) or #VerificationResult (object) or #VisionPrescription (object)(ResourceList)

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

extensionArray of objects(Extension)

May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

modifierExtensionArray of objects(Extension)

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

identifierArray of objects(Identifier)

Business identifiers assigned to this procedure by the performer or other systems which remain constant as the resource is updated and is propagated from server to server.

instantiatesCanonicalArray of strings(canonical)

The URL pointing to a FHIR-defined protocol, guideline, order set or other definition that is adhered to in whole or in part by this Procedure.

instantiatesUriArray of strings(uri)

The URL pointing to an externally maintained protocol, guideline, order set or other definition that is adhered to in whole or in part by this Procedure.

_instantiatesUriArray of objects(Element)

Extensions for instantiatesUri

basedOnArray of objects(Reference)

A reference to a resource that contains details of the request for this procedure.

partOfArray of objects(Reference)

A larger event of which this particular procedure is a component or step.

statusstring(code)^[^\s]+(\s[^\s]+)*$

A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents

_statusobject(Element)

Base definition for all elements in a resource.

statusReasonobject(CodeableConcept)

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

categoryobject(CodeableConcept)

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

codeobject(CodeableConcept)

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

subjectobject(Reference)required

A reference from one resource to another.

subject.​idobject(#string)

An extension object type #string.

subject.​extensionArray of objects(#Extension)

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

subject.​referenceobject(#string)

An extension object type #string.

subject.​_referenceobject(#Element)

An extension object type #Element.

subject.​typeobject(#uri)

An extension object type #uri.

subject.​_typeobject(#Element)

An extension object type #Element.

subject.​identifierobject(#Identifier)

An extension object type #Identifier.

subject.​displayobject(#string)

An extension object type #string.

subject.​_displayobject(#Element)

An extension object type #Element.

encounterobject(Reference)

A reference from one resource to another.

performedDateTimestring^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-...

Estimated or actual date, date-time, period, or age when the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.

Example: "2013-04-05"
_performedDateTimeobject(Element)

Base definition for all elements in a resource.

performedPeriodobject(Period)

A time period defined by a start and end date and optionally time.

performedStringstring^[ \r\n\t\S]+$

Estimated or actual date, date-time, period, or age when the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.

_performedStringobject(Element)

Base definition for all elements in a resource.

performedAgeobject(Age)

A duration of time during which an organism (or a process) has existed.

performedRangeobject(Range)

A set of ordered Quantities defined by a low and high limit.

recorderobject(Reference)

A reference from one resource to another.

asserterobject(Reference)

A reference from one resource to another.

performerArray of objects(Procedure_Performer)

Limited to "real" people rather than equipment.

Example: [{"actor":{"reference":"Practitioner/example","display":"Dr Cecil Surgeon"}}]
locationobject(Reference)

A reference from one resource to another.

reasonCodeArray of objects(CodeableConcept)

The coded reason why the procedure was performed. This may be a coded entity of some type, or may simply be present as text.

Example: [{"text":"Generalized abdominal pain 24 hours. Localized in RIF with rebound and guarding"}]
reasonReferenceArray of objects(Reference)

The justification of why the procedure was performed.

bodySiteArray of objects(CodeableConcept)

Detailed and structured anatomical location information. Multiple locations are allowed - e.g. multiple punch biopsies of a lesion.

outcomeobject(CodeableConcept)

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

reportArray of objects(Reference)

This could be a histology result, pathology report, surgical report, etc.

complicationArray of objects(CodeableConcept)

Any complications that occurred during the procedure, or in the immediate post-performance period. These are generally tracked separately from the notes, which will typically describe the procedure itself rather than any 'post procedure' issues.

complicationDetailArray of objects(Reference)

Any complications that occurred during the procedure, or in the immediate post-performance period.

followUpArray of objects(CodeableConcept)

If the procedure required specific follow up - e.g. removal of sutures. The follow up may be represented as a simple note or could potentially be more complex, in which case the CarePlan resource can be used.

Example: [{"text":"ROS 5 days - 2013-04-10"}]
noteArray of objects(Annotation)

Any other notes and comments about the procedure.

Example: [{"text":"Routine Appendectomy. Appendix was inflamed and in retro-caecal position"}]
focalDeviceArray of objects(Procedure_FocalDevice)

A device that is implanted, removed or otherwise manipulated (calibration, battery replacement, fitting a prosthesis, attaching a wound-vac, etc.) as a focal portion of the Procedure.

usedReferenceArray of objects(Reference)

Identifies medications, devices and any other substance used as part of the procedure.

usedCodeArray of objects(CodeableConcept)

Identifies coded items that were used as part of the procedure.

curl -i -X PUT \
  'https://docs.heydonto.com/_mock/apis/fhir/openapi/fhir/procedure/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "resourceType": "Procedure",
    "id": "example",
    "text": {
      "status": "generated",
      "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Routine Appendectomy</div>"
    },
    "status": "completed",
    "code": {
      "coding": [
        {
          "system": "http://snomed.info/sct",
          "code": "80146002",
          "display": "Appendectomy (Procedure)"
        }
      ],
      "text": "Appendectomy"
    },
    "subject": {
      "reference": "Patient/example"
    },
    "performedDateTime": "2013-04-05",
    "recorder": {
      "reference": "Practitioner/example",
      "display": "Dr Cecil Surgeon"
    },
    "asserter": {
      "reference": "Practitioner/example",
      "display": "Dr Cecil Surgeon"
    },
    "performer": [
      {
        "actor": {
          "reference": "Practitioner/example",
          "display": "Dr Cecil Surgeon"
        }
      }
    ],
    "reasonCode": [
      {
        "text": "Generalized abdominal pain 24 hours. Localized in RIF with rebound and guarding"
      }
    ],
    "followUp": [
      {
        "text": "ROS 5 days  - 2013-04-10"
      }
    ],
    "note": [
      {
        "text": "Routine Appendectomy. Appendix was inflamed and in retro-caecal position"
      }
    ]
  }'

Responses

Bodyapplication/json
resourceTypeanyrequired

This is a Procedure resource

Value"Procedure"
Example: "Procedure"
idstring(id)^[A-Za-z0-9\-\.]{1,64}$

Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.

metaobject(Meta)

The metadata about a resource. This is content in the resource that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

implicitRulesstring(uri)^\S*$

String of characters used to identify a name or a resource

_implicitRulesobject(Element)

Base definition for all elements in a resource.

languagestring(code)^[^\s]+(\s[^\s]+)*$

A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents

_languageobject(Element)

Base definition for all elements in a resource.

textobject(Narrative)

A human-readable summary of the resource conveying the essential clinical and business information for the resource.

containedArray of #Account (object) or #ActivityDefinition (object) or #AdverseEvent (object) or #AllergyIntolerance (object) or #Appointment (object) or #AppointmentResponse (object) or #AuditEvent (object) or #Basic (object) or #Binary (object) or #BiologicallyDerivedProduct (object) or #BodyStructure (object) or #Bundle (object) or #CapabilityStatement (object) or #CarePlan (object) or #CareTeam (object) or #CatalogEntry (object) or #ChargeItem (object) or #ChargeItemDefinition (object) or #Claim (object) or #ClaimResponse (object) or #ClinicalImpression (object) or #CodeSystem (object) or #Communication (object) or #CommunicationRequest (object) or #CompartmentDefinition (object) or #Composition (object) or #ConceptMap (object) or #Condition (object) or #Consent (object) or #Contract (object) or #Coverage (object) or #CoverageEligibilityRequest (object) or #CoverageEligibilityResponse (object) or #DetectedIssue (object) or #Device (object) or #DeviceDefinition (object) or #DeviceMetric (object) or #DeviceRequest (object) or #DeviceUseStatement (object) or #DiagnosticReport (object) or #DocumentManifest (object) or #DocumentReference (object) or #EffectEvidenceSynthesis (object) or #Encounter (object) or #Endpoint (object) or #EnrollmentRequest (object) or #EnrollmentResponse (object) or #EpisodeOfCare (object) or #EventDefinition (object) or #Evidence (object) or #EvidenceVariable (object) or #ExampleScenario (object) or #ExplanationOfBenefit (object) or #FamilyMemberHistory (object) or #Flag (object) or #Goal (object) or #GraphDefinition (object) or #Group (object) or #GuidanceResponse (object) or #HealthcareService (object) or #ImagingStudy (object) or #Immunization (object) or #ImmunizationEvaluation (object) or #ImmunizationRecommendation (object) or #ImplementationGuide (object) or #InsurancePlan (object) or #Invoice (object) or #Library (object) or #Linkage (object) or #List (object) or #Location (object) or #Measure (object) or #MeasureReport (object) or #Media (object) or #Medication (object) or #MedicationAdministration (object) or #MedicationDispense (object) or #MedicationKnowledge (object) or #MedicationRequest (object) or #MedicationStatement (object) or #MedicinalProduct (object) or #MedicinalProductAuthorization (object) or #MedicinalProductContraindication (object) or #MedicinalProductIndication (object) or #MedicinalProductIngredient (object) or #MedicinalProductInteraction (object) or #MedicinalProductManufactured (object) or #MedicinalProductPackaged (object) or #MedicinalProductPharmaceutical (object) or #MedicinalProductUndesirableEffect (object) or #MessageDefinition (object) or #MessageHeader (object) or #MolecularSequence (object) or #NamingSystem (object) or #NutritionOrder (object) or #Observation (object) or #ObservationDefinition (object) or #OperationDefinition (object) or #OperationOutcome (object) or #Organization (object) or #OrganizationAffiliation (object) or #Parameters (object) or #Patient (object) or #PaymentNotice (object) or #PaymentReconciliation (object) or #Person (object) or #PlanDefinition (object) or #Practitioner (object) or #PractitionerRole (object) or #Procedure (object) or #Provenance (object) or #Questionnaire (object) or #QuestionnaireResponse (object) or #RelatedPerson (object) or #RequestGroup (object) or #ResearchDefinition (object) or #ResearchElementDefinition (object) or #ResearchStudy (object) or #ResearchSubject (object) or #RiskAssessment (object) or #RiskEvidenceSynthesis (object) or #Schedule (object) or #SearchParameter (object) or #ServiceRequest (object) or #Slot (object) or #Specimen (object) or #SpecimenDefinition (object) or #StructureDefinition (object) or #StructureMap (object) or #Subscription (object) or #Substance (object) or #SubstanceNucleicAcid (object) or #SubstancePolymer (object) or #SubstanceProtein (object) or #SubstanceReferenceInformation (object) or #SubstanceSourceMaterial (object) or #SubstanceSpecification (object) or #SupplyDelivery (object) or #SupplyRequest (object) or #Task (object) or #TerminologyCapabilities (object) or #TestReport (object) or #TestScript (object) or #ValueSet (object) or #VerificationResult (object) or #VisionPrescription (object)(ResourceList)

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

extensionArray of objects(Extension)

May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

modifierExtensionArray of objects(Extension)

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

identifierArray of objects(Identifier)

Business identifiers assigned to this procedure by the performer or other systems which remain constant as the resource is updated and is propagated from server to server.

instantiatesCanonicalArray of strings(canonical)

The URL pointing to a FHIR-defined protocol, guideline, order set or other definition that is adhered to in whole or in part by this Procedure.

instantiatesUriArray of strings(uri)

The URL pointing to an externally maintained protocol, guideline, order set or other definition that is adhered to in whole or in part by this Procedure.

_instantiatesUriArray of objects(Element)

Extensions for instantiatesUri

basedOnArray of objects(Reference)

A reference to a resource that contains details of the request for this procedure.

partOfArray of objects(Reference)

A larger event of which this particular procedure is a component or step.

statusstring(code)^[^\s]+(\s[^\s]+)*$

A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents

_statusobject(Element)

Base definition for all elements in a resource.

statusReasonobject(CodeableConcept)

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

categoryobject(CodeableConcept)

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

codeobject(CodeableConcept)

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

subjectobject(Reference)required

A reference from one resource to another.

subject.​idobject(#string)

An extension object type #string.

subject.​extensionArray of objects(#Extension)

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

subject.​referenceobject(#string)

An extension object type #string.

subject.​_referenceobject(#Element)

An extension object type #Element.

subject.​typeobject(#uri)

An extension object type #uri.

subject.​_typeobject(#Element)

An extension object type #Element.

subject.​identifierobject(#Identifier)

An extension object type #Identifier.

subject.​displayobject(#string)

An extension object type #string.

subject.​_displayobject(#Element)

An extension object type #Element.

encounterobject(Reference)

A reference from one resource to another.

performedDateTimestring^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-...

Estimated or actual date, date-time, period, or age when the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.

Example: "2013-04-05"
_performedDateTimeobject(Element)

Base definition for all elements in a resource.

performedPeriodobject(Period)

A time period defined by a start and end date and optionally time.

performedStringstring^[ \r\n\t\S]+$

Estimated or actual date, date-time, period, or age when the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.

_performedStringobject(Element)

Base definition for all elements in a resource.

performedAgeobject(Age)

A duration of time during which an organism (or a process) has existed.

performedRangeobject(Range)

A set of ordered Quantities defined by a low and high limit.

recorderobject(Reference)

A reference from one resource to another.

asserterobject(Reference)

A reference from one resource to another.

performerArray of objects(Procedure_Performer)

Limited to "real" people rather than equipment.

Example: [{"actor":{"reference":"Practitioner/example","display":"Dr Cecil Surgeon"}}]
locationobject(Reference)

A reference from one resource to another.

reasonCodeArray of objects(CodeableConcept)

The coded reason why the procedure was performed. This may be a coded entity of some type, or may simply be present as text.

Example: [{"text":"Generalized abdominal pain 24 hours. Localized in RIF with rebound and guarding"}]
reasonReferenceArray of objects(Reference)

The justification of why the procedure was performed.

bodySiteArray of objects(CodeableConcept)

Detailed and structured anatomical location information. Multiple locations are allowed - e.g. multiple punch biopsies of a lesion.

outcomeobject(CodeableConcept)

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

reportArray of objects(Reference)

This could be a histology result, pathology report, surgical report, etc.

complicationArray of objects(CodeableConcept)

Any complications that occurred during the procedure, or in the immediate post-performance period. These are generally tracked separately from the notes, which will typically describe the procedure itself rather than any 'post procedure' issues.

complicationDetailArray of objects(Reference)

Any complications that occurred during the procedure, or in the immediate post-performance period.

followUpArray of objects(CodeableConcept)

If the procedure required specific follow up - e.g. removal of sutures. The follow up may be represented as a simple note or could potentially be more complex, in which case the CarePlan resource can be used.

Example: [{"text":"ROS 5 days - 2013-04-10"}]
noteArray of objects(Annotation)

Any other notes and comments about the procedure.

Example: [{"text":"Routine Appendectomy. Appendix was inflamed and in retro-caecal position"}]
focalDeviceArray of objects(Procedure_FocalDevice)

A device that is implanted, removed or otherwise manipulated (calibration, battery replacement, fitting a prosthesis, attaching a wound-vac, etc.) as a focal portion of the Procedure.

usedReferenceArray of objects(Reference)

Identifies medications, devices and any other substance used as part of the procedure.

usedCodeArray of objects(CodeableConcept)

Identifies coded items that were used as part of the procedure.

Response
application/json
{ "resourceType": "Procedure", "id": "example", "text": { "status": "generated", "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Routine Appendectomy</div>" }, "status": "completed", "code": { "coding": [ … ], "text": "Appendectomy" }, "subject": { "reference": "Patient/example" }, "performedDateTime": "2013-04-05", "recorder": { "reference": "Practitioner/example", "display": "Dr Cecil Surgeon" }, "asserter": { "reference": "Practitioner/example", "display": "Dr Cecil Surgeon" }, "performer": [ { … } ], "reasonCode": [ { … } ], "followUp": [ { … } ], "note": [ { … } ] }

Delete FHIR R4 Procedure

Request

Path
idstringrequired

ID of the Procedure to delete

curl -i -X DELETE \
  'https://docs.heydonto.com/_mock/apis/fhir/openapi/fhir/procedure/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Procedure successfully deleted

Bodyapplication/json
statusTextstringrequired
Example: "OK"
statusnumberrequired
Example: 200
Response
application/json
{ "statusText": "OK", "status": 200 }

Get FHIR R4 Procedure history by ID

Request

Path
idstringrequired

ID of the Procedure

curl -i -X GET \
  'https://docs.heydonto.com/_mock/apis/fhir/openapi/fhir/procedure/{id}/history' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json
resourceTypeanyrequired

This is a Bundle resource

Value"Bundle"
typeanyrequired

Indicates that this is a history bundle.

Value"history"
entryArray of objectsrequired

A list of entries representing historical versions of the resource.

entry[].​fullUrlstringrequired
Example: "https://api.heydonto.com/procedure/6eca4369-7183-446e-bab7-addc609972d3"
entry[].​requestobjectrequired
entry[].​request.​methodstring
Enum"PUT""POST"
entry[].​request.​urlstring
Example: "https://api.heydonto.com/procedure/6eca4369-7183-446e-bab7-addc609972d3"
entry[].​resourceobjectrequired
Example: {"resourceType":"Procedure","id":"example","text":{"status":"generated","div":"<div xmlns=\"http://www.w3.org/1999/xhtml\">Routine Appendectomy</div>"},"status":"completed","code":{"coding":[{"system":"http://snomed.info/sct","code":"80146002","display":"Appendectomy (Procedure)"}],"text":"Appendectomy"},"subject":{"reference":"Patient/example"},"performedDateTime":"2013-04-05","recorder":{"reference":"Practitioner/example","display":"Dr Cecil Surgeon"},"asserter":{"reference":"Practitioner/example","display":"Dr Cecil Surgeon"},"performer":[{"actor":{"reference":"Practitioner/example","display":"Dr Cecil Surgeon"}}],"reasonCode":[{"text":"Generalized abdominal pain 24 hours. Localized in RIF with rebound and guarding"}],"followUp":[{"text":"ROS 5 days - 2013-04-10"}],"note":[{"text":"Routine Appendectomy. Appendix was inflamed and in retro-caecal position"}]}
entry[].​responseobjectrequired
entry[].​response.​lastModifiedstring(date-time)
Example: "2024-10-29T01:05:22.739517+00:00"
entry[].​response.​locationstring
Example: "https://api.heydonto.com/procedure/6eca4369-7183-446e-bab7-addc609972d3/_history/MTczMDE2MzkyMjczOTUxNzAwMA"
entry[].​response.​statusstring
Example: "200 OK"
totalintegerrequired
Example: 2
Response
application/json
{ "resourceType": "Bundle", "type": "history", "entry": [ { … } ], "total": 2 }

Provenance

Operations

Questionnaire

Operations

QuestionnaireResponse

Operations

RelatedPerson

Operations

RequestGroup

Operations

ResearchDefinition

Operations

ResearchElementDefinition

Operations

ResearchStudy

Operations

ResearchSubject

Operations

RiskAssessment

Operations

RiskEvidenceSynthesis

Operations

Schedule

Operations

SearchParameter

Operations

ServiceRequest

Operations

Slot

Operations

Specimen

Operations

SpecimenDefinition

Operations

StructureDefinition

Operations

StructureMap

Operations

Subscription

Operations

Substance

Operations

SubstanceNucleicAcid

Operations

SubstancePolymer

Operations

SubstanceProtein

Operations

SubstanceReferenceInformation

Operations

SubstanceSourceMaterial

Operations

SubstanceSpecification

Operations

SupplyDelivery

Operations

SupplyRequest

Operations

Task

Operations

TerminologyCapabilities

Operations

TestReport

Operations

TestScript

Operations

ValueSet

Operations

VerificationResult

Operations

VisionPrescription

Operations