API Name: put-screening


This API creates the Project Silver Screen (PSS) questionnaire response.

Specification


Endpoint [baseurl]/QuestionnaireResponse/$put-screening
Protocol HTTPS
HTTP Method Post
HTTP Header Content-Type: application/fhir+json

Request Body

Remarks:

  • (All Slices) is an automatically generated section and should be ignored. Do not pass this as an input parameter. It will also not be part of response.

QuestionnaireResponse

idΣ0..1id
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
textC0..1Narrative
containedC0..*Resource
id0..1id
extensionC0..0Extension
url1..1uriFixed Value
id0..0id
extensionC0..0Extension
systemΣ1..1uriFixed Value
versionΣ0..1string
codeΣ C1..1code
displayΣ C1..1string
userSelectedΣ0..0boolean
modifierExtensionΣ ?! C0..*Extension
identifierΣ1..1Identifier
basedOnΣ0..0Reference(CarePlan | ServiceRequest)
partOfΣ0..0Reference(Observation | Procedure)
questionnaireΣ1..1canonical(Questionnaire)
statusΣ ?!1..1codeBinding
subjectΣ1..1Reference(Patient)
encounterΣ0..1Reference(Encounter)
authoredΣ1..1dateTime
authorΣ0..0Reference(Practitioner | Patient | Organization)
sourceΣ0..0Reference(Patient | Practitioner | Organization)
id0..0string
id0..0id
extensionC0..0Extension
url1..1uriFixed Value
id0..0id
extensionC0..0Extension
systemΣ1..1uriFixed Value
versionΣ0..1string
codeΣ C1..1code
displayΣ C1..1string
userSelectedΣ0..0boolean
id0..0id
extensionC0..0Extension
url1..1uriFixed Value
id0..0id
extensionC0..0Extension
systemΣ1..1uriFixed Value
versionΣ0..1string
codeΣ C1..1code
displayΣ C1..1string
userSelectedΣ0..0boolean
modifierExtensionΣ ?! C0..0Extension
linkIdC1..1string
definition0..0uri
text1..1string
id0..0string
extensionC0..0Extension
modifierExtensionΣ ?! C0..0Extension
valueStringstring
valueCodingCoding
item0..0see (item)
id0..0string
extensionC0..0Extension
modifierExtensionΣ ?! C0..0Extension
id0..0id
extensionC0..0Extension
systemΣ1..1uriFixed Value
versionΣ0..1string
codeΣ C1..1code
displayΣ C1..1string
userSelectedΣ0..0boolean
item0..0see (item)
id0..0string
extensionC0..0Extension
modifierExtensionΣ ?! C0..0Extension
id0..0id
extensionC0..0Extension
systemΣ1..1uriFixed Value
versionΣ0..1string
codeΣ C1..1code
displayΣ C1..1string
userSelectedΣ0..0boolean
item0..0see (item)
id0..0string
extensionC0..0Extension
modifierExtensionΣ ?! C0..0Extension
id0..0id
extensionC0..0Extension
systemΣ1..1uriFixed Value
versionΣ0..1string
codeΣ C1..1code
displayΣ C1..1string
userSelectedΣ0..0boolean
item0..0see (item)
id0..0string
extensionC0..0Extension
modifierExtensionΣ ?! C0..0Extension
id0..0id
extensionC0..0Extension
systemΣ1..1uriFixed Value
versionΣ0..1string
codeΣ C1..1code
displayΣ C1..1string
userSelectedΣ0..0boolean
item0..0see (item)
id0..0string
extensionC0..0Extension
modifierExtensionΣ ?! C0..0Extension
id0..1id
extensionC0..*Extension
systemΣ1..1uriFixed Value
versionΣ0..1string
codeΣ C1..1code
displayΣ C1..1string
userSelectedΣ0..1boolean
item0..0see (item)
id0..0string
extensionC0..0Extension
modifierExtensionΣ ?! C0..0Extension
id0..1id
extensionC0..*Extension
systemΣ1..1uriFixed Value
versionΣ0..1string
codeΣ C1..1code
displayΣ C1..1string
userSelectedΣ0..1boolean
item0..0see (item)
item0..0see (item)
{
"resourceType": "QuestionnaireResponse",
"questionnaire": "https://fhir.synapxe.sg/Questionnaire/pss-screen",
"status": "completed",
{
"system": "https://fhir.synapxe.sg/NamingSystem/questionnaireResponseId",
"value": "QR-00001"
}
],
{
"url": "https://fhir.synapxe.sg/StructureDefinition/ExtensionAssessmentType",
"system": "https://fhir.synapxe.sg/CodeSystem/assessment-type",
"code": "pss-screen",
"display": "Project Silver Screen"
}
}
],
"subject": {
"reference": "Patient/54321"
},
"reference": "Encounter/12345"
},
"authored": "2025-09-16T10:00:00+08:00",
"item": [
{
"linkId": "1",
{
"url": "https://fhir.synapxe.sg/StructureDefinition/ExtensionAssessmentItemType",
"system": "https://fhir.synapxe.sg/CodeSystem/assessment-item-type",
"code": "oral",
"display": "Oral Screening"
}
}
],
"item": [
{
"linkId": "1.1",
"text": "Are there any oral health issues?",
"answer": [
{
"system": "https://fhir.synapxe.sg/CodeSystem/assessment-answer-type",
"code": "N",
"display": "No"
}
}
]
}
]
},
{
"linkId": "2",
{
"url": "https://fhir.synapxe.sg/StructureDefinition/ExtensionAssessmentItemType",
"system": "https://fhir.synapxe.sg/CodeSystem/assessment-item-type",
"code": "vision",
"display": "Vision Screening"
}
}
],
"item": [
{
"linkId": "2.1",
"text": "Snellen Test Result",
"answer": [
{
"system": "http://loinc.org",
"code": "6-6",
"display": "6/6"
}
}
]
}
]
},
{
"linkId": "3",
{
"url": "https://fhir.synapxe.sg/StructureDefinition/ExtensionAssessmentItemType",
"system": "https://fhir.synapxe.sg/CodeSystem/assessment-item-type",
"code": "hearing",
"display": "Hearing Screening"
}
}
],
"item": [
{
"linkId": "3.1",
"text": "Is the participant wearing hearing aids?",
"answer": [
{
"system": "https://fhir.synapxe.sg/CodeSystem/assessment-answer-type",
"code": "no",
"display": "No"
}
}
]
},
{
"linkId": "3.3",
"text": "Proceed with hearing screening?",
"answer": [
{
"system": "https://fhir.synapxe.sg/CodeSystem/assessment-answer-type",
"code": "yes",
"display": "Yes"
}
}
]
},
{
"linkId": "3.4",
"text": "Visual Examination (Left Ear)",
"answer": [
{
"system": "https://fhir.synapxe.sg/CodeSystem/assessment-answer-type",
"code": "pass",
"display": "Pass"
}
}
]
},
{
"linkId": "3.5",
"text": "Pure Tone Test Result (Left Ear)",
"answer": [
{
"system": "http://loinc.org",
"code": "0-25",
"display": "0-25 dB"
}
}
]
}
]
}
]
}
{
"resourceType": "QuestionnaireResponse",
"questionnaire": "https://fhir.synapxe.sg/Questionnaire/pss-screen",
"status": "completed",
{
"system": "https://fhir.synapxe.sg/NamingSystem/questionnaireResponseId",
"value": "QR-00001"
}
],
{
"url": "https://fhir.synapxe.sg/StructureDefinition/ExtensionAssessmentType",
"system": "https://fhir.synapxe.sg/CodeSystem/assessment-type",
"code": "pss-screen",
"display": "Project Silver Screen"
}
}
],
"subject": {
"reference": "Patient/54321"
},
"reference": "Encounter/12345"
},
"authored": "2025-09-16T10:00:00+08:00",
"item": [
{
"linkId": "1.1",
{
"url": "https://fhir.synapxe.sg/StructureDefinition/ExtensionAssessmentItemType",
"system": "https://fhir.synapxe.sg/CodeSystem/assessment-item-type",
"code": "oral",
"display": "Oral Screening"
}
}
],
"text": "Are there any oral health issues?",
"answer": [
{
"system": "https://fhir.synapxe.sg/CodeSystem/assessment-answer-type",
"code": "no",
"display": "No"
}
}
]
},
{
"linkId": "2.1",
{
"url": "https://fhir.synapxe.sg/StructureDefinition/ExtensionAssessmentItemType",
"system": "https://fhir.synapxe.sg/CodeSystem/assessment-item-type",
"code": "vision",
"display": "Vision Screening"
}
},
{
"url": "https://fhir.synapxe.sg/StructureDefinition/ExtensionAssessmentItemType",
"system": "https://fhir.synapxe.sg/CodeSystem/test-type",
"code": "snellen-test-right-eye",
"display": "Snellen Test (Right Eye)"
}
}
],
"text": "Snellen Test Result",
"answer": [
{
"system": "http://loinc.org",
"code": "6-6",
"display": "6/6"
}
}
]
},
{
"linkId": "3.1",
{
"url": "https://fhir.synapxe.sg/StructureDefinition/ExtensionAssessmentItemType",
"system": "https://fhir.synapxe.sg/CodeSystem/assessment-item-type",
"code": "hearing",
"display": "Hearing Screening"
}
}
],
"text": "Is the participant wearing hearing aids?",
"answer": [
{
"system": "https://fhir.synapxe.sg/CodeSystem/assessment-answer-type",
"code": "no",
"display": "No"
}
}
]
},
{
"linkId": "3.3",
{
"url": "https://fhir.synapxe.sg/StructureDefinition/ExtensionAssessmentItemType",
"system": "https://fhir.synapxe.sg/CodeSystem/assessment-item-type",
"code": "hearing",
"display": "Hearing Screening"
}
}
],
"text": "Proceed with hearing screening?",
"answer": [
{
"system": "https://fhir.synapxe.sg/CodeSystem/assessment-answer-type",
"code": "yes",
"display": "Yes"
}
}
]
},
{
"linkId": "3.4",
{
"url": "https://fhir.synapxe.sg/StructureDefinition/ExtensionAssessmentItemType",
"system": "https://fhir.synapxe.sg/CodeSystem/assessment-item-type",
"code": "hearing",
"display": "Hearing Screening"
}
}
],
"text": "Visual Examination (Left Ear)",
"answer": [
{
"system": "https://fhir.synapxe.sg/CodeSystem/assessment-answer-type",
"code": "pass",
"display": "Pass"
}
}
]
},
{
"linkId": "3.5",
{
"url": "https://fhir.synapxe.sg/StructureDefinition/ExtensionAssessmentItemType",
"system": "https://fhir.synapxe.sg/CodeSystem/assessment-item-type",
"code": "hearing",
"display": "Hearing Screening"
}
},
{
"url": "https://fhir.synapxe.sg/StructureDefinition/ExtensionAssessmentItemType",
"system": "https://fhir.synapxe.sg/CodeSystem/test-type",
"code": "pure-tone-test-left-ear",
"display": "Pure Tone Test (Left Ear)"
}
}
],
"text": "Pure Tone Test Result (Left Ear)",
"answer": [
{
"system": "http://loinc.org",
"code": "0-25",
"display": "0-25 dB"
}
}
]
}
]
}

Terminologies

PathBinding StrengthValue Set (Code System)
QuestionnaireResponse.extension.value[x]requiredhttps://fhir.synapxe.sg/ValueSet/assessment-type
QuestionnaireResponse.item.extension.value[x]requiredhttps://fhir.synapxe.sg/ValueSet/assessment-item-type
QuestionnaireResponse.item.extension.value[x]requiredhttps://fhir.synapxe.sg/ValueSet/test-type
QuestionnaireResponse.item.answer.value[x]requiredhttps://fhir.synapxe.sg/CodeSystem/assessment-answer-type
QuestionnaireResponse.item.answer.value[x]requiredhttps://fhir.synapxe.sg/ValueSet/test-visual-code
QuestionnaireResponse.item.answer.value[x]requiredhttps://fhir.synapxe.sg/ValueSet/test-hearing-code
QuestionnaireResponse.item.answer.value[x]requiredhttps://fhir.synapxe.sg/ValueSet/placement-of-denture
QuestionnaireResponse.item.answer.value[x]requiredhttps://fhir.synapxe.sg/ValueSet/ohat-status

Questionnaire

idΣ0..1id
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
textC0..1Narrative
containedC0..*Resource
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
urlΣ C1..1uri
identifierΣ0..*Identifier
versionΣ1..1string
versionAlgorithmStringstring
versionAlgorithmCodingCoding
nameΣ C0..1string
titleΣ1..1string
derivedFromΣ0..*canonical(Questionnaire)
statusΣ ?! C1..1codeBinding
experimentalΣ0..1boolean
subjectTypeΣ0..0codeBinding
dateΣ0..0dateTime
publisherΣ0..0string
contactΣ0..0ContactDetail
descriptionΣ0..0markdown
useContextΣ0..0UsageContext
jurisdictionΣ0..0CodeableConceptBinding
purpose0..0markdown
copyright0..0markdown
copyrightLabel0..0string
approvalDate0..0date
lastReviewDate0..0date
id0..0id
extensionC0..0Extension
startΣ C1..1dateTime
endΣ C1..1dateTime
id0..0id
extensionC0..0Extension
systemΣ1..1uriFixed Value
versionΣ0..1string
codeΣ C1..1code
displayΣ C1..1string
userSelectedΣ0..0boolean
id0..0string
extensionC0..0Extension
modifierExtensionΣ ?! C0..0Extension
linkIdC1..1string
definition0..0uri
id0..0id
extensionC0..0Extension
systemΣ1..1uriFixed Value
versionΣ0..1string
codeΣ C1..1code
displayΣ C1..1string
userSelectedΣ0..0boolean
id0..0id
extensionC0..0Extension
systemΣ1..1uriFixed Value
versionΣ0..1string
codeΣ C1..1code
displayΣ C1..1string
userSelectedΣ0..0boolean
id0..0id
extensionC0..0Extension
systemΣ1..1uriFixed Value
versionΣ0..1string
codeΣ C1..1code
displayΣ C1..1string
userSelectedΣ0..0boolean
prefix0..0string
text0..1string
typeC1..1codeBinding
id0..0string
extensionC0..0Extension
modifierExtensionΣ ?! C0..0Extension
question1..1string
operatorC1..1codeBinding
answerCodingCoding
enableBehaviorC0..0codeBinding
disabledDisplay0..0codeBinding
requiredC0..0boolean
repeatsC0..0boolean
readOnlyC0..0boolean
maxLengthC0..0integer
answerConstraintC0..0codeBinding
answerValueSetC0..0canonical(ValueSet)
id0..1string
extensionC0..0Extension
modifierExtensionΣ ?! C0..0Extension
valueStringstring
valueCodingCoding
initialSelected0..1boolean
id0..0string
extensionC0..0Extension
modifierExtensionΣ ?! C0..0Extension
id0..0id
extensionC0..0Extension
systemΣ1..1uriFixed Value
versionΣ0..1string
codeΣ C1..1code
displayΣ C1..1string
userSelectedΣ0..0boolean
initialSelected0..0boolean
id0..0string
extensionC0..0Extension
modifierExtensionΣ ?! C0..0Extension
id0..0id
extensionC0..0Extension
systemΣ1..1uriFixed Value
versionΣ0..1string
codeΣ C1..1code
displayΣ C1..1string
userSelectedΣ0..0boolean
initialSelected0..0boolean
id0..0string
extensionC0..0Extension
modifierExtensionΣ ?! C0..0Extension
id0..0id
extensionC0..0Extension
systemΣ1..1uriFixed Value
versionΣ0..1string
codeΣ C1..1code
displayΣ C1..1string
userSelectedΣ0..0boolean
initialSelected0..0boolean
id0..0string
extensionC0..0Extension
modifierExtensionΣ ?! C0..0Extension
id0..0id
extensionC0..0Extension
systemΣ1..1uriFixed Value
versionΣ0..1string
codeΣ C1..1code
displayΣ C1..1string
userSelectedΣ0..0boolean
initialSelected0..0boolean
id0..0string
extensionC0..0Extension
modifierExtensionΣ ?! C0..0Extension
id0..0id
extensionC0..0Extension
systemΣ1..1uriFixed Value
versionΣ0..1string
codeΣ C1..1code
displayΣ C1..1string
userSelectedΣ0..0boolean
initialSelected0..0boolean
id0..1string
extensionC0..0Extension
modifierExtensionΣ ?! C0..0Extension
id0..1id
extensionC0..*Extension
systemΣ1..1uriFixed Value
versionΣ0..1string
codeΣ C1..1code
displayΣ C1..1string
userSelectedΣ0..0boolean
initialSelected0..0boolean
item0..*see (item)
{
"resourceType": "Questionnaire",
"url": "https://fhir.synapxe.sg/Questionnaire/pss-screen",
"version": "1.0.0",
"title": "Project Silver Screen Assessment",
"status": "active",
"start": "2025-09-16",
"end": "2025-12-31"
},
"code": [
{
"system": "https://fhir.synapxe.sg/CodeSystem/assessment-type",
"code": "pss-screen",
"display": "Project Silver Screen"
}
],
"item": [
{
"linkId": "1",
"type": "group",
"code": [
{
"system": "https://fhir.synapxe.sg/CodeSystem/assessment-item-type",
"code": "oral",
"display": "Oral Screening"
}
],
"item": [
{
"linkId": "1.1",
"text": "Is the participant currently wearing dentures or has dentures?",
"type": "choice",
{
"system": "https://fhir.synapxe.sg/CodeSystem/assessment-answer-type",
"code": "yes",
"display": "Yes"
}
},
{
"system": "https://fhir.synapxe.sg/CodeSystem/assessment-answer-type",
"code": "no",
"display": "No"
}
}
]
}
]
},
{
"linkId": "2",
"type": "group",
"code": [
{
"system": "https://fhir.synapxe.sg/CodeSystem/assessment-item-type",
"code": "vision",
"display": "Vision Screening"
}
],
"item": [
{
"linkId": "2.1",
"text": "Snellen Test Result",
"type": "choice",
"code": [
{
"system": "http://loinc.org",
"code": "29271-4",
"display": "Visual acuity left eye"
}
],
{
"system": "http://loinc.org",
"code": "6-6",
"display": "6/6"
}
},
{
"system": "http://loinc.org",
"code": "6-12",
"display": "6/12"
}
}
]
}
]
},
{
"linkId": "3",
"type": "group",
"code": [
{
"system": "https://fhir.synapxe.sg/CodeSystem/assessment-item-type",
"code": "hearing",
"display": "Hearing Screening"
}
],
"item": [
{
"linkId": "3.1",
"text": "Is the participant wearing hearing aids?",
"type": "choice",
{
"system": "https://fhir.synapxe.sg/CodeSystem/assessment-answer-type",
"code": "yes",
"display": "Yes"
}
},
{
"system": "https://fhir.synapxe.sg/CodeSystem/assessment-answer-type",
"code": "no",
"display": "No"
}
}
]
},
{
"linkId": "3.2",
"text": "Does the participant need to change the hearing aids?",
"type": "choice",
{
"system": "https://fhir.synapxe.sg/CodeSystem/assessment-answer-type",
"code": "yes",
"display": "Yes"
}
},
{
"system": "https://fhir.synapxe.sg/CodeSystem/assessment-answer-type",
"code": "no",
"display": "No"
}
}
],
{
"question": "3.1",
"operator": "=",
"system": "https://fhir.synapxe.sg/CodeSystem/assessment-answer-type",
"code": "yes",
"display": "Yes"
}
}
]
},
{
"linkId": "3.3",
"text": "Proceed with hearing screening?",
"type": "choice",
{
"system": "https://fhir.synapxe.sg/CodeSystem/assessment-answer-type",
"code": "yes",
"display": "Yes"
}
},
{
"system": "https://fhir.synapxe.sg/CodeSystem/assessment-answer-type",
"code": "no",
"display": "No"
}
}
],
{
"question": "3.1",
"operator": "=",
"system": "https://fhir.synapxe.sg/CodeSystem/assessment-answer-type",
"code": "no",
"display": "No"
}
}
]
},
{
"linkId": "3.4",
"text": "Visual Examination (Left Ear)",
"type": "choice",
{
"system": "https://fhir.synapxe.sg/CodeSystem/assessment-answer-type",
"code": "pass",
"display": "Pass"
}
},
{
"system": "https://fhir.synapxe.sg/CodeSystem/assessment-answer-type",
"code": "refer",
"display": "Refer"
}
}
],
{
"question": "3.3",
"operator": "=",
"system": "https://fhir.synapxe.sg/CodeSystem/assessment-answer-type",
"code": "yes",
"display": "Yes"
}
}
]
},
{
"linkId": "3.5",
"text": "Pure Tone Test Result (Left Ear)",
"type": "choice",
"code": [
{
"system": "http://loinc.org",
"code": "91375-6",
"display": "Hearing threshold 250 Hz Ear-L"
}
],
{
"system": "http://loinc.org",
"code": "0-25",
"display": "0-25 dB"
}
},
{
"system": "http://loinc.org",
"code": ">25",
"display": ">25 dB"
}
}
],
{
"question": "3.3",
"operator": "=",
"system": "https://fhir.synapxe.sg/CodeSystem/assessment-answer-type",
"code": "yes",
"display": "Yes"
}
}
]
}
]
}
]
}

Terminologies

PathBinding StrengthValue Set (Code System)Description
Questionnaire.coderequiredhttps://fhir.synapxe.sg/ValueSet/assessment-type
Questionnaire.item.coderequiredhttps://fhir.synapxe.sg/ValueSet/assessment-item-type
Questionnaire.item.coderequiredhttps://fhir.synapxe.sg/CodeSystem/assessment-item-type
Questionnaire.item.coderequiredhttps://fhir.synapxe.sg/ValueSet/test-type

observation codes for tests like Snellen, Pinhole, etc

Questionnaire.item.answerOption.value[x]requiredhttps://fhir.synapxe.sg/ValueSet/assessment-answer-yesno
Questionnaire.item.answerOption.value[x]requiredhttps://fhir.synapxe.sg/ValueSet/test-visual-code
Questionnaire.item.answerOption.value[x]requiredhttps://fhir.synapxe.sg/ValueSet/test-hearing-code
Questionnaire.item.answerOption.value[x]requiredhttps://fhir.synapxe.sg/ValueSet/assessment-answer-passrefer
Questionnaire.item.answerOption.value[x]requiredhttps://fhir.synapxe.sg/ValueSet/placement-of-denture
Questionnaire.item.answerOption.value[x]requiredhttps://fhir.synapxe.sg/ValueSet/ohat-status