Files
satusehat-bridging/openapi/openapi_satusehat.yaml
2025-11-24 09:13:08 +07:00

2867 lines
70 KiB
YAML

openapi: 3.0.3
info:
title: Integrasi-API-Satusehat
version: 1.0.0
description: Dokumentasi Integrasi Satusehat ke OpenAPI 3.0
servers:
- url: https://satusehat-api.multy.chat
paths:
/compositions:
post:
summary: Composition - Create
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Composition'
responses:
'200':
description: OK
/compositions/{id}:
put:
summary: Composition - Update
parameters:
- name: id
in: path
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Composition'
responses:
'200':
description: OK
/procedures:
post:
summary: Procedure - Create
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Procedure'
responses:
'200':
description: OK
/procedures/{id}:
put:
summary: Procedure - Update
parameters:
- name: id
in: path
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Procedure'
responses:
'200':
description: OK
/MedicineKfa:
get:
summary: Medicine-Kfa
responses:
'200':
description: OK
parameters:
- name: page
in: query
required: false
schema:
type: string
example: '1'
- name: size
in: query
required: false
schema:
type: string
example: '1000'
- name: product_type
in: query
required: false
schema:
type: string
example: farmasi
- name: keyword
in: query
required: false
schema:
type: string
example: ibuprofen
/MedicineKfa/{kfa_code}:
get:
summary: Medicine-Kfa - Get by KFA code
operationId: satusehat-rssa/internal/handler.MedicineHandler.GetMedicineByKfaCode-fm
parameters:
- name: kfa_code
in: path
required: true
schema:
type: string
description: KFA code of the medicine
responses:
'200':
description: OK
/ClinicalImpression:
post:
summary: ClinicalImpression
responses:
'200':
description: OK
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ClinicalImpression'
/ClinicalImpression/{id}:
put:
summary: ClinicalImpression - Update
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ClinicalImpression'
/AllergyIntolerance:
post:
summary: Alergi Makanan - Obat
responses:
'200':
description: OK
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AllergyIntolerance'
/AllergyIntolerance/{id}:
put:
summary: AllergyIntolerance - Update
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AllergyIntolerance'
/Encounter:
post:
summary: Encounter - Create
responses:
'200':
description: OK
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Encounter'
get:
summary: Encounter - by Subject
responses:
'200':
description: OK
parameters:
- name: subject
in: query
required: false
schema:
type: string
example: P20395297822
/Encounter/{id}:
put:
summary: Encounter - Update
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/EncounterUpdateRequest'
/Practitioner:
get:
summary: Practitioner - Search NIK
responses:
'200':
description: OK
parameters:
- name: identifier
in: query
required: false
schema:
type: string
example: https://fhir.kemkes.go.id/id/nik|3322071302900002
/Patient:
get:
summary: Patient - Search NIK
responses:
'200':
description: OK
parameters:
- name: identifier
in: query
required: false
schema:
type: string
example: https://fhir.kemkes.go.id/id/nik|3509087611003004
post:
summary: Patient - Create by NIK
responses:
'200':
description: OK
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Patient'
/Organization:
post:
summary: Organization - Create
responses:
'200':
description: OK
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Organization'
/observation:
post:
summary: Observation - Create
responses:
'200':
description: OK
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Observation'
/observation/{id}:
put:
summary: Observation - Update
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Observation'
/Condition:
post:
summary: Condition - Diagnosis
responses:
'200':
description: OK
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Condition'
/Condition/{id}:
put:
summary: Condition - Update
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Condition'
/service-request:
post:
summary: ServiceRequest - Laboratorium Non Rujukan Eksternal
responses:
'200':
description: OK
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceRequest'
/service-request/{id}:
put:
summary: ServiceRequest - Update
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceRequest'
/EpisodeOfCare:
get:
summary: EpisodeOfCare - Search by Patient
responses:
'200':
description: OK
parameters:
- name: patient
in: query
required: false
schema:
type: string
example: 100000030009
post:
summary: EpisodeOfCare - Create
responses:
'200':
description: OK
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/EpisodeOfCare'
/EpisodeOfCare/{id}:
put:
summary: EpisodeOfCare - Update
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/EpisodeOfCare'
/specimen:
post:
summary: Specimen - Create (Non Rujukan)
responses:
'200':
description: OK
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Specimen'
/specimen/{id}:
put:
summary: Specimen - Update
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Specimen'
/diagnosis-report:
post:
summary: DiagnosticReport - Create
responses:
'200':
description: OK
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DiagnosticReport'
/diagnosis-report/{id}:
put:
summary: DiagnosticReport - Update
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DiagnosticReport'
/CarePlan:
post:
summary: CarePlan - Create
responses:
'200':
description: OK
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CarePlan'
/CarePlan/{id}:
put:
summary: CarePlan - Update
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CarePlan'
/QuestionnaireResponse:
post:
summary: QuestionnaireResponse - Create
responses:
'200':
description: OK
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/QuestionnaireResponse'
/QuestionnaireResponse/{id}:
put:
summary: QuestionnaireResponse - Update
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/QuestionnaireResponse'
/MedicationStatement:
post:
summary: MedicationStatement - Create
responses:
'200':
description: OK
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/MedicationStatement'
/MedicationStatement/{id}:
put:
summary: MedicationStatement - Update
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/MedicationStatement'
/Immunization:
post:
summary: Immunization - Create
responses:
'200':
description: OK
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Immunization'
/Immunization/{id}:
put:
summary: Immunization - Update
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Immunization'
/ImagingStudy:
post:
summary: ImagingStudy - Create
responses:
'200':
description: OK
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ImagingStudy'
/ImagingStudy/{id}:
put:
summary: ImagingStudy - Update
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ImagingStudy'
/MedicationRequest:
post:
summary: MedicationRequest - Create
responses:
'200':
description: OK
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/MedicationRequest'
/MedicationRequest/{id}:
put:
summary: MedicationRequest - Update
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/MedicationRequest'
/MedicationDispense:
post:
summary: MedicationDispense - Create
responses:
'200':
description: OK
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/MedicationDispense'
/MedicationDispense/{id}:
put:
summary: MedicationDispense - Update
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/MedicationDispense'
/Goal:
post:
summary: Goal - Create
responses:
'200':
description: OK
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Goal'
/Goal/{id}:
put:
summary: Goal - Update
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Goal'
components:
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: x-api-key
schemas:
Composition:
type: object
required:
- status
- type
- category
- subject
- date
- author
- title
properties:
status:
type: string
type:
$ref: '#/components/schemas/CodeableConcept'
category:
type: array
items:
$ref: '#/components/schemas/CodeableConcept'
subject:
$ref: '#/components/schemas/Reference'
encounter:
$ref: '#/components/schemas/Reference'
date:
type: string
author:
type: array
items:
$ref: '#/components/schemas/Reference'
title:
type: string
custodian:
$ref: '#/components/schemas/Reference'
section:
type: array
items:
$ref: '#/components/schemas/Section'
anamnesis:
type: string
pemeriksaanFisik:
type: string
pemeriksaanPenunjang:
type: string
medikamentosa:
type: string
lanjutanPenatalaksanaan:
type: string
Identifier:
type: object
properties:
system:
type: string
value:
type: string
Section:
type: object
properties:
code:
$ref: '#/components/schemas/CodeableConcept'
text:
$ref: '#/components/schemas/SectionText'
SectionText:
type: object
properties:
status:
type: string
div:
type: string
Procedure:
type: object
required:
- status
- category
- code
- subject
- performedPeriod
- performer
- reasonCode
- bodySite
- note
properties:
status:
type: string
category:
$ref: '#/components/schemas/CodeableConcept'
code:
$ref: '#/components/schemas/CodeableConcept'
subject:
$ref: '#/components/schemas/Reference'
encounter:
$ref: '#/components/schemas/Reference'
performedPeriod:
$ref: '#/components/schemas/Period'
performer:
type: array
items:
$ref: '#/components/schemas/Performer'
reasonCode:
type: array
items:
$ref: '#/components/schemas/CodeableConcept'
bodySite:
type: array
items:
$ref: '#/components/schemas/CodeableConcept'
note:
type: array
items:
$ref: '#/components/schemas/Annotation'
CodeableConcept:
type: object
properties:
coding:
type: array
items:
$ref: '#/components/schemas/Coding'
text:
type: string
Coding:
type: object
properties:
system:
type: string
code:
type: string
display:
type: string
Reference:
type: object
properties:
reference:
type: string
display:
type: string
Period:
type: object
properties:
start:
type: string
end:
type: string
Performer:
type: object
properties:
actor:
$ref: '#/components/schemas/Reference'
Annotation:
type: object
properties:
text:
type: string
ClinicalImpression:
type: object
required:
- status
- description
- subject
- effectiveDateTime
- date
- assessor
- problem
properties:
status:
type: string
description:
type: string
subject:
type: object
properties:
reference:
type: string
display:
type: string
encounter:
type: object
properties:
reference:
type: string
display:
type: string
effectiveDateTime:
type: string
date:
type: string
assessor:
type: object
properties:
reference:
type: string
problem:
type: array
items:
type: object
properties:
reference:
type: string
investigation:
type: array
items:
type: object
properties:
code:
type: object
properties:
text:
type: string
item:
type: array
items:
type: object
properties:
reference:
type: string
summary:
type: string
finding:
type: array
items:
type: object
properties:
itemCodeableConcept:
type: object
properties:
coding:
type: array
items:
type: object
properties:
system:
type: string
code:
type: string
display:
type: string
itemReference:
type: object
properties:
reference:
type: string
prognosisCodeableConcept:
type: array
items:
type: object
properties:
coding:
type: array
items:
type: object
properties:
system:
type: string
code:
type: string
display:
type: string
AllergyIntolerance:
type: object
required:
- clinicalStatus
- verificationStatus
- category
- code
- patient
- recordedDate
- recorder
properties:
clinicalStatus:
type: object
properties:
coding:
type: array
items:
type: object
properties:
system:
type: string
code:
type: string
display:
type: string
verificationStatus:
type: object
properties:
coding:
type: array
items:
type: object
properties:
system:
type: string
code:
type: string
display:
type: string
category:
type: array
items:
type: string
code:
type: object
properties:
coding:
type: array
items:
type: object
properties:
system:
type: string
code:
type: string
display:
type: string
text:
type: string
patient:
type: object
properties:
reference:
type: string
recordedDate:
type: string
recorder:
type: object
properties:
reference:
type: string
Encounter:
type: object
required:
- status
- class
- subject
- participant
- period
properties:
status:
type: string
class:
type: object
properties:
system:
type: string
code:
type: string
display:
type: string
subject:
type: object
properties:
reference:
type: string
display:
type: string
participant:
type: array
items:
type: object
properties:
type:
type: array
items:
type: object
properties:
coding:
type: array
items:
type: object
properties:
system:
type: string
code:
type: string
display:
type: string
individual:
type: object
properties:
reference:
type: string
display:
type: string
period:
type: object
properties:
start:
type: string
location:
type: array
items:
type: object
properties:
location:
type: object
properties:
reference:
type: string
display:
type: string
statusHistory:
type: array
items:
type: object
properties:
status:
type: string
period:
type: object
properties:
start:
type: string
serviceProvider:
type: object
properties:
reference:
type: string
EncounterUpdateRequest:
type: object
properties:
resourceType:
type: string
identifier:
type: array
items:
type: object
properties:
system:
type: string
value:
type: string
status:
type: string
class:
type: object
properties:
system:
type: string
code:
type: string
display:
type: string
subject:
type: object
properties:
reference:
type: string
display:
type: string
participant:
type: array
items:
type: object
properties:
type:
type: array
items:
type: object
properties:
coding:
type: array
items:
type: object
properties:
system:
type: string
code:
type: string
display:
type: string
individual:
type: object
properties:
reference:
type: string
display:
type: string
period:
type: object
properties:
start:
type: string
format: date-time
end:
type: string
format: date-time
location:
type: array
items:
type: object
properties:
location:
type: object
properties:
reference:
type: string
display:
type: string
statusHistory:
type: array
items:
type: object
properties:
status:
type: string
period:
type: object
properties:
start:
type: string
format: date-time
end:
type: string
format: date-time
serviceProvider:
type: object
properties:
reference:
type: string
Condition:
type: object
required:
- category
- code
- subject
properties:
clinicalStatus:
type: object
properties:
coding:
type: array
items:
type: object
properties:
system:
type: string
code:
type: string
display:
type: string
category:
type: array
items:
type: object
properties:
coding:
type: array
items:
type: object
properties:
system:
type: string
code:
type: string
display:
type: string
code:
type: object
properties:
coding:
type: array
items:
type: object
properties:
system:
type: string
code:
type: string
display:
type: string
subject:
type: object
properties:
reference:
type: string
display:
type: string
encounter:
type: object
properties:
reference:
type: string
display:
type: string
ServiceRequest:
type: object
required:
- status
- intent
- code
- subject
- authoredOn
- requester
- performer
properties:
status:
type: string
intent:
type: string
priority:
type: string
category:
type: array
items:
type: object
properties:
coding:
type: array
items:
type: object
properties:
system:
type: string
code:
type: string
display:
type: string
code:
type: object
properties:
coding:
type: array
items:
type: object
properties:
system:
type: string
code:
type: string
display:
type: string
text:
type: string
subject:
type: object
properties:
reference:
type: string
occurrenceDateTime:
type: string
authoredOn:
type: string
requester:
type: object
properties:
reference:
type: string
display:
type: string
performer:
type: array
items:
type: object
properties:
reference:
type: string
display:
type: string
reasonCode:
type: array
items:
type: object
properties:
text:
type: string
EpisodeOfCare:
type: object
required:
- status
- statusHistory
- diagnosis
- type
- patient
- managingOrganization
- period
- careManager
properties:
status:
type: string
statusHistory:
type: array
items:
type: object
properties:
status:
type: string
period:
type: object
properties:
start:
type: string
end:
type: string
type:
type: array
items:
type: object
properties:
coding:
type: array
items:
type: object
properties:
system:
type: string
code:
type: string
display:
type: string
diagnosis:
type: array
items:
type: object
properties:
condition:
type: object
properties:
reference:
type: string
display:
type: string
role:
type: object
properties:
coding:
type: array
items:
type: object
properties:
system:
type: string
code:
type: string
display:
type: string
rank:
type: integer
patient:
type: object
properties:
reference:
type: string
display:
type: string
managingOrganization:
type: object
properties:
reference:
type: string
period:
type: object
properties:
start:
type: string
end:
type: string
careManager:
type: object
properties:
reference:
type: string
display:
type: string
Specimen:
type: object
required:
- status
- type
- subject
- collection
properties:
status:
type: string
type:
type: object
properties:
coding:
type: array
items:
type: object
properties:
system:
type: string
code:
type: string
display:
type: string
collection:
type: object
properties:
collectedDateTime:
type: string
extension:
type: array
items:
type: object
properties:
url:
type: string
valueReference:
type: object
properties:
reference:
type: string
subject:
type: object
properties:
reference:
type: string
display:
type: string
request:
type: array
items:
type: object
properties:
reference:
type: string
receivedTime:
type: string
extension:
type: array
items:
type: object
properties:
url:
type: string
valueDateTime:
type: string
DiagnosticReport:
type: object
required:
- status
- category
- code
- subject
- performer
- result
- basedOn
properties:
status:
type: string
category:
type: array
items:
type: object
properties:
coding:
type: array
items:
type: object
properties:
system:
type: string
code:
type: string
display:
type: string
code:
type: object
properties:
coding:
type: array
items:
type: object
properties:
system:
type: string
code:
type: string
display:
type: string
subject:
type: object
properties:
reference:
type: string
encounter:
type: object
properties:
reference:
type: string
effectiveDateTime:
type: string
issued:
type: string
performer:
type: array
items:
type: object
properties:
reference:
type: string
result:
type: array
items:
type: object
specimen:
type: array
items:
type: object
basedOn:
type: array
items:
type: object
conclusionCode:
type: array
items:
type: object
properties:
coding:
type: array
items:
type: object
properties:
system:
type: string
code:
type: string
display:
type: string
Observation:
type: object
required:
- resourceType
- status
- category
- code
- subject
- performer
- effectiveDateTime
- valueQuantity
properties:
status:
type: string
category:
type: array
items:
type: object
properties:
coding:
type: array
items:
type: object
properties:
system:
type: string
code:
type: string
display:
type: string
code:
type: object
properties:
coding:
type: array
items:
type: object
properties:
system:
type: string
code:
type: string
display:
type: string
subject:
type: object
properties:
reference:
type: string
performer:
type: array
items:
type: object
properties:
reference:
type: string
encounter:
type: object
properties:
reference:
type: string
display:
type: string
effectiveDateTime:
type: string
issued:
type: string
valueQuantity:
type: object
properties:
value:
type: number
unit:
type: string
system:
type: string
code:
type: string
Organization:
type: object
properties:
resourceType:
type: string
active:
type: boolean
identifier:
type: array
items:
type: object
properties:
use:
type: string
system:
type: string
value:
type: string
type:
type: array
items:
type: object
properties:
coding:
type: array
items:
type: object
properties:
system:
type: string
code:
type: string
display:
type: string
name:
type: string
telecom:
type: array
items:
type: object
properties:
system:
type: string
value:
type: string
use:
type: string
address:
type: array
items:
type: object
properties:
use:
type: string
type:
type: string
line:
type: array
items:
type: string
city:
type: string
postalCode:
type: string
country:
type: string
extension:
type: array
items:
type: object
properties:
url:
type: string
extension:
type: array
items:
type: object
properties:
url:
type: string
valueCode:
type: string
partOf:
type: object
properties:
reference:
type: string
Patient:
type: object
required:
- name
- gender
- birthDate
- address
- telecom
properties:
resourceType:
type: string
identifier:
type: array
items:
type: object
properties:
use:
type: string
system:
type: string
value:
type: string
name:
type: array
items:
type: object
properties:
use:
type: string
text:
type: string
family:
type: string
given:
type: array
items:
type: string
gender:
type: string
birthDate:
type: string
address:
type: array
items:
type: object
properties:
use:
type: string
type:
type: string
line:
type: array
items:
type: string
city:
type: string
postalCode:
type: string
country:
type: string
telecom:
type: array
items:
type: object
properties:
system:
type: string
value:
type: string
use:
type: string
CarePlan:
type: object
properties:
status:
type: string
intent:
type: string
category:
type: array
items:
type: object
properties:
coding:
type: array
items:
type: object
properties:
system:
type: string
code:
type: string
display:
type: string
title:
type: string
description:
type: string
subject:
type: object
properties:
reference:
type: string
display:
type: string
encounter:
type: object
properties:
reference:
type: string
created:
type: string
format: date-time
author:
type: object
properties:
reference:
type: string
goal:
type: array
items:
type: object
properties:
reference:
type: string
required:
- status
- intent
- category
- title
- description
- subject
- created
- author
QuestionnaireResponse:
type: object
properties:
questionnaire:
type: string
status:
type: string
subject:
type: object
properties:
reference:
type: string
display:
type: string
encounter:
type: object
properties:
reference:
type: string
authored:
type: string
format: date-time
author:
type: object
properties:
reference:
type: string
source:
type: object
properties:
reference:
type: string
item:
type: array
items:
type: object
properties:
linkId:
type: string
text:
type: string
answer:
type: array
items:
type: object
properties:
valueCoding:
type: object
properties:
system:
type: string
code:
type: string
display:
type: string
required:
- questionnaire
- status
- subject
- authored
- author
- source
- item
MedicationStatement:
type: object
properties:
contained:
type: array
description: Bisa multi obat, 1 id medication
items:
type: object
properties:
id:
type: string
code:
type: object
properties:
coding:
type: array
items:
type: object
properties:
code:
type: string
display:
type: string
system:
type: string
extension:
type: array
items:
type: object
properties:
url:
type: string
valueCodeableConcept:
type: object
properties:
coding:
type: array
items:
type: object
properties:
code:
type: string
display:
type: string
system:
type: string
form:
type: object
properties:
coding:
type: array
items:
type: object
properties:
code:
type: string
display:
type: string
system:
type: string
ingredient:
type: array
items:
type: object
properties:
isActive:
type: boolean
itemCodeableConcept:
type: object
properties:
coding:
type: array
items:
type: object
properties:
code:
type: string
display:
type: string
system:
type: string
strength:
type: object
properties:
denominator:
type: object
properties:
code:
type: string
system:
type: string
unit:
type: string
value:
type: number
numerator:
type: object
properties:
code:
type: string
system:
type: string
value:
type: number
batch:
type: object
properties:
lotNumber:
type: string
expirationDate:
type: string
format: date
meta:
type: object
properties:
profile:
type: array
items:
type: string
resourceType:
type: string
status:
type: string
status:
type: string
category:
type: object
properties:
coding:
type: array
items:
type: object
properties:
system:
type: string
code:
type: string
display:
type: string
medicationReference:
type: object
properties:
reference:
type: string
display:
type: string
subject:
type: object
properties:
reference:
type: string
display:
type: string
dosage:
type: array
items:
type: object
properties:
text:
type: string
timing:
type: object
properties:
repeat:
type: object
properties:
frequency:
type: integer
period:
type: number
periodUnit:
type: string
effectiveDateTime:
type: string
format: date-time
dateAsserted:
type: string
format: date-time
informationSource:
type: object
properties:
reference:
type: string
display:
type: string
context:
type: object
properties:
reference:
type: string
required:
- contained
- status
- medicationReference
- subject
- effectiveDateTime
- dateAsserted
- informationSource
Immunization:
type: object
required:
- status
- vaccineCode
- patient
- occurrenceDateTime
- primarySource
- location
- lotNumber
- route
- doseQuantity
- performer
- reasonCode
- protocolApplied
properties:
status:
type: string
enum: [completed, entered-in-error, not-done]
vaccineCode:
type: object
properties:
coding:
type: array
items:
type: object
properties:
system:
type: string
code:
type: string
display:
type: string
patient:
type: object
properties:
reference:
type: string
display:
type: string
encounter:
type: object
properties:
reference:
type: string
occurrenceDateTime:
type: string
format: date-time
expirationDate:
type: string
format: date
recorded:
type: string
format: date-time
primarySource:
type: boolean
location:
type: object
properties:
reference:
type: string
display:
type: string
lotNumber:
type: string
route:
type: object
properties:
coding:
type: array
items:
type: object
properties:
system:
type: string
code:
type: string
display:
type: string
doseQuantity:
type: object
properties:
value:
type: number
unit:
type: string
system:
type: string
code:
type: string
performer:
type: array
items:
type: object
properties:
function:
type: object
properties:
coding:
type: array
items:
type: object
properties:
system:
type: string
code:
type: string
display:
type: string
actor:
type: object
properties:
reference:
type: string
reasonCode:
type: array
items:
type: object
properties:
coding:
type: array
items:
type: object
properties:
system:
type: string
code:
type: string
display:
type: string
protocolApplied:
type: array
items:
type: object
properties:
doseNumberPositiveInt:
type: integer
ImagingStudy:
type: object
properties:
identifier:
type: array
items:
type: object
properties:
value:
type: string
status:
type: string
modality:
type: array
items:
type: object
properties:
system:
type: string
code:
type: string
subject:
type: object
properties:
reference:
type: string
started:
type: string
format: date-time
basedOn:
type: array
items:
type: object
properties:
reference:
type: string
numberOfSeries:
type: integer
numberOfInstances:
type: integer
series:
type: array
items:
type: object
properties:
uid:
type: string
number:
type: integer
modality:
type: object
properties:
system:
type: string
code:
type: string
numberOfInstances:
type: integer
started:
type: string
format: date-time
instance:
type: array
items:
type: object
properties:
uid:
type: string
sopClass:
type: object
properties:
system:
type: string
code:
type: string
number:
type: integer
title:
type: string
required:
- identifier
- status
- subject
- started
- series
MedicationRequest:
type: object
properties:
status:
type: string
intent:
type: string
category:
type: array
items:
type: object
properties:
coding:
type: array
items:
type: object
properties:
system:
type: string
code:
type: string
display:
type: string
priority:
type: string
medicationReference:
type: object
properties:
reference:
type: string
display:
type: string
subject:
type: object
properties:
reference:
type: string
display:
type: string
encounter:
type: object
properties:
reference:
type: string
authoredOn:
type: string
format: date-time
requester:
type: object
properties:
reference:
type: string
display:
type: string
reasonCode:
type: array
items:
type: object
properties:
coding:
type: array
items:
type: object
properties:
system:
type: string
code:
type: string
display:
type: string
courseOfTherapyType:
type: object
properties:
coding:
type: array
items:
type: object
properties:
system:
type: string
code:
type: string
display:
type: string
dosageInstruction:
type: array
items:
type: object
properties:
sequence:
type: integer
text:
type: string
additionalInstruction:
type: array
items:
type: object
properties:
text:
type: string
patientInstruction:
type: string
timing:
type: object
properties:
repeat:
type: object
properties:
frequency:
type: integer
period:
type: number
periodUnit:
type: string
route:
type: object
properties:
coding:
type: array
items:
type: object
properties:
system:
type: string
code:
type: string
display:
type: string
doseAndRate:
type: array
items:
type: object
properties:
type:
type: object
properties:
coding:
type: array
items:
type: object
properties:
system:
type: string
code:
type: string
display:
type: string
doseQuantity:
type: object
properties:
value:
type: number
unit:
type: string
system:
type: string
code:
type: string
dispenseRequest:
type: object
properties:
dispenseInterval:
type: object
properties:
value:
type: number
unit:
type: string
system:
type: string
code:
type: string
validityPeriod:
type: object
properties:
start:
type: string
format: date-time
end:
type: string
format: date-time
numberOfRepeatsAllowed:
type: integer
quantity:
type: object
properties:
value:
type: number
unit:
type: string
system:
type: string
code:
type: string
expectedSupplyDuration:
type: object
properties:
value:
type: number
unit:
type: string
system:
type: string
code:
type: string
performer:
type: object
properties:
reference:
type: string
required:
- status
- intent
- priority
- medicationReference
- subject
- authoredOn
- requester
- dispenseRequest
MedicationDispense:
type: object
required:
- status
- medicationReference
- subject
- location
- authorizingPrescription
- quantity
- daysSupply
- whenPrepared
- whenHandedOver
properties:
status:
type: string
category:
type: object
properties:
coding:
type: array
items:
type: object
properties:
system:
type: string
code:
type: string
display:
type: string
medicationReference:
type: object
properties:
reference:
type: string
display:
type: string
subject:
type: object
properties:
reference:
type: string
display:
type: string
context:
type: object
properties:
reference:
type: string
performer:
type: array
items:
type: object
properties:
actor:
type: object
properties:
reference:
type: string
display:
type: string
location:
type: object
properties:
reference:
type: string
display:
type: string
authorizingPrescription:
type: array
items:
type: object
properties:
reference:
type: string
quantity:
type: object
properties:
system:
type: string
code:
type: string
value:
type: number
daysSupply:
type: object
properties:
value:
type: number
unit:
type: string
system:
type: string
code:
type: string
whenPrepared:
type: string
format: date-time
whenHandedOver:
type: string
format: date-time
dosageInstruction:
type: array
items:
type: object
properties:
sequence:
type: integer
text:
type: string
timing:
type: object
properties:
repeat:
type: object
properties:
frequency:
type: integer
period:
type: integer
periodUnit:
type: string
doseAndRate:
type: array
items:
type: object
properties:
type:
type: object
properties:
coding:
type: array
items:
type: object
properties:
system:
type: string
code:
type: string
display:
type: string
doseQuantity:
type: object
properties:
value:
type: number
unit:
type: string
system:
type: string
code:
type: string
Goal:
type: object
properties:
lifecycleStatus:
type: string
category:
type: array
items:
type: object
properties:
coding:
type: array
items:
type: object
properties:
system:
type: string
code:
type: string
display:
type: string
description:
type: object
properties:
text:
type: string
subject:
type: object
properties:
reference:
type: string
target:
type: array
items:
type: object
properties:
measure:
type: object
properties:
coding:
type: array
items:
type: object
properties:
system:
type: string
code:
type: string
display:
type: string
detailCodeableConcept:
type: object
properties:
coding:
type: array
items:
type: object
properties:
system:
type: string
code:
type: string
display:
type: string
dueDate:
type: string
format: date
statusDate:
type: string
format: date
expressedBy:
type: object
properties:
reference:
type: string
addresses:
type: array
items:
type: object
properties:
reference:
type: string
required:
- lifecycleStatus
- category
- subject
- target
- statusDate
- expressedBy
security:
- ApiKeyAuth: []