AGENT

  • archetype_node_id
    Type: string
    required
  • identities
    Type: array object[] · ListOfPartyIdentity
    required
    • archetype_node_id
      Type: string
      required
    • details
      Type: object · ITEM_STRUCTURE
      required

      Polymorphic ITEM_STRUCTURE wrapper. See concrete leaf schemas:

      • ItemSingle
      • ItemList
      • ItemTable
      • ItemTree
    • name
      Type: object · DV_TEXT
      required

      Polymorphic DV_TEXT wrapper. See concrete leaf schemas:

      • UMDvText
      • UMDvCodedText
    • _type
      Type: string
    • 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
  • name
    Type: object · DV_TEXT
    required

    Polymorphic DV_TEXT wrapper. See concrete leaf schemas:

    • UMDvText
    • UMDvCodedText
  • _type
    enum
    const:  
    AGENT
    values
    • AGENT
  • archetype_details
    Type: object · ARCHETYPED
    • archetype_id
      Type: object · ARCHETYPE_ID
      required
    • rm_version
      Type: string
      required
    • template_id
      Type: object · TEMPLATE_ID
  • contacts
    Type: array object[] · ListOfContact
    • addresses
      Type: array object[] · ADDRESS[]
      required
    • archetype_node_id
      Type: string
      required
    • name
      Type: object · DV_TEXT
      required

      Polymorphic DV_TEXT wrapper. See concrete leaf schemas:

      • UMDvText
      • UMDvCodedText
    • _type
      enum
      const:  
      CONTACT
      values
      • CONTACT
    • archetype_details
      Type: object · ARCHETYPED
    • feeder_audit
      Type: object · FEEDER_AUDIT
    • links
      Type: array object[] · LINK[]
    • time_validity
      Type: object · DV_INTERVAL_of_DATE
    • uid
      • _type
        Discriminator
        enum
        const:  
        HIER_OBJECT_ID
        required
        values
        • HIER_OBJECT_ID
      • value
        Type: stringFormat: uuid
        required
  • details
    Type: object · ITEM_STRUCTURE

    Polymorphic ITEM_STRUCTURE wrapper. See concrete leaf schemas:

    • ItemSingle
    • ItemList
    • ItemTable
    • ItemTree
  • 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: object · DV_ENCAPSULATED

      Polymorphic DV_ENCAPSULATED wrapper. See concrete leaf schemas:

      • UMDvMultimedia
      • UMDvParsable
    • 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.

  • languages
    Type: array object[] · DV_TEXT[]
    Empty object
  • links
    Type: array object[] · LINK[]
    • meaning
      Type: string
      required
    • target
      Type: object · DV_EHR_URI
      required
    • type
      Type: string
      required
  • relationships
    Type: array object[] · ListOfPartyRelationShip
    • archetype_node_id
      Type: string
      required
    • name
      Type: object · DV_TEXT
      required

      Polymorphic DV_TEXT wrapper. See concrete leaf schemas:

      • UMDvText
      • UMDvCodedText
    • source
      Type: object · PARTY_REF
      required

      Identifier for parties in a demographic or identity service.

    • target
      Type: object · PARTY_REF
      required

      Identifier for parties in a demographic or identity service.

    • _type
      Type: string
    • archetype_details
      Type: object · ARCHETYPED
    • details
      Type: object · ITEM_STRUCTURE

      Polymorphic ITEM_STRUCTURE wrapper. See concrete leaf schemas:

      • ItemSingle
      • ItemList
      • ItemTable
      • ItemTree
    • feeder_audit
      Type: object · FEEDER_AUDIT
    • links
      Type: array object[] · LINK[]
    • time_validity
      Type: object · DV_INTERVAL_of_DATE
    • uid
      • _type
        Discriminator
        enum
        const:  
        HIER_OBJECT_ID
        required
        values
        • HIER_OBJECT_ID
      • value
        Type: stringFormat: uuid
        required
  • roles
    Type: array object[] · PARTY_REF[]

    Identifier for parties in a demographic or identity service.

    • id
      Type: object · HIER_OBJECT_ID
      required
    • namespace
      Type: string
      required
    • type
      Type: string Pattern: ^PERSON|ORGANISATION|GROUP|AGENT|ROLE|PARTY|ACTOR$
      required
  • uid
    • _type
      Discriminator
      enum
      const:  
      HIER_OBJECT_ID
      required
      values
      • HIER_OBJECT_ID
    • value
      Type: stringFormat: uuid
      required