FieldMetadata

Specifies FHIR paths to match, and how to handle de-identification of matching fields.

HealthcareFHIRHL7v2DICOMMedical ImagingDe-identificationInteroperabilityCloud

Properties

Name	Type	Description
action	string	Deidentify action for one field.
paths	array	List of paths to FHIR fields to be redacted. Each path is a period-separated list where each component is either a field name or FHIR type name, for example: Patient, HumanName. For "choice" types (th

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "FieldMetadata",
  "description": "Specifies FHIR paths to match, and how to handle de-identification of matching fields.",
  "properties": {
    "action": {
      "description": "Deidentify action for one field.",
      "enum": [
        "ACTION_UNSPECIFIED",
        "TRANSFORM",
        "INSPECT_AND_TRANSFORM",
        "DO_NOT_TRANSFORM"
      ],
      "type": "string"
    },
    "paths": {
      "description": "List of paths to FHIR fields to be redacted. Each path is a period-separated list where each component is either a field name or FHIR type name, for example: Patient, HumanName. For \"choice\" types (those defined in the FHIR spec with the form: field[x]) we use two separate components. For example, \"deceasedAge.unit\" is matched by \"Deceased.Age.unit\". Supported types are: AdministrativeGenderCode, Base64Binary, Boolean, Code, Date, DateTime, Decimal, HumanName, Id, Instant, Integer, LanguageCode, Markdown, Oid, PositiveInt, String, UnsignedInt, Uri, Uuid, Xhtml.",
      "items": {
        "type": "string"
      },
      "type": "array"
    }
  },
  "type": "object"
}