COMPOSITION

A COMPOSITION resource

archetype_node_id
Type: string
required
category
Type: object · DV_CODED_TEXT
required
- defining_code
  Type: object · CODE_PHRASE
  required
- value
  Type: string
  required
- _type
  Type: string
- 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[]
composer
required
_type
Discriminator
enum
const:
PARTY_SELF
required
values
PARTY_SELF
external_ref
Type: object · PARTY_REF

Identifier for parties in a demographic or identity service.
content
Type: array · CONTENT_ITEM[]
required
- _type
  Discriminator
  enum
  const:
  ADMIN_ENTRY
  required
  values
  ADMIN_ENTRY
  archetype_node_id
  Type: string
  required
  data
  required
  _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
  encoding
  Type: object · CODE_PHRASE
  required
  language
  Type: object · CODE_PHRASE
  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[]
  subject
  required
  _type
  Discriminator
  enum
  const:
  PARTY_SELF
  required
  values
  PARTY_SELF
  external_ref
  Type: object · PARTY_REF
  
  Identifier for parties in a demographic or identity service.
  
  archetype_details
  Type: object · ARCHETYPED
  feeder_audit
  Type: object · FEEDER_AUDIT
  links
  Type: array object[] · LINK[]
  other_participations
  Type: array object[] · PARTICIPATION[]
  provider
  _type
  Discriminator
  enum
  const:
  PARTY_SELF
  required
  values
  PARTY_SELF
  external_ref
  Type: object · PARTY_REF
  
  Identifier for parties in a demographic or identity service.
  
  uid
  _type
  Discriminator
  enum
  const:
  HIER_OBJECT_ID
  required
  values
  HIER_OBJECT_ID
  value
  Type: stringFormat: uuid
  required
  workflow_id
  Type: object · OBJECT_REF
context
Type: object · EVENT_CONTEXT
required
- setting
  Type: object · DV_CODED_TEXT
  required
- start_time
  Type: object · DV_DATE_TIME
  required
- end_time
  Type: object · DV_DATE_TIME
- health_care_facility
  Type: object · PARTY_IDENTIFIED
- location
  Type: string
- other_context
  _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
- participations
  Type: array object[] · PARTICIPATION[]
language
Type: object · CODE_PHRASE
required
- code_string
  Type: string
  required
- terminology_id
  Type: object · TERMINOLOGY_ID
  required
- preferred_term
  Type: string
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[]
territory
Type: object · CODE_PHRASE
required
- code_string
  Type: string
  required
- terminology_id
  Type: object · TERMINOLOGY_ID
  required
- preferred_term
  Type: string
_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
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.
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-COMPOSITION.encounter.v1",
  "name": {
    "value": "Vital Signs"
  },
  "uid": {
    "_type": "OBJECT_VERSION_ID",
    "value": "8849182c-82ad-4088-a07f-48ead4180515::cataniamc.prod.cadasto.com::1"
  },
  "archetype_details": {
    "archetype_id": {
      "value": "openEHR-EHR-COMPOSITION.encounter.v1"
    },
    "template_id": {
      "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
    },
    "rm_version": "1.0.2"
  },
  "language": {
    "terminology_id": {
      "value": "ISO_639-1"
    },
    "code_string": "en"
  },
  "territory": {
    "terminology_id": {
      "value": "ISO_3166-1"
    },
    "code_string": "NL"
  },
  "category": {
    "value": "event",
    "defining_code": {
      "terminology_id": {
        "value": "openehr"
      },
      "code_string": "433"
    }
  },
  "composer": {
    "_type": "PARTY_IDENTIFIED",
    "external_ref": {
      "id": {
        "_type": "GENERIC_ID",
        "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
        "scheme": "pid"
      },
      "namespace": "cataniamc.prod.cadasto.com",
      "type": "PERSON"
    },
    "name": "A name"
  },
  "context": {
    "start_time": {
      "value": "2014-11-18T09:50:35.000+01:00"
    },
    "setting": {
      "value": "other care",
      "defining_code": {
        "terminology_id": {
          "value": "openehr"
        },
        "code_string": "238"
      }
    }
  },
  "content": []
}