Skip to main content

Profile Annotation Policy

Terminology​

For terms not explained in this document, please see Terminology.

  • Profile Annotation (PA)
  • Profile Annotation Policy

Profile Annotation Policy Data Model​

Property​

Profile Annotation Policy Properties​

NameTypeDescription
idstringREQUIRED. Specify the ID of the Profile Annotation Policy in URI format.
typestringREQUIRED. It MUST be ProfileAnnotationPolicy.
namestringREQUIRED. The name of the Profile Annotation Policy.
descriptionstringOPTIONAL. The description of the Profile Annotation Policy.
refstringRECOMMENDED. The URL of a human-readable page for details about the Profile Annotation Policy.

Appendix​

Example​

This is non-normative.

Below is an example of Profile Annotation Policy.

{
  "id": "urn:uuid:14270f8f-9f1c-4f89-9fa4-8c93767a8404",
  "type": "ProfileAnnotationPolicy",
  "name": "<Profile Annotation Policy Name>",
  "description": "<Description of Profile Annotation Policy>",
  "ref": "https://annotation.example.org/about"
}