openapi: 3.0.3
components:
schemas:
address:
type: object
properties:
activeFromDate:
type: string
format: date-time
activeToDate:
type: string
format: date-time
city:
type: string
country:
type: string
district:
type: string
id:
type: string
lastUpdatedDate:
type: string
format: date-time
line:
type: string
parentId:
type: string
postalCode:
type: string
state:
type: string
text:
type: string
use:
type: string
allergyIntolerance:
type: object
properties:
asserterDisplay:
type: string
asserterReference:
type: string
category:
type: string
clinicalStatusCode:
type: string
clinicalStatusSystem:
type: string
codeId:
type: string
codeSystem:
type: string
id:
type: string
identifierCode:
type: string
identifierValue:
type: string
lastModifiedDate:
type: string
format: date-time
lastOccurenceDateTime:
type: string
format: date-time
onsetDateTime:
type: string
format: date-time
onsetEndDate:
type: string
onsetStartDate:
type: string
patientDisplay:
type: string
patientReferenceId:
type: string
recordedDate:
type: string
recorderDisplay:
type: string
recorderReference:
type: string
severity:
type: string
type:
type: string
verificationStatusCode:
type: string
verificationStatusSystem:
type: string
authorNote:
type: object
properties:
authorDisplay:
type: string
authorReference:
type: string
authorString:
type: string
id:
type: string
lastUpdatedDate:
type: string
format: date-time
parentId:
type: string
text:
type: string
time:
type: string
carePerformer:
type: object
properties:
actorDisplay:
type: string
actorReference:
type: string
functionCode:
type: string
functionSystem:
type: string
id:
type: string
lastUpdatedDate:
type: string
format: date-time
onBehalfOfDisplay:
type: string
onBehalfOfReference:
type: string
parentId:
type: string
clinicalEncounterDiagnosis:
type: object
properties:
diagnosisDisplay:
type: string
diagnosisId:
type: string
diagnosisRank:
type: string
id:
type: string
lastUpdatedDate:
type: string
format: date-time
parentId:
type: string
usageTypeCode:
type: string
usageTypeSystem:
type: string
clinicalEncounterProvider:
type: object
properties:
endDate:
type: string
format: date-time
id:
type: string
lastUpdatedDate:
type: string
format: date-time
parentId:
type: string
practitionerId:
type: string
practitionerIdDisplay:
type: string
startDate:
type: string
format: date-time
typeCode:
type: string
typeCodeSystem:
type: string
clinicalEncounterReason:
type: object
properties:
id:
type: string
lastUpdatedDate:
type: string
format: date-time
parentId:
type: string
reasonCode:
type: string
reasonCodeSystem:
type: string
reasonReferenceDisplay:
type: string
reasonReferenceId:
type: string
condition:
type: object
properties:
abatementDateTime:
type: string
format: date-time
abatementPeriodEnd:
type: string
format: date-time
abatementPeriodStart:
type: string
format: date-time
asserterDisplay:
type: string
asserterReference:
type: string
categoryCode:
type: string
categorySystem:
type: string
clinicalStatusCode:
type: string
clinicalStatusSystem:
type: string
code:
type: string
codeSystem:
type: string
encounterDisplay:
type: string
encounterReference:
type: string
id:
type: string
identifierCode:
type: string
identifierValue:
type: string
lastUpdatedDate:
type: string
format: date-time
onsetDateTime:
type: string
format: date-time
onsetPeriodEnd:
type: string
format: date-time
onsetPeriodStart:
type: string
format: date-time
recordedDate:
type: string
format: date-time
recorderDisplay:
type: string
recorderReference:
type: string
severityCode:
type: string
severitySystem:
type: string
stageCode:
type: string
stageSystem:
type: string
subjectDisplay:
type: string
subjectReference:
type: string
verificationStatusCode:
type: string
verificationStatusSystem:
type: string
conditionDetail:
type: object
properties:
codeId:
type: string
codeSystem:
type: string
id:
type: string
lastUpdatedDate:
type: string
format: date-time
parentId:
type: string
relatedContact:
type: object
properties:
familyName:
type: string
fullName:
type: string
gender:
type: string
givenName:
type: string
id:
type: string
lastUpdatedDate:
type: string
format: date-time
parentId:
type: string
relationship:
type: string
relationshipCode:
type: string
encounter:
type: object
properties:
admissionSourceCode:
type: string
admissionSourceSystem:
type: string
class:
type: string
destinationFacilityDisplay:
type: string
destinationFacilityId:
type: string
destinationOrganizationDisplay:
type: string
destinationOrganizationId:
type: string
dietPreference:
type: string
dischargeDispositionId:
type: string
dischargeDispositionSystem:
type: string
duration:
type: string
durationUnitId:
type: string
endDate:
type: string
format: date-time
facilityDisplay:
type: string
facilityId:
type: string
id:
type: string
identifierCode:
type: string
identifierValue:
type: string
lastUpdatedDate:
type: string
format: date-time
locationDisplay:
type: string
locationId:
type: string
preAdmissionIdentifierId:
type: string
preAdmissionIdentifierSystem:
type: string
preAdmissionIdentifierUse:
type: string
previousFacilityDisplay:
type: string
previousFacilityId:
type: string
previousOrganizationDisplay:
type: string
previousOrganizationId:
type: string
priorityId:
type: string
readmissionCodeId:
type: string
readmissionCodeSystem:
type: string
relatedClinicalEncounterDisplay:
type: string
relatedClinicalEncounterId:
type: string
serviceType:
type: string
specialCourtesy:
type: string
startDate:
type: string
format: date-time
status:
type: string
subjectId:
type: string
type:
type: string
medicationRequest:
type: object
properties:
authoredOn:
type: string
canSubstitute:
type: string
canSubstituteCode:
type: string
canSubstituteSystem:
type: string
categoryCode:
type: string
categorySystem:
type: string
courseOfTherapyTypeCode:
type: string
courseOfTherapyTypeSystem:
type: string
dispenseInterval:
type: number
dispenseIntervalUnit:
type: string
dispenserDisplay:
type: string
dispenserReference:
type: string
doNotPerform:
type: string
encounterDisplay:
type: string
encounterReference:
type: string
groupIdentifierCode:
type: string
groupIdentifierValue:
type: string
id:
type: string
identifierCode:
type: string
identifierValue:
type: string
initialFillDuration:
type: number
initialFillDurationUnit:
type: string
initialFillQuantity:
type: number
initialFillQuantityUnit:
type: string
intent:
type: string
lastUpdatedDate:
type: string
format: date-time
medicationCode:
type: string
medicationDisplay:
type: string
medicationReference:
type: string
medicationRequestDisplay:
type: string
medicationRequestReference:
type: string
medicationSystem:
type: string
performerDisplay:
type: string
performerReference:
type: string
performerTypeCode:
type: string
performerTypeSystem:
type: string
prescriptionPeriodEnd:
type: string
format: date-time
prescriptionPeriodStart:
type: string
format: date-time
previousPrescriptionDisplay:
type: string
previousPrescriptionReference:
type: string
priority:
type: string
reasonCode:
type: string
reasonCodeSystem:
type: string
reasonDisplay:
type: string
reasonReference:
type: string
refillDuration:
type: number
refillDurationUnit:
type: string
refillQuantity:
type: number
refillQuantityUnit:
type: string
refillsAllowed:
type: number
requesterDisplay:
type: string
requesterReference:
type: string
serviceRequestDisplay:
type: string
serviceRequestReference:
type: string
status:
type: string
statusReasonCode:
type: string
statusReasonSystem:
type: string
subjectDisplay:
type: string
subjectReference:
type: string
substitutionReasonCode:
type: string
substitutionReasonSystem:
type: string
patient:
type: object
properties:
birthDate:
type: string
format: date
communicationLanguage:
type: string
gender:
type: string
id:
type: string
identifierCode:
type: string
identifierValue:
type: string
isActive:
type: string
lastUpdatedDate:
type: string
format: date-time
managingOrgAccountId:
type: string
maritalStatus:
type: string
mrnNumber:
type: string
officialFamilyName:
type: string
officialFullName:
type: string
officialGivenName:
type: string
officialSuffix:
type: string
usualFamilyName:
type: string
usualFullName:
type: string
usualGivenName:
type: string
usualSuffix:
type: string
patientMedicationDosage:
type: object
properties:
activityCountPerRepetition:
type: string
activityDuration:
type: number
activityDurationUnitId:
type: string
activityTime:
type: string
activityTimeOffset:
type: string
additionalInstructionCode:
type: string
additionalInstructionSystem:
type: string
countInPeriod:
type: string
dosageAndRateSystem:
type: string
dosageAndRateType:
type: string
dosageQuantityDenominator:
type: number
dosageQuantityNumerator:
type: number
dosageQuantityType:
type: string
dosageQuantityUnit:
type: string
dosageRateDenominator:
type: number
dosageRateNumerator:
type: number
dosageRateType:
type: string
dosageRateUnit:
type: string
id:
type: string
isAsNeeded:
type: string
lastUpdatedDate:
type: string
format: date-time
maxActivityCountPerRepetition:
type: string
maxActivityDuration:
type: number
maxCountInPeriod:
type: string
maxRepetitionCycleLength:
type: number
methodCode:
type: string
methodSystem:
type: string
parentId:
type: string
patientInstruction:
type: string
periodEndDateTime:
type: string
format: date-time
periodLength:
type: string
periodLengthDurationUnit:
type: string
periodLengthLowerLimit:
type: number
periodLengthRangeUnit:
type: string
periodLengthUpperLimit:
type: number
periodStartDateTime:
type: string
format: date-time
repetitionCycleLength:
type: number
repetitionCycleUnitId:
type: string
routeCode:
type: string
routeSystem:
type: string
sequence:
type: number
siteCode:
type: string
siteSystem:
type: string
text:
type: string
procedure:
type: object
properties:
asserterDisplay:
type: string
asserterReference:
type: string
categoryCode:
type: string
categorySystem:
type: string
code:
type: string
codeSystem:
type: string
encounterDisplay:
type: string
encounterReference:
type: string
id:
type: string
identifierCode:
type: string
identifierValue:
type: string
lastUpdatedDate:
type: string
format: date-time
locationDisplay:
type: string
locationReference:
type: string
outcomeCode:
type: string
outcomeSystem:
type: string
performedAtAge:
type: string
performedDateTime:
type: string
format: date-time
performedPeriodEnd:
type: string
format: date-time
performedPeriodStart:
type: string
format: date-time
performedRangeHigh:
type: string
performedRangeLow:
type: string
performedString:
type: string
reasonCode:
type: string
reasonDisplay:
type: string
reasonReference:
type: string
reasonSystem:
type: string
recorderDisplay:
type: string
recorderReference:
type: string
reportDisplay:
type: string
reportReference:
type: string
status:
type: string
statusReasonCode:
type: string
statusReasonSystem:
type: string
subjectDisplay:
type: string
subjectReference:
type: string
procedureDetail:
type: object
properties:
detailCodeId:
type: string
detailCodeSystem:
type: string
detailRecordDisplay:
type: string
detailRecordId:
type: string
id:
type: string
lastUpdatedDate:
type: string
format: date-time
parentId:
type: string
type:
type: string
reaction:
type: object
properties:
description:
type: string
exposureRouteCode:
type: string
exposureRouteSystem:
type: string
id:
type: string
lastModifiedDate:
type: string
format: date-time
manifestationCode:
type: string
manifestationSystem:
type: string
onset:
type: string
parentId:
type: string
severity:
type: string
substanceCode:
type: string
substanceSystem:
type: string
telecom:
type: object
properties:
activeFromDate:
type: string
format: date-time
activeToDate:
type: string
format: date-time
id:
type: string
lastUpdatedDate:
type: string
format: date-time
parentId:
type: string
phoneType:
type: string
preferenceRank:
type: string
telephoneNumber:
type: string
usageType:
type: string
observation:
type: object
properties:
id:
type: string
basedOnReference:
type: string
basedOnDisplay:
type: string
partOfReference:
type: string
partOfDisplay:
type: string
status:
type: string
categoryCode:
type: string
categorySystem:
type: string
categoryDisplay:
type: string
codeId:
type: string
codeSystem:
type: string
codeDisplay:
type: string
subjectReference:
type: string
subjectDisplay:
type: string
encounterReference:
type: string
encounterDisplay:
type: string
effectiveDateTime:
type: string
format: date-time
effectivePeriodStart:
type: string
format: date-time
effectivePeriodEnd:
type: string
format: date-time
issued:
type: string
format: date-time
performerReference:
type: string
performerDisplay:
type: string
interpretationCode:
type: string
interpretationSystem:
type: string
interpretationDisplay:
type: string
valueQuantityValue:
type: number
valueQuantityUnit:
type: string
valueQuantitySystem:
type: string
valueQuantityCode:
type: string
valueString:
type: string
valueBoolean:
type: boolean
valueInteger:
type: integer
valueRangeLowValue:
type: number
valueRangeLowUnit:
type: string
valueRangeLowSystem:
type: string
valueRangeLowCode:
type: string
valueRangeHighValue:
type: number
valueRangeHighUnit:
type: string
valueRangeHighSystem:
type: string
valueRangeHighCode:
type: string
valueRatioNumeratorValue:
type: number
valueRatioNumeratorUnit:
type: string
valueRatioNumeratorSystem:
type: string
valueRatioNumeratorCode:
type: string
valueRatioDenominatorValue:
type: number
valueRatioDenominatorUnit:
type: string
valueRatioDenominatorSystem:
type: string
valueRatioDenominatorCode:
type: string
valueDateTime:
type: string
format: date-time
valuePeriodStart:
type: string
format: date-time
valuePeriodEnd:
type: string
format: date-time
bodySiteCode:
type: string
bodySiteSystem:
type: string
bodySiteDisplay:
type: string
methodCode:
type: string
methodSystem:
type: string
methodDisplay:
type: string
deviceReference:
type: string
deviceDisplay:
type: string
lastModifiedDate:
type: string
format: date-time
observationComponent:
type: object
properties:
id:
type: string
parentId:
type: string
componentCode:
type: string
componentSystem:
type: string
componentDisplay:
type: string
componentValueQuantityValue:
type: number
componentValueQuantityUnit:
type: string
componentValueQuantitySystem:
type: string
componentValueQuantityCode:
type: string
componentValueString:
type: string
componentValueBoolean:
type: boolean
componentValueInteger:
type: integer
componentValueRangeLowValue:
type: number
componentValueRangeLowUnit:
type: string
componentValueRangeLowSystem:
type: string
componentValueRangeLowCode:
type: string
componentValueRangeHighValue:
type: number
componentValueRangeHighUnit:
type: string
componentValueRangeHighSystem:
type: string
componentValueRangeHighCode:
type: string
componentValueRatioNumeratorValue:
type: number
componentValueRatioNumeratorUnit:
type: string
componentValueRatioNumeratorSystem:
type: string
componentValueRatioNumeratorCode:
type: string
componentValueRatioDenominatorValue:
type: number
componentValueRatioDenominatorUnit:
type: string
componentValueRatioDenominatorSystem:
type: string
componentValueRatioDenominatorCode:
type: string
componentValueDateTime:
type: string
format: date-time
componentValuePeriodStart:
type: string
format: date-time
componentValuePeriodEnd:
type: string
format: date-time
dataAbsentReasonCode:
type: string
dataAbsentReasonSystem:
type: string
dataAbsentReasonDisplay:
type: string
interpretationCode:
type: string
interpretationSystem:
type: string
interpretationDisplay:
type: string
componentReferenceRangeLowValue:
type: number
componentReferenceRangeLowUnit:
type: string
componentReferenceRangeLowSystem:
type: string
componentReferenceRangeLowCode:
type: string
componentReferenceRangeHighValue:
type: number
componentReferenceRangeHighUnit:
type: string
componentReferenceRangeHighSystem:
type: string
componentReferenceRangeHighCode:
type: string
componentReferenceRangeText:
type: string
lastModifiedDate:
type: string
format: date-time
observationReferenceRange:
type: object
properties:
id:
type: string
parentId:
type: string
referenceRangeLowValue:
type: number
referenceRangeLowUnit:
type: string
referenceRangeLowSystem:
type: string
referenceRangeLowCode:
type: string
referenceRangeHighValue:
type: number
referenceRangeHighUnit:
type: string
referenceRangeHighSystem:
type: string
referenceRangeHighCode:
type: string
referenceRangeText:
type: string
hasMemberReference:
type: string
hasMemberDisplay:
type: string
derivedFromReference:
type: string
derivedFromDisplay:
type: string
lastModifiedDate:
type: string
format: date-time
immunization:
type: object
properties:
id:
type: string
identifierCode:
type: string
identifierValue:
type: string
status:
type: string
statusReasonCode:
type: string
statusReasonSystem:
type: string
statusReasonDisplay:
type: string
vaccineCode:
type: string
vaccineCodeSystem:
type: string
vaccineCodeDisplay:
type: string
patientReference:
type: string
patientDisplay:
type: string
encounterReference:
type: string
encounterDisplay:
type: string
occurrenceDateTime:
type: string
format: date
occurrenceString:
type: string
recorded:
type: string
format: date-time
primarySource:
type: boolean
reportOriginCode:
type: string
reportOriginSystem:
type: string
reportOriginDisplay:
type: string
locationReference:
type: string
locationDisplay:
type: string
manufacturerConceptCode:
type: string
manufacturerConceptSystem:
type: string
manufacturerReference:
type: string
manufacturerDisplay:
type: string
lotNumber:
type: string
expirationDate:
type: string
format: date-time
siteCode:
type: string
siteSystem:
type: string
siteDisplay:
type: string
routeCode:
type: string
routeSystem:
type: string
routeDisplay:
type: string
doseQuantityValue:
type: number
doseQuantityUnit:
type: string
doseQuantitySystem:
type: string
doseQuantityCode:
type: string
reasonCode:
type: string
reasonSystem:
type: string
reasonCodeDisplay:
type: string
reasonReference:
type: string
reasonDisplay:
type: string
isSubpotent:
type: boolean
subpotentReasonCode:
type: string
subpotentReasonSystem:
type: string
subpotentReasonDisplay:
type: string
lastModifiedDate:
type: string
format: date-time
immunizationReaction:
type: object
properties:
id:
type: string
parentId:
type: string
reactionDate:
type: string
format: date-time
reactionDetailReference:
type: string
reactionDetailDisplay:
type: string
reactionReported:
type: boolean
lastModifiedDate:
type: string
format: date-time
immunizationProtocolApplied:
type: object
properties:
id:
type: string
parentId:
type: string
series:
type: string
authorityReference:
type: string
authorityDisplay:
type: string
targetDiseaseCode:
type: string
targetDiseaseSystem:
type: string
targetDiseaseDisplay:
type: string
doseNumberPositiveInt:
type: integer
doseNumberString:
type: string
seriesDosesPositiveInt:
type: integer
seriesDosesString:
type: string
lastModifiedDate:
type: string
format: date-time
immunizationPerformer:
type: object
properties:
id:
type: string
parentId:
type: string
functionCode:
type: string
functionSystem:
type: string
functionDisplay:
type: string
actorReference:
type: string
actorDisplay:
type: string
lastModifiedDate:
type: string
format: date-time