OpenCRVS · JSON-LD Context

Opencrvs Org Context

JSON-LD context defining the semantic vocabulary for Opencrvs Org from OpenCRVS.

120 Classes 93 Properties 4 Namespaces

View Context View on GitHub

Namespaces

schema: https://schema.org/

xsd: http://www.w3.org/2001/XMLSchema#

dcterms: http://purl.org/dc/terms/

opencrvs: https://opencrvs.org/schema#

Classes

EventDocument CreatedAction RejectAction DuplicateDetectedAction MarkNotDuplicateAction MarkAsDuplicateAction ArchiveAction NotifiedAction RegisterAction DeclareAction AssignedAction RequestedCorrectionAction ApprovedCorrectionAction RejectedCorrectionAction UnassignedAction PrintCertificateAction ReadAction EditAction CustomAction EventConfig TranslationConfig SummaryConfig ReadActionConfig ActionFlagConfig FieldGroup ValidationConfig Address TextField NumberField NumberWithUnitField TextAreaField AgeField DateField TimeField DateRangeField SelectDateRangeField ImageViewField Paragraph Heading RadioGroup BulletList PageHeader Select NameField PhoneField IdField Checkbox File Country AdministrativeAreaField Divider LocationInput SignatureField EmailField FileUploadWithOptions DataField ButtonField AlphaPrintButton HttpField AutocompleteField LinkButtonField VerificationStatus QrReaderField IdReaderField QueryParamReaderField LoaderField SearchField QueryType QueryExpression AnyOfStatus ExactStatus ExactDate RangeDate TimePeriod Within AnyOf Exact ExactUserType ContainsFlags Fuzzy Range CustomField HiddenField UserRoleField DeclareActionConfig DeduplicationConfig RejectActionConfig RegisterActionConfig PrintCertificateActionConfig VerificationActionConfig RequestCorrectionActionConfig EditActionConfig ArchiveActionConfig CustomActionConfig DeclarationFormConfig AdvancedSearchConfig FlagConfig EventDocumentOutput CreatedActionOutput RejectActionOutput DuplicateDetectedActionOutput MarkNotDuplicateActionOutput MarkAsDuplicateActionOutput ArchiveActionOutput NotifiedActionOutput RegisterActionOutput DeclareActionOutput AssignedActionOutput RequestedCorrectionActionOutput ApprovedCorrectionActionOutput RejectedCorrectionActionOutput UnassignedActionOutput PrintCertificateActionOutput ReadActionOutput EditActionOutput CustomActionOutput WorkqueueColumn error.BAD_REQUEST error.UNAUTHORIZED error.FORBIDDEN

Properties

Property	Type	Container
id	string
type	string
createdAt	dateTime
updatedAt	dateTime
actions		list
trackingId	string
transactionId	string
createdByUserType	string
createdBy	string
createdByRole	string
createdBySignature
createdAtLocation
declaration
annotation
status	string
originalActionId
content
registrationNumber	string
assignedTo	string
requestId	string
customActionType	string
dateOfEvent
placeOfEvent
title	reference
fallbackTitle	reference
summary	reference
label	reference
actionOrder		list
advancedSearch		list
flags		list
analytics	boolean
defaultMessage	string
description	string
fields		list
supportingCopy	reference
icon	string
conditionals
review
operation	string
conditional	reference
parent
required
secured	boolean
placeholder	reference
validation		list
helperText	reference
hideLabel	boolean
uncorrectable	boolean
value
validator	reference
message	reference
configuration
defaultValue
options		list
items		list
noOptionsMessage	reference
optionOverrides		list
signaturePromptLabel	reference
methods		list
variant	string
clauses		list
eventType	string
legalStatuses.DECLARED.createdAtLocation
legalStatuses.DECLARED.createdByRole	reference
legalStatuses.REGISTERED.acceptedAt	reference
legalStatuses.REGISTERED.createdAtLocation
legalStatuses.REGISTERED.createdByRole	reference
legalStatuses.REGISTERED.registrationNumber	reference
updatedAtLocation
updatedByUserRole	reference
updatedBy	reference
data	reference
terms		list
term	string
gte
lte
location	string
anyOf		list
noneOf		list
src	string
deduplication	reference
dialogCopy
query	reference
printForm
verify
cancel
correctionForm
form		list
auditHistoryLabel	reference
pages		list
requiresAction	boolean
code	string
issues		list

JSON-LD Document

{
  "@context": {
    "@vocab": "https://opencrvs.org/schema#",
    "schema": "https://schema.org/",
    "xsd": "http://www.w3.org/2001/XMLSchema#",
    "dcterms": "http://purl.org/dc/terms/",
    "opencrvs": "https://opencrvs.org/schema#",
    "EventDocument": "opencrvs:EventDocument",
    "id": {
      "@id": "opencrvs:id",
      "@type": "xsd:string"
    },
    "type": {
      "@id": "opencrvs:type",
      "@type": "xsd:string"
    },
    "createdAt": {
      "@id": "opencrvs:createdAt",
      "@type": "xsd:dateTime"
    },
    "updatedAt": {
      "@id": "opencrvs:updatedAt",
      "@type": "xsd:dateTime"
    },
    "actions": {
      "@id": "opencrvs:actions",
      "@container": "@list"
    },
    "trackingId": {
      "@id": "opencrvs:trackingId",
      "@type": "xsd:string"
    },
    "CreatedAction": "opencrvs:CreatedAction",
    "transactionId": {
      "@id": "opencrvs:transactionId",
      "@type": "xsd:string"
    },
    "createdByUserType": {
      "@id": "opencrvs:createdByUserType",
      "@type": "xsd:string"
    },
    "createdBy": {
      "@id": "opencrvs:createdBy",
      "@type": "xsd:string"
    },
    "createdByRole": {
      "@id": "opencrvs:createdByRole",
      "@type": "xsd:string"
    },
    "createdBySignature": {
      "@id": "opencrvs:createdBySignature"
    },
    "createdAtLocation": {
      "@id": "opencrvs:createdAtLocation"
    },
    "declaration": {
      "@id": "opencrvs:declaration"
    },
    "annotation": {
      "@id": "opencrvs:annotation"
    },
    "status": {
      "@id": "opencrvs:status",
      "@type": "xsd:string"
    },
    "originalActionId": {
      "@id": "opencrvs:originalActionId"
    },
    "RejectAction": "opencrvs:RejectAction",
    "content": {
      "@id": "opencrvs:content"
    },
    "DuplicateDetectedAction": "opencrvs:DuplicateDetectedAction",
    "MarkNotDuplicateAction": "opencrvs:MarkNotDuplicateAction",
    "MarkAsDuplicateAction": "opencrvs:MarkAsDuplicateAction",
    "ArchiveAction": "opencrvs:ArchiveAction",
    "NotifiedAction": "opencrvs:NotifiedAction",
    "RegisterAction": "opencrvs:RegisterAction",
    "registrationNumber": {
      "@id": "opencrvs:registrationNumber",
      "@type": "xsd:string"
    },
    "DeclareAction": "opencrvs:DeclareAction",
    "AssignedAction": "opencrvs:AssignedAction",
    "assignedTo": {
      "@id": "opencrvs:assignedTo",
      "@type": "xsd:string"
    },
    "RequestedCorrectionAction": "opencrvs:RequestedCorrectionAction",
    "ApprovedCorrectionAction": "opencrvs:ApprovedCorrectionAction",
    "requestId": {
      "@id": "opencrvs:requestId",
      "@type": "xsd:string"
    },
    "RejectedCorrectionAction": "opencrvs:RejectedCorrectionAction",
    "UnassignedAction": "opencrvs:UnassignedAction",
    "PrintCertificateAction": "opencrvs:PrintCertificateAction",
    "ReadAction": "opencrvs:ReadAction",
    "EditAction": "opencrvs:EditAction",
    "CustomAction": "opencrvs:CustomAction",
    "customActionType": {
      "@id": "opencrvs:customActionType",
      "@type": "xsd:string"
    },
    "EventConfig": "opencrvs:EventConfig",
    "dateOfEvent": {
      "@id": "opencrvs:dateOfEvent"
    },
    "placeOfEvent": {
      "@id": "opencrvs:placeOfEvent"
    },
    "title": {
      "@id": "opencrvs:title",
      "@type": "@id"
    },
    "fallbackTitle": {
      "@id": "opencrvs:fallbackTitle",
      "@type": "@id"
    },
    "summary": {
      "@id": "opencrvs:summary",
      "@type": "@id"
    },
    "label": {
      "@id": "opencrvs:label",
      "@type": "@id"
    },
    "actionOrder": {
      "@id": "opencrvs:actionOrder",
      "@container": "@list"
    },
    "advancedSearch": {
      "@id": "opencrvs:advancedSearch",
      "@container": "@list"
    },
    "flags": {
      "@id": "opencrvs:flags",
      "@container": "@list"
    },
    "analytics": {
      "@id": "opencrvs:analytics",
      "@type": "xsd:boolean"
    },
    "TranslationConfig": "opencrvs:TranslationConfig",
    "defaultMessage": {
      "@id": "opencrvs:defaultMessage",
      "@type": "xsd:string"
    },
    "description": {
      "@id": "opencrvs:description",
      "@type": "xsd:string"
    },
    "SummaryConfig": "opencrvs:SummaryConfig",
    "fields": {
      "@id": "opencrvs:fields",
      "@container": "@list"
    },
    "ReadActionConfig": "opencrvs:ReadActionConfig",
    "supportingCopy": {
      "@id": "opencrvs:supportingCopy",
      "@type": "@id"
    },
    "icon": {
      "@id": "opencrvs:icon",
      "@type": "xsd:string"
    },
    "conditionals": {
      "@id": "opencrvs:conditionals"
    },
    "review": {
      "@id": "opencrvs:review"
    },
    "ActionFlagConfig": "opencrvs:ActionFlagConfig",
    "operation": {
      "@id": "opencrvs:operation",
      "@type": "xsd:string"
    },
    "conditional": {
      "@id": "opencrvs:conditional",
      "@type": "@id"
    },
    "FieldGroup": "opencrvs:FieldGroup",
    "parent": {
      "@id": "opencrvs:parent"
    },
    "required": {
      "@id": "opencrvs:required"
    },
    "secured": {
      "@id": "opencrvs:secured",
      "@type": "xsd:boolean"
    },
    "placeholder": {
      "@id": "opencrvs:placeholder",
      "@type": "@id"
    },
    "validation": {
      "@id": "opencrvs:validation",
      "@container": "@list"
    },
    "helperText": {
      "@id": "opencrvs:helperText",
      "@type": "@id"
    },
    "hideLabel": {
      "@id": "opencrvs:hideLabel",
      "@type": "xsd:boolean"
    },
    "uncorrectable": {
      "@id": "opencrvs:uncorrectable",
      "@type": "xsd:boolean"
    },
    "value": {
      "@id": "opencrvs:value"
    },
    "ValidationConfig": "opencrvs:ValidationConfig",
    "validator": {
      "@id": "opencrvs:validator",
      "@type": "@id"
    },
    "message": {
      "@id": "opencrvs:message",
      "@type": "@id"
    },
    "Address": "opencrvs:Address",
    "configuration": {
      "@id": "opencrvs:configuration"
    },
    "defaultValue": {
      "@id": "opencrvs:defaultValue"
    },
    "TextField": "opencrvs:TextField",
    "NumberField": "opencrvs:NumberField",
    "NumberWithUnitField": "opencrvs:NumberWithUnitField",
    "options": {
      "@id": "opencrvs:options",
      "@container": "@list"
    },
    "TextAreaField": "opencrvs:TextAreaField",
    "AgeField": "opencrvs:AgeField",
    "DateField": "opencrvs:DateField",
    "TimeField": "opencrvs:TimeField",
    "DateRangeField": "opencrvs:DateRangeField",
    "SelectDateRangeField": "opencrvs:SelectDateRangeField",
    "ImageViewField": "opencrvs:ImageViewField",
    "Paragraph": "opencrvs:Paragraph",
    "Heading": "opencrvs:Heading",
    "RadioGroup": "opencrvs:RadioGroup",
    "BulletList": "opencrvs:BulletList",
    "items": {
      "@id": "opencrvs:items",
      "@container": "@list"
    },
    "PageHeader": "opencrvs:PageHeader",
    "Select": "opencrvs:Select",
    "noOptionsMessage": {
      "@id": "opencrvs:noOptionsMessage",
      "@type": "@id"
    },
    "NameField": "opencrvs:NameField",
    "PhoneField": "opencrvs:PhoneField",
    "IdField": "opencrvs:IdField",
    "Checkbox": "opencrvs:Checkbox",
    "File": "opencrvs:File",
    "Country": "opencrvs:Country",
    "optionOverrides": {
      "@id": "opencrvs:optionOverrides",
      "@container": "@list"
    },
    "AdministrativeAreaField": "opencrvs:AdministrativeAreaField",
    "Divider": "opencrvs:Divider",
    "LocationInput": "opencrvs:LocationInput",
    "SignatureField": "opencrvs:SignatureField",
    "signaturePromptLabel": {
      "@id": "opencrvs:signaturePromptLabel",
      "@type": "@id"
    },
    "EmailField": "opencrvs:EmailField",
    "FileUploadWithOptions": "opencrvs:FileUploadWithOptions",
    "DataField": "opencrvs:DataField",
    "ButtonField": "opencrvs:ButtonField",
    "AlphaPrintButton": "opencrvs:AlphaPrintButton",
    "HttpField": "opencrvs:HttpField",
    "AutocompleteField": "opencrvs:AutocompleteField",
    "LinkButtonField": "opencrvs:LinkButtonField",
    "VerificationStatus": "opencrvs:VerificationStatus",
    "QrReaderField": "opencrvs:QrReaderField",
    "IdReaderField": "opencrvs:IdReaderField",
    "methods": {
      "@id": "opencrvs:methods",
      "@container": "@list"
    },
    "QueryParamReaderField": "opencrvs:QueryParamReaderField",
    "LoaderField": "opencrvs:LoaderField",
    "variant": {
      "@id": "opencrvs:variant",
      "@type": "xsd:string"
    },
    "SearchField": "opencrvs:SearchField",
    "QueryType": "opencrvs:QueryType",
    "clauses": {
      "@id": "opencrvs:clauses",
      "@container": "@list"
    },
    "QueryExpression": "opencrvs:QueryExpression",
    "eventType": {
      "@id": "opencrvs:eventType",
      "@type": "xsd:string"
    },
    "legalStatuses.DECLARED.createdAtLocation": {
      "@id": "opencrvs:legalStatuses.DECLARED.createdAtLocation"
    },
    "legalStatuses.DECLARED.createdByRole": {
      "@id": "opencrvs:legalStatuses.DECLARED.createdByRole",
      "@type": "@id"
    },
    "legalStatuses.REGISTERED.acceptedAt": {
      "@id": "opencrvs:legalStatuses.REGISTERED.acceptedAt",
      "@type": "@id"
    },
    "legalStatuses.REGISTERED.createdAtLocation": {
      "@id": "opencrvs:legalStatuses.REGISTERED.createdAtLocation"
    },
    "legalStatuses.REGISTERED.createdByRole": {
      "@id": "opencrvs:legalStatuses.REGISTERED.createdByRole",
      "@type": "@id"
    },
    "legalStatuses.REGISTERED.registrationNumber": {
      "@id": "opencrvs:legalStatuses.REGISTERED.registrationNumber",
      "@type": "@id"
    },
    "updatedAtLocation": {
      "@id": "opencrvs:updatedAtLocation"
    },
    "updatedByUserRole": {
      "@id": "opencrvs:updatedByUserRole",
      "@type": "@id"
    },
    "updatedBy": {
      "@id": "opencrvs:updatedBy",
      "@type": "@id"
    },
    "data": {
      "@id": "opencrvs:data",
      "@type": "@id"
    },
    "AnyOfStatus": "opencrvs:AnyOfStatus",
    "terms": {
      "@id": "opencrvs:terms",
      "@container": "@list"
    },
    "ExactStatus": "opencrvs:ExactStatus",
    "term": {
      "@id": "opencrvs:term",
      "@type": "xsd:string"
    },
    "ExactDate": "opencrvs:ExactDate",
    "RangeDate": "opencrvs:RangeDate",
    "gte": {
      "@id": "opencrvs:gte"
    },
    "lte": {
      "@id": "opencrvs:lte"
    },
    "TimePeriod": "opencrvs:TimePeriod",
    "Within": "opencrvs:Within",
    "location": {
      "@id": "opencrvs:location",
      "@type": "xsd:string"
    },
    "AnyOf": "opencrvs:AnyOf",
    "Exact": "opencrvs:Exact",
    "ExactUserType": "opencrvs:ExactUserType",
    "ContainsFlags": "opencrvs:ContainsFlags",
    "anyOf": {
      "@id": "opencrvs:anyOf",
      "@container": "@list"
    },
    "noneOf": {
      "@id": "opencrvs:noneOf",
      "@container": "@list"
    },
    "Fuzzy": "opencrvs:Fuzzy",
    "Range": "opencrvs:Range",
    "CustomField": "opencrvs:CustomField",
    "src": {
      "@id": "opencrvs:src",
      "@type": "xsd:string"
    },
    "HiddenField": "opencrvs:HiddenField",
    "UserRoleField": "opencrvs:UserRoleField",
    "DeclareActionConfig": "opencrvs:DeclareActionConfig",
    "deduplication": {
      "@id": "opencrvs:deduplication",
      "@type": "@id"
    },
    "dialogCopy": {
      "@id": "opencrvs:dialogCopy"
    },
    "DeduplicationConfig": "opencrvs:DeduplicationConfig",
    "query": {
      "@id": "opencrvs:query",
      "@type": "@id"
    },
    "RejectActionConfig": "opencrvs:RejectActionConfig",
    "RegisterActionConfig": "opencrvs:RegisterActionConfig",
    "PrintCertificateActionConfig": "opencrvs:PrintCertificateActionConfig",
    "printForm": {
      "@id": "opencrvs:printForm"
    },
    "VerificationActionConfig": "opencrvs:VerificationActionConfig",
    "verify": {
      "@id": "opencrvs:verify"
    },
    "cancel": {
      "@id": "opencrvs:cancel"
    },
    "RequestCorrectionActionConfig": "opencrvs:RequestCorrectionActionConfig",
    "correctionForm": {
      "@id": "opencrvs:correctionForm"
    },
    "EditActionConfig": "opencrvs:EditActionConfig",
    "ArchiveActionConfig": "opencrvs:ArchiveActionConfig",
    "CustomActionConfig": "opencrvs:CustomActionConfig",
    "form": {
      "@id": "opencrvs:form",
      "@container": "@list"
    },
    "auditHistoryLabel": {
      "@id": "opencrvs:auditHistoryLabel",
      "@type": "@id"
    },
    "DeclarationFormConfig": "opencrvs:DeclarationFormConfig",
    "pages": {
      "@id": "opencrvs:pages",
      "@container": "@list"
    },
    "AdvancedSearchConfig": "opencrvs:AdvancedSearchConfig",
    "FlagConfig": "opencrvs:FlagConfig",
    "requiresAction": {
      "@id": "opencrvs:requiresAction",
      "@type": "xsd:boolean"
    },
    "EventDocumentOutput": "opencrvs:EventDocumentOutput",
    "CreatedActionOutput": "opencrvs:CreatedActionOutput",
    "RejectActionOutput": "opencrvs:RejectActionOutput",
    "DuplicateDetectedActionOutput": "opencrvs:DuplicateDetectedActionOutput",
    "MarkNotDuplicateActionOutput": "opencrvs:MarkNotDuplicateActionOutput",
    "MarkAsDuplicateActionOutput": "opencrvs:MarkAsDuplicateActionOutput",
    "ArchiveActionOutput": "opencrvs:ArchiveActionOutput",
    "NotifiedActionOutput": "opencrvs:NotifiedActionOutput",
    "RegisterActionOutput": "opencrvs:RegisterActionOutput",
    "DeclareActionOutput": "opencrvs:DeclareActionOutput",
    "AssignedActionOutput": "opencrvs:AssignedActionOutput",
    "RequestedCorrectionActionOutput": "opencrvs:RequestedCorrectionActionOutput",
    "ApprovedCorrectionActionOutput": "opencrvs:ApprovedCorrectionActionOutput",
    "RejectedCorrectionActionOutput": "opencrvs:RejectedCorrectionActionOutput",
    "UnassignedActionOutput": "opencrvs:UnassignedActionOutput",
    "PrintCertificateActionOutput": "opencrvs:PrintCertificateActionOutput",
    "ReadActionOutput": "opencrvs:ReadActionOutput",
    "EditActionOutput": "opencrvs:EditActionOutput",
    "CustomActionOutput": "opencrvs:CustomActionOutput",
    "WorkqueueColumn": "opencrvs:WorkqueueColumn",
    "error.BAD_REQUEST": "opencrvs:error.BAD_REQUEST",
    "code": {
      "@id": "opencrvs:code",
      "@type": "xsd:string"
    },
    "issues": {
      "@id": "opencrvs:issues",
      "@container": "@list"
    },
    "error.UNAUTHORIZED": "opencrvs:error.UNAUTHORIZED",
    "error.FORBIDDEN": "opencrvs:error.FORBIDDEN"
  },
  "@type": "schema:Dataset",
  "schema:name": "OpenCRVS API JSON-LD context",
  "schema:description": "A JSON-LD @context for the objects OpenCRVS's own API contract declares: one class per component schema, one property per declared field, typed from the contract. Derived by script (derive-json-ld.py, 2026-11-09) from openapi/countryconfig-openapi.yml, openapi/events-openapi.yml.",
  "dcterms:created": "2026-11-09",
  "dcterms:source": [
    "openapi/countryconfig-openapi.yml",
    "openapi/events-openapi.yml"
  ]
}