FOLDER

A FOLDER resource

  • archetype_node_id
    Type: string
    required
  • name
    required
    • _type
      Discriminator
      enum
      const:  
      DV_TEXT
      required
      values
      • DV_TEXT
    • value
      Type: string
      required
    • encoding
      Type: object · CODE_PHRASE
    • formatting
      Type: string
    • hyperlink
      • _type
        Discriminator
        enum
        const:  
        DV_URI
        required
        values
        • DV_URI
      • value
        Type: string
        required
    • language
      Type: object · CODE_PHRASE
    • mappings
      Type: array object[] · TERM_MAPPING[]
  • _type
    Type: string
  • archetype_details
    Type: object · ARCHETYPED
    • archetype_id
      Type: object · ARCHETYPE_ID
      required
    • rm_version
      Type: string
      required
    • template_id
      Type: object · TEMPLATE_ID
  • details
    • _type
      Discriminator
      Type: string
    • archetype_node_id
      Type: string
      required
    • item
      Type: object · ELEMENT
      required
    • name
      required
      • _type
        Discriminator
        enum
        const:  
        DV_TEXT
        required
        values
        • DV_TEXT
      • value
        Type: string
        required
      • encoding
        Type: object · CODE_PHRASE
      • formatting
        Type: string
      • hyperlink
      • language
        Type: object · CODE_PHRASE
      • mappings
        Type: array object[] · TERM_MAPPING[]
    • archetype_details
      Type: object · ARCHETYPED
    • feeder_audit
      Type: object · FEEDER_AUDIT
    • links
      Type: array object[] · LINK[]
    • uid
      • _type
        Discriminator
        enum
        const:  
        HIER_OBJECT_ID
        required
        values
        • HIER_OBJECT_ID
      • value
        Type: stringFormat: uuid
        required
  • feeder_audit
    Type: object · FEEDER_AUDIT
    • originating_system_audit
      Type: object · FEEDER_AUDIT_DETAILS
      required
    • feeder_system_audit
      Type: object · FEEDER_AUDIT_DETAILS
    • feeder_system_item_ids
      Type: array object[] · DV_IDENTIFIER[]

      Type for representing identifiers of real-world entities. Typical identifiers include drivers licence number, social security number, veterans affairs number, prescription id, order id, and so on.

      DV_IDENTIFIER is used to represent any identifier of a real thing, issued by some authority or agency.

    • original_content
      • _type
        Discriminator
        enum
        const:  
        DV_MULTIMEDIA
        required
        values
        • DV_MULTIMEDIA
      • media_type
        Type: object · CODE_PHRASE
        required
      • size
        Type: integer
        required

        Integer numbers.

      • alternate_text
        Type: string
      • charset
        Type: object · CODE_PHRASE
      • compression_algorithm
        Type: object · CODE_PHRASE
      • data
        Type: string
      • integrity_check
        Type: string
      • integrity_check_algorithm
        Type: object · CODE_PHRASE
      • language
        Type: object · CODE_PHRASE
      • thumbnail
        Type: object · DV_MULTIMEDIA
      • uri
    • originating_system_item_ids
      Type: array object[] · DV_IDENTIFIER[]

      Type for representing identifiers of real-world entities. Typical identifiers include drivers licence number, social security number, veterans affairs number, prescription id, order id, and so on.

      DV_IDENTIFIER is used to represent any identifier of a real thing, issued by some authority or agency.

  • folders
    Type: array object[] · FOLDER[]

    A FOLDER resource

    • archetype_node_id
      Type: string
      required
    • name
      required
      • _type
        Discriminator
        enum
        const:  
        DV_TEXT
        required
        values
        • DV_TEXT
      • value
        Type: string
        required
      • encoding
        Type: object · CODE_PHRASE
      • formatting
        Type: string
      • hyperlink
      • language
        Type: object · CODE_PHRASE
      • mappings
        Type: array object[] · TERM_MAPPING[]
    • _type
      Type: string
    • archetype_details
      Type: object · ARCHETYPED
    • details
      • _type
        Discriminator
        Type: string
      • archetype_node_id
        Type: string
        required
      • item
        Type: object · ELEMENT
        required
      • name
        required
      • archetype_details
        Type: object · ARCHETYPED
      • feeder_audit
        Type: object · FEEDER_AUDIT
      • links
        Type: array object[] · LINK[]
      • uid
    • feeder_audit
      Type: object · FEEDER_AUDIT
    • folders
      Type: array object[] · FOLDER[]

      A FOLDER resource

    • items
      Type: array object[] · OBJECT_REF[]
    • links
      Type: array object[] · LINK[]
    • uid
      • _type
        Discriminator
        enum
        const:  
        HIER_OBJECT_ID
        required
        values
        • HIER_OBJECT_ID
      • value
        Type: stringFormat: uuid
        required
  • items
    Type: array object[] · OBJECT_REF[]
    • id
      required
      • _type
        Discriminator
        enum
        const:  
        ARCHETYPE_ID
        required
        values
        • ARCHETYPE_ID
      • value
        Type: string
        required
    • namespace
      Type: string
      required
    • type
      Type: string
      required
  • links
    Type: array object[] · LINK[]
    • meaning
      required
      • _type
        Discriminator
        enum
        const:  
        DV_TEXT
        required
        values
        • DV_TEXT
      • value
        Type: string
        required
      • encoding
        Type: object · CODE_PHRASE
      • formatting
        Type: string
      • hyperlink
      • language
        Type: object · CODE_PHRASE
      • mappings
        Type: array object[] · TERM_MAPPING[]
    • target
      Type: object · DV_EHR_URI
      required
    • type
      required
      • _type
        Discriminator
        enum
        const:  
        DV_TEXT
        required
        values
        • DV_TEXT
      • value
        Type: string
        required
      • encoding
        Type: object · CODE_PHRASE
      • formatting
        Type: string
      • hyperlink
      • language
        Type: object · CODE_PHRASE
      • mappings
        Type: array object[] · TERM_MAPPING[]
  • uid
    • _type
      Discriminator
      enum
      const:  
      HIER_OBJECT_ID
      required
      values
      • HIER_OBJECT_ID
    • value
      Type: stringFormat: uuid
      required
Examples
{
  "archetype_node_id": "openEHR-EHR-FOLDER.directory.v1",
  "name": {
    "value": "Directory"
  },
  "uid": {
    "_type": "OBJECT_VERSION_ID",
    "value": "8849182c-82ad-4088-a07f-48ead4180515::cataniamc.prod.cadasto.com::1"
  },
  "items": [],
  "folders": []
}