openapi: 3.2.0 info: title: Cadasto CONTRIBUTION API x-refined-note: - x-spec differs across the merged source definitions and was not carried - x-status differs across the merged source definitions and was not carried version: '1.0' description: 'Operations tagged CONTRIBUTION across 2 of this provider''s published API definitions: cadasto-demographic-api-openapi.json, cadasto-ehr-api-openapi.json. Each path carries the servers of the definition it was published in.' servers: - url: https://{baseUrl}/v1 description: An example openEHR server URL. variables: baseUrl: default: cataniamc.prod.cadasto.com description: The (example) server base URL prefix providing openEHR services. This may contain server name, port and base path prefix. - url: https://{baseUrl}/openehr/v1 description: An example openEHR server URL. variables: baseUrl: default: cataniamc.prod.cadasto.com description: The (example) server base URL prefix providing openEHR services. This may contain server name, port and base path prefix. security: [] tags: - name: Contribution description: Management of CONTRIBUTION class. paths: /demographic/contribution: post: operationId: contribution_create summary: Create CONTRIBUTION description: 'We will use the relaxed CONTRIBUTION with the following optional attributes: - `uid`: when provided, it will be accepted in case is not in-use, otherwise error will be returned - `audit.time_committed`: server will always set it - `audit.system_id`: when provided, it will be validated' tags: - Contribution parameters: - $ref: '#/components/parameters/Prefer' requestBody: description: 'The CONTRIBUTION. ' content: application/json: schema: $ref: '#/components/schemas/NewContribution' required: true responses: '201': $ref: '#/components/responses/201_demographic_CONTRIBUTION' '400': $ref: '#/components/responses/400_CONTRIBUTION' '409': $ref: '#/components/responses/409' servers: - url: https://{baseUrl}/v1 description: An example openEHR server URL. variables: baseUrl: default: cataniamc.prod.cadasto.com description: The (example) server base URL prefix providing openEHR services. This may contain server name, port and base path prefix. /demographic/contribution/{contribution_uid}: get: operationId: contribution_get summary: Get CONTRIBUTION by id description: Retrieves a CONTRIBUTION identified by `contribution_uid`. tags: - Contribution parameters: - $ref: '#/components/parameters/contribution_uid' responses: '200': $ref: '#/components/responses/200_CONTRIBUTION' '404': $ref: '#/components/responses/404_demographic_CONTRIBUTION' servers: - url: https://{baseUrl}/v1 description: An example openEHR server URL. variables: baseUrl: default: cataniamc.prod.cadasto.com description: The (example) server base URL prefix providing openEHR services. This may contain server name, port and base path prefix. /ehr/{ehr_id}/contribution: post: operationId: contribution_create summary: Create CONTRIBUTION description: 'We will use the relaxed CONTRIBUTION with the following optional attributes: - `uid`: when provided, it will be accepted in case is not in-use, otherwise error will be returned - `audit.time_committed`: server will always set it - `audit.system_id`: when provided, it will be validated' tags: - Contribution parameters: - $ref: '#/components/parameters/ehr_id' - $ref: '#/components/parameters/Prefer_2' requestBody: description: 'The CONTRIBUTION. ' content: application/json: schema: $ref: '#/components/schemas/NewContribution_2' required: true responses: '201': $ref: '#/components/responses/201_CONTRIBUTION' '400': $ref: '#/components/responses/400_CONTRIBUTION_2' '404': $ref: '#/components/responses/404_unknown_ehr_id' '409': $ref: '#/components/responses/409' servers: - url: https://{baseUrl}/openehr/v1 description: An example openEHR server URL. variables: baseUrl: default: cataniamc.prod.cadasto.com description: The (example) server base URL prefix providing openEHR services. This may contain server name, port and base path prefix. /ehr/{ehr_id}/contribution/{contribution_uid}: get: operationId: contribution_get summary: Get CONTRIBUTION by id description: Retrieves a CONTRIBUTION identified by `contribution_uid` and associated with the EHR identified by `ehr_id`. tags: - Contribution parameters: - $ref: '#/components/parameters/ehr_id' - $ref: '#/components/parameters/contribution_uid_2' responses: '200': $ref: '#/components/responses/200_CONTRIBUTION' '404': $ref: '#/components/responses/404_CONTRIBUTION' servers: - url: https://{baseUrl}/openehr/v1 description: An example openEHR server URL. variables: baseUrl: default: cataniamc.prod.cadasto.com description: The (example) server base URL prefix providing openEHR services. This may contain server name, port and base path prefix. components: schemas: UDvUri: title: DV_URI type: object description: 'Polymorphic DV_URI wrapper. See concrete leaf schemas: - `UMDvUri` - `UMDvEhrUri` ' ReferenceRange: title: REFERENCE_RANGE required: - meaning - range type: object properties: meaning: $ref: '#/components/schemas/UDvText' range: $ref: '#/components/schemas/DvInterval' TerminologyId: title: TERMINOLOGY_ID type: object properties: _type: enum: - TERMINOLOGY_ID type: string value: type: string required: - value UVersionable: title: Versionable type: object description: Abstract parent of AGENT, GROUP, ORGANISATION, PERSON, ROLE. (Simplified for Docs) UMObjectVersionId: title: OBJECT_VERSION_ID required: - value - _type type: object properties: _type: enum: - OBJECT_VERSION_ID type: string value: type: string UpdateAttestation: title: UPDATE_ATTESTATION required: - change_type - committer - reason - is_pending type: object properties: _type: enum: - UPDATE_ATTESTATION type: string change_type: $ref: '#/components/schemas/TerminologyCode' description: $ref: '#/components/schemas/UDvText' committer: $ref: '#/components/schemas/UPartyProxy' attested_view: $ref: '#/components/schemas/DvMultimedia' proof: type: string items: type: array items: $ref: '#/components/schemas/DvEhrUri' reason: $ref: '#/components/schemas/UDvText' is_pending: type: boolean UDvText: title: DV_TEXT type: object description: 'Polymorphic DV_TEXT wrapper. See concrete leaf schemas: - `UMDvText` - `UMDvCodedText` ' DvMultimedia: title: DV_MULTIMEDIA required: - _type - media_type - size type: object properties: _type: enum: - DV_MULTIMEDIA type: string charset: $ref: '#/components/schemas/CodePhrase' language: $ref: '#/components/schemas/CodePhrase' alternate_text: type: string uri: $ref: '#/components/schemas/UDvUri' data: type: string media_type: $ref: '#/components/schemas/CodePhrase' compression_algorithm: $ref: '#/components/schemas/CodePhrase' integrity_check: type: string integrity_check_algorithm: $ref: '#/components/schemas/CodePhrase' thumbnail: type: object description: Recursive reference to DvMultimedia (thumbnail) size: type: integer CodePhrase: title: CODE_PHRASE required: - terminology_id - code_string type: object properties: terminology_id: $ref: '#/components/schemas/TerminologyId' code_string: type: string preferred_term: type: string DvCodedText: title: DV_CODED_TEXT required: - value - defining_code type: object properties: _type: enum: - DV_CODED_TEXT type: string value: type: string hyperlink: $ref: '#/components/schemas/UDvUri' formatting: type: string mappings: type: array items: $ref: '#/components/schemas/TermMapping' language: $ref: '#/components/schemas/CodePhrase' encoding: $ref: '#/components/schemas/CodePhrase' defining_code: $ref: '#/components/schemas/CodePhrase' UPartyProxy: title: PARTY_PROXY type: object description: 'Polymorphic PARTY_PROXY wrapper. See concrete leaf schemas: - `UMPartySelf` - `UMPartyIdentified` - `UMPartyRelated` ' UpdateVersion: title: UPDATE_VERSION required: - lifecycle_state - data - commit_audit type: object properties: preceding_version_uid: $ref: '#/components/schemas/ObjectVersionId' signature: type: string lifecycle_state: $ref: '#/components/schemas/TerminologyCode' attestations: type: array items: $ref: '#/components/schemas/UpdateAttestation' data: $ref: '#/components/schemas/UVersionable' commit_audit: $ref: '#/components/schemas/UpdateAudit' HierObjectId: title: HIER_OBJECT_ID required: - value type: object properties: _type: enum: - HIER_OBJECT_ID type: string value: type: string format: uuid DvDuration: title: DV_DURATION type: object properties: _type: enum: - DV_DURATION type: string normal_status: $ref: '#/components/schemas/CodePhrase' normal_range: $ref: '#/components/schemas/DvInterval' other_reference_ranges: type: array items: $ref: '#/components/schemas/ReferenceRange' magnitude_status: type: string default: '=' accuracy_is_percent: type: boolean accuracy: type: number ObjectVersionId: title: OBJECT_VERSION_ID required: - value type: object properties: _type: enum: - OBJECT_VERSION_ID type: string value: type: string TerminologyCode: title: TERMINOLOGY_CODE required: - terminology_id - code_string type: object properties: terminology_id: type: string terminology_version: type: string code_string: type: string uri: type: string format: uri AuditDetails: title: AUDIT_DETAILS required: - system_id - time_committed - change_type - committer type: object properties: _type: type: string default: AUDIT_DETAILS system_id: type: string time_committed: $ref: '#/components/schemas/DvDateTime' change_type: $ref: '#/components/schemas/DvCodedText' description: $ref: '#/components/schemas/UDvText' committer: $ref: '#/components/schemas/UPartyProxy' description: The set of attributes required to document the committal of an information item to a repository. Contribution: title: CONTRIBUTION required: - uid - versions - audit type: object properties: uid: $ref: '#/components/schemas/HierObjectId' versions: type: array items: $ref: '#/components/schemas/ObjectRefOfObjectVersionId' audit: $ref: '#/components/schemas/AuditDetails' description: A CONTRIBUTION resource examples: - uid: value: 0826851c-c4c2-4d61-92b9-410fb8275ff0 versions: - id: _type: OBJECT_VERSION_ID value: fb458d9c-1323-42bc-b7f8-787f3660a0b5::cataniamc.prod.cadasto.com::1 namespace: local type: COMPOSITION - id: _type: OBJECT_VERSION_ID value: abcdefgh-1323-42bc-b7f8-787f3660a0ba::cataniamc.prod.cadasto.com::1 namespace: local type: FOLDER audit: system_id: 9624982A-9F42-41A5-9318-AE13D5F5031F committer: _type: PARTY_IDENTIFIED name: A user name time_committed: value: '2017-08-15T10:37:15.422+02:00' change_type: value: creation defining_code: terminology_id: value: openehr code_string: '249' description: value: Description text NewContribution: title: NewContribution required: - versions - audit type: object properties: uid: $ref: '#/components/schemas/HierObjectId' versions: type: array items: $ref: '#/components/schemas/UpdateVersion' audit: $ref: '#/components/schemas/UpdateAudit' description: A new (un-committed) CONTRIBUTION resource for Demographic DvEhrUri: title: DV_EHR_URI type: object properties: _type: enum: - DV_EHR_URI type: string value: type: string required: - value TermMapping: title: TERM_MAPPING required: - match - target type: object properties: match: pattern: /^[><=?]$/ type: string purpose: type: object properties: value: type: string defining_code: $ref: '#/components/schemas/CodePhrase' target: $ref: '#/components/schemas/CodePhrase' ObjectRefOfObjectVersionId: title: OBJECT_REF type: object properties: namespace: type: string type: type: string id: $ref: '#/components/schemas/UMObjectVersionId' required: - namespace - type - id examples: - id: _type: OBJECT_VERSION_ID value: fb458d9c-1323-42bc-b7f8-787f3660a0b5::cataniamc.prod.cadasto.com::1 namespace: local type: COMPOSITION Error: title: Error required: - message - validationErrors type: object properties: message: type: string validationErrors: type: array items: type: string description: '' UpdateAudit: title: UPDATE_AUDIT required: - change_type - committer type: object properties: _type: type: string default: UPDATE_AUDIT change_type: $ref: '#/components/schemas/TerminologyCode' description: $ref: '#/components/schemas/UDvText' committer: $ref: '#/components/schemas/UPartyProxy' description: The set of attributes required to document the committal of an information item to a repository. Used by the server to create an AUDIT_DETAILS object. DvDateTime: title: DV_DATE_TIME required: - value type: object properties: _type: enum: - DV_DATE_TIME type: string normal_status: $ref: '#/components/schemas/CodePhrase' normal_range: $ref: '#/components/schemas/DvInterval' other_reference_ranges: type: array items: $ref: '#/components/schemas/ReferenceRange' magnitude_status: type: string default: '=' accuracy: $ref: '#/components/schemas/DvDuration' value: type: string format: date-time Identifier: title: Identifier required: - uid type: object properties: uid: type: string description: The (version) resource identifier. DvInterval: title: DV_INTERVAL required: - lower_unbounded - upper_unbounded - lower_included - upper_included type: object properties: _type: type: string default: DV_INTERVAL lower_unbounded: type: boolean upper_unbounded: type: boolean lower_included: type: boolean upper_included: type: boolean UDvUri_2: title: DV_URI oneOf: - $ref: '#/components/schemas/UMDvUri' - $ref: '#/components/schemas/UMDvEhrUri' discriminator: propertyName: _type mapping: DV_URI: '#/components/schemas/UMDvUri' DV_EHR_URI: '#/components/schemas/UMDvEhrUri' examples: - _type: DV_URI value: https://www.example.com UMDvBoolean: title: DV_BOOLEAN required: - value - _type type: object properties: _type: enum: - DV_BOOLEAN type: string value: type: boolean x-discriminator-value: DV_BOOLEAN Event: title: EVENT required: - name - archetype_node_id - time - data type: object properties: name: $ref: '#/components/schemas/UDvText_2' archetype_node_id: type: string xml: attribute: true uid: $ref: '#/components/schemas/UUidBasedId' links: type: array items: $ref: '#/components/schemas/Link' archetype_details: $ref: '#/components/schemas/Archetyped' feeder_audit: $ref: '#/components/schemas/FeederAudit' _type: type: string default: EVENT time: $ref: '#/components/schemas/DvDateTime_2' state: $ref: '#/components/schemas/UItemStructure' data: $ref: '#/components/schemas/UItemStructure' x-discriminator-value: EVENT UPartyIdentified: title: PARTY_IDENTIFIED oneOf: - $ref: '#/components/schemas/UMPartyIdentified' discriminator: propertyName: _type mapping: PARTY_IDENTIFIED: '#/components/schemas/UMPartyIdentified' PARTY_RELATED: '#/components/schemas/UMPartyRelated' UMEvaluation: title: EVALUATION required: - name - archetype_node_id - language - encoding - subject - data - _type type: object properties: name: $ref: '#/components/schemas/UDvText_2' archetype_node_id: type: string xml: attribute: true uid: $ref: '#/components/schemas/UUidBasedId' links: type: array items: $ref: '#/components/schemas/Link' archetype_details: $ref: '#/components/schemas/Archetyped' feeder_audit: $ref: '#/components/schemas/FeederAudit' language: $ref: '#/components/schemas/CodePhrase_2' encoding: $ref: '#/components/schemas/CodePhrase_2' other_participations: type: array items: $ref: '#/components/schemas/Participation' workflow_id: $ref: '#/components/schemas/ObjectRef' subject: $ref: '#/components/schemas/UPartyProxy_2' provider: $ref: '#/components/schemas/UPartyProxy_2' protocol: $ref: '#/components/schemas/UItemStructure' guideline_id: $ref: '#/components/schemas/ObjectRef' _type: enum: - EVALUATION type: string data: $ref: '#/components/schemas/UItemStructure' x-discriminator-value: EVALUATION DvMultimedia_2: title: DV_MULTIMEDIA required: - _type - media_type - size type: object properties: _type: type: string default: DV_MULTIMEDIA charset: $ref: '#/components/schemas/CodePhrase_2' language: $ref: '#/components/schemas/CodePhrase_2' alternate_text: type: string uri: $ref: '#/components/schemas/UDvUri_2' data: type: string media_type: $ref: '#/components/schemas/CodePhrase_2' compression_algorithm: $ref: '#/components/schemas/CodePhrase_2' integrity_check: type: string integrity_check_algorithm: $ref: '#/components/schemas/CodePhrase_2' thumbnail: $ref: '#/components/schemas/DvMultimedia_2' size: type: integer x-discriminator-value: DV_MULTIMEDIA FeederAuditDetails: title: FEEDER_AUDIT_DETAILS required: - system_id type: object properties: system_id: type: string location: $ref: '#/components/schemas/UPartyIdentified' subject: $ref: '#/components/schemas/UPartyProxy_2' provider: $ref: '#/components/schemas/UPartyIdentified' time: $ref: '#/components/schemas/DvDateTime_2' version_id: type: string other_details: $ref: '#/components/schemas/UItemStructure' UMDvState: title: DV_STATE required: - value - is_terminal - _type type: object properties: _type: enum: - DV_STATE type: string value: $ref: '#/components/schemas/DvCodedText_2' is_terminal: type: boolean x-discriminator-value: DV_STATE UDataValue: title: DATA_VALUE oneOf: - $ref: '#/components/schemas/UMDvBoolean' - $ref: '#/components/schemas/UMDvCodedText' - $ref: '#/components/schemas/UMDvCount' - $ref: '#/components/schemas/UMDvDate' - $ref: '#/components/schemas/UMDvDateTime' - $ref: '#/components/schemas/UMDvDuration' - $ref: '#/components/schemas/UMDvEhrUri' - $ref: '#/components/schemas/UMDvIdentifier' - $ref: '#/components/schemas/UMDvMultimedia' - $ref: '#/components/schemas/UMDvOrdinal' - $ref: '#/components/schemas/UMDvParsable' - $ref: '#/components/schemas/UMDvProportion' - $ref: '#/components/schemas/UMDvQuantity' - $ref: '#/components/schemas/UMDvScale' - $ref: '#/components/schemas/UMDvState' - $ref: '#/components/schemas/UMDvText' - $ref: '#/components/schemas/UMDvUri' discriminator: propertyName: _type mapping: DV_BOOLEAN: '#/components/schemas/UMDvBoolean' DV_CODED_TEXT: '#/components/schemas/UMDvCodedText' DV_COUNT: '#/components/schemas/UMDvCount' DV_DATE: '#/components/schemas/UMDvDate' DV_DATE_TIME: '#/components/schemas/UMDvDateTime' DV_DURATION: '#/components/schemas/UMDvDuration' DV_EHR_URI: '#/components/schemas/UMDvEhrUri' DV_IDENTIFIER: '#/components/schemas/UMDvIdentifier' DV_MULTIMEDIA: '#/components/schemas/UMDvMultimedia' DV_ORDINAL: '#/components/schemas/UMDvOrdinal' DV_PARSABLE: '#/components/schemas/UMDvParsable' DV_PROPORTION: '#/components/schemas/UMDvProportion' DV_QUANTITY: '#/components/schemas/UMDvQuantity' DV_SCALE: '#/components/schemas/UMDvScale' DV_STATE: '#/components/schemas/UMDvState' DV_TEXT: '#/components/schemas/UMDvText' DV_TIME: '#/components/schemas/UMDvTime' DV_URI: '#/components/schemas/UMDvUri' EhrStatus: title: EHR_STATUS required: - name - archetype_node_id - subject - is_queryable - is_modifiable type: object properties: name: $ref: '#/components/schemas/UDvText_2' archetype_node_id: type: string xml: attribute: true links: type: array items: $ref: '#/components/schemas/Link' archetype_details: $ref: '#/components/schemas/Archetyped' feeder_audit: $ref: '#/components/schemas/FeederAudit' _type: type: string default: EHR_STATUS subject: $ref: '#/components/schemas/UPartyProxy_2' is_queryable: type: boolean default: true is_modifiable: type: boolean default: true other_details: $ref: '#/components/schemas/UItemStructure' description: An EHR_STATUS resource x-discriminator-value: EHR_STATUS examples: - archetype_node_id: openEHR-EHR-EHR_STATUS.generic.v1 name: value: EHR status subject: _type: PARTY_SELF is_queryable: true is_modifiable: true UMDvIdentifier: title: DV_IDENTIFIER required: - id - _type type: object properties: issuer: type: string assigner: type: string id: type: string type: type: string _type: enum: - DV_IDENTIFIER type: string x-discriminator-value: DV_IDENTIFIER examples: - id: 16b74749-e6aa-4945-b760-b42bdc07098a type: Patient UMAction: title: ACTION required: - name - archetype_node_id - language - encoding - subject - time - ism_transition - description - _type type: object properties: name: $ref: '#/components/schemas/UDvText_2' archetype_node_id: type: string xml: attribute: true uid: $ref: '#/components/schemas/UUidBasedId' links: type: array items: $ref: '#/components/schemas/Link' archetype_details: $ref: '#/components/schemas/Archetyped' feeder_audit: $ref: '#/components/schemas/FeederAudit' language: $ref: '#/components/schemas/CodePhrase_2' encoding: $ref: '#/components/schemas/CodePhrase_2' other_participations: type: array items: $ref: '#/components/schemas/Participation' workflow_id: $ref: '#/components/schemas/ObjectRef' subject: $ref: '#/components/schemas/UPartyProxy_2' provider: $ref: '#/components/schemas/UPartyProxy_2' protocol: $ref: '#/components/schemas/UItemStructure' guideline_id: $ref: '#/components/schemas/ObjectRef' _type: enum: - ACTION type: string time: $ref: '#/components/schemas/DvDateTime_2' ism_transition: $ref: '#/components/schemas/IsmTransition' instruction_details: $ref: '#/components/schemas/InstructionDetails' description: $ref: '#/components/schemas/UItemStructure' x-discriminator-value: ACTION HierObjectId_2: title: HIER_OBJECT_ID required: - value type: object properties: _type: type: string default: UID_BASED_ID value: type: string format: uuid examples: - 6cb19121-4307-4648-9da0-d62e4d51f19b x-discriminator-value: HIER_OBJECT_ID Activity: title: ACTIVITY required: - name - archetype_node_id - action_archetype_id - description type: object properties: name: $ref: '#/components/schemas/UDvText_2' archetype_node_id: type: string xml: attribute: true uid: $ref: '#/components/schemas/UUidBasedId' links: type: array items: $ref: '#/components/schemas/Link' archetype_details: $ref: '#/components/schemas/Archetyped' feeder_audit: $ref: '#/components/schemas/FeederAudit' _type: type: string default: ACTIVITY timing: $ref: '#/components/schemas/DvParsable' action_archetype_id: type: string description: $ref: '#/components/schemas/UItemStructure' x-discriminator-value: ACTIVITY UMDvDateTime: title: DV_DATE_TIME required: - value - _type type: object properties: _type: enum: - DV_DATE_TIME type: string value: type: string format: date-time x-discriminator-value: DV_DATE_TIME examples: - _type: DV_DATE_TIME value: '2017-08-15T10:37:15.422+02:00' AuditDetails_2: title: AUDIT_DETAILS required: - system_id - time_committed - change_type - committer type: object properties: _type: type: string default: AUDIT_DETAILS system_id: type: string time_committed: $ref: '#/components/schemas/DvDateTime_2' change_type: $ref: '#/components/schemas/DvCodedText_2' description: $ref: '#/components/schemas/UDvText_2' committer: $ref: '#/components/schemas/UPartyProxy_2' description: The set of attributes required to document the committal of an information item to a repository. x-discriminator-value: AUDIT_DETAILS examples: - system_id: 9624982A-9F42-41A5-9318-AE13D5F5031F committer: _type: PARTY_IDENTIFIED name: A user name time_committed: value: '2017-08-15T10:37:15.422+02:00' change_type: value: creation defining_code: terminology_id: value: openehr code_string: '249' description: value: Description text UMTerminologyId: title: TERMINOLOGY_ID required: - value - _type type: object properties: _type: enum: - TERMINOLOGY_ID type: string value: type: string x-discriminator-value: TERMINOLOGY_ID TermMapping_2: title: TERM_MAPPING required: - match - target type: object properties: match: pattern: /^[><=?]$/ type: string purpose: $ref: '#/components/schemas/DvCodedText_2' target: $ref: '#/components/schemas/CodePhrase_2' FeederAudit: title: FEEDER_AUDIT required: - originating_system_audit type: object properties: originating_system_item_ids: type: array items: $ref: '#/components/schemas/DvIdentifier' feeder_system_item_ids: type: array items: $ref: '#/components/schemas/DvIdentifier' original_content: $ref: '#/components/schemas/UDvEncapsulated' originating_system_audit: $ref: '#/components/schemas/FeederAuditDetails' feeder_system_audit: $ref: '#/components/schemas/FeederAuditDetails' DvIntervalOfDateTime: title: DV_INTERVAL_of_DATE_TIME type: object properties: _type: type: string default: DV_INTERVAL lower_unbounded: type: boolean upper_unbounded: type: boolean lower_included: type: boolean upper_included: type: boolean lower: $ref: '#/components/schemas/UMDvDateTime' upper: $ref: '#/components/schemas/UMDvDateTime' x-discriminator-value: DV_INTERVAL_of_DATE_TIME required: - lower_unbounded - upper_unbounded - lower_included - upper_included ArchetypeId: title: ARCHETYPE_ID type: object properties: _type: type: string default: ARCHETYPE_ID value: type: string x-discriminator-value: ARCHETYPE_ID required: - value DvIdentifier: title: DV_IDENTIFIER required: - id type: object properties: issuer: type: string assigner: type: string id: type: string type: type: string description: '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. ' x-discriminator-value: DV_IDENTIFIER examples: - id: 16b74749-e6aa-4945-b760-b42bdc07098a type: Patient UObjectId: title: OBJECT_ID oneOf: - $ref: '#/components/schemas/UMArchetypeId' - $ref: '#/components/schemas/UMTemplateId' - $ref: '#/components/schemas/UMTerminologyId' - $ref: '#/components/schemas/UMGenericId' - $ref: '#/components/schemas/UMHierObjectId' - $ref: '#/components/schemas/UMObjectVersionId_2' discriminator: propertyName: _type mapping: ARCHETYPE_ID: '#/components/schemas/UMArchetypeId' TEMPLATE_ID: '#/components/schemas/UMTemplateId' TERMINOLOGY_ID: '#/components/schemas/UMTerminologyId' GENERIC_ID: '#/components/schemas/UMGenericId' HIER_OBJECT_ID: '#/components/schemas/UMHierObjectId' OBJECT_VERSION_ID: '#/components/schemas/UMObjectVersionId' UVersionable_2: title: Versionable oneOf: - $ref: '#/components/schemas/Composition' - $ref: '#/components/schemas/EhrStatus' discriminator: propertyName: _type mapping: COMPOSITION: '#/components/schemas/Composition' EHR_STATUS: '#/components/schemas/EhrStatus' UMArchetypeId: title: ARCHETYPE_ID required: - value - _type type: object properties: _type: enum: - ARCHETYPE_ID type: string value: type: string x-discriminator-value: ARCHETYPE_ID UpdateAttestation_2: title: UPDATE_ATTESTATION required: - change_type - committer - reason - is_pending type: object properties: _type: type: string default: UPDATE_ATTESTATION change_type: $ref: '#/components/schemas/TerminologyCode_2' description: $ref: '#/components/schemas/UDvText_2' committer: $ref: '#/components/schemas/UPartyProxy_2' attested_view: $ref: '#/components/schemas/DvMultimedia_2' proof: type: string items: type: array items: $ref: '#/components/schemas/DvEhrUri_2' reason: $ref: '#/components/schemas/UDvText_2' is_pending: type: boolean x-discriminator-value: UPDATE_ATTESTATION examples: - change_type: value: creation defining_code: terminology_id: openehr code_string: '249' description: Description text committer: _type: PARTY_IDENTIFIED name: A user name UUidBasedId: title: UID_BASED_ID oneOf: - $ref: '#/components/schemas/UMHierObjectId' - $ref: '#/components/schemas/UMObjectVersionId_2' discriminator: propertyName: _type mapping: HIER_OBJECT_ID: '#/components/schemas/UMHierObjectId' OBJECT_VERSION_ID: '#/components/schemas/UMObjectVersionId' UMDvCount: title: DV_COUNT required: - magnitude - _type type: object properties: _type: enum: - DV_COUNT type: string magnitude: type: integer x-discriminator-value: DV_COUNT History: title: HISTORY required: - name - archetype_node_id - origin type: object properties: name: $ref: '#/components/schemas/UDvText_2' archetype_node_id: type: string xml: attribute: true uid: $ref: '#/components/schemas/UUidBasedId' links: type: array items: $ref: '#/components/schemas/Link' archetype_details: $ref: '#/components/schemas/Archetyped' feeder_audit: $ref: '#/components/schemas/FeederAudit' _type: type: string default: HISTORY origin: $ref: '#/components/schemas/DvDateTime_2' period: $ref: '#/components/schemas/DvDuration_2' duration: $ref: '#/components/schemas/DvDuration_2' summary: $ref: '#/components/schemas/UItemStructure' events: type: array items: $ref: '#/components/schemas/Event' x-discriminator-value: HISTORY UMDvUri: title: DV_URI required: - value - _type type: object properties: _type: enum: - DV_URI type: string value: type: string x-discriminator-value: DV_URI Archetyped: title: ARCHETYPED required: - archetype_id - rm_version type: object properties: archetype_id: $ref: '#/components/schemas/ArchetypeId' template_id: $ref: '#/components/schemas/TemplateId' rm_version: type: string additionalProperties: false examples: - archetype_id: value: openEHR-EHR-COMPOSITION.encounter.v1 template_id: value: Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747 rm_version: 1.0.2 ObjectVersionId_2: title: OBJECT_VERSION_ID required: - value type: object properties: _type: type: string default: UID_BASED_ID value: type: string examples: - 6cb19121-4307-4648-9da0-d62e4d51f19b::cataniamc.prod.cadasto.com::2 x-discriminator-value: OBJECT_VERSION_ID UMHierObjectId: title: HIER_OBJECT_ID required: - value - _type type: object properties: _type: enum: - HIER_OBJECT_ID type: string value: type: string format: uuid examples: - 6cb19121-4307-4648-9da0-d62e4d51f19b x-discriminator-value: HIER_OBJECT_ID examples: - _type: HIER_OBJECT_ID value: 6cb19121-4307-4648-9da0-d62e4d51f19b ItemTable: title: ITEM_TABLE type: object properties: name: $ref: '#/components/schemas/UDvText_2' archetype_node_id: type: string xml: attribute: true uid: $ref: '#/components/schemas/UUidBasedId' links: type: array items: $ref: '#/components/schemas/Link' archetype_details: $ref: '#/components/schemas/Archetyped' feeder_audit: $ref: '#/components/schemas/FeederAudit' _type: type: string default: ITEM_TABLE items: type: array items: $ref: '#/components/schemas/Clstr' x-discriminator-value: ITEM_TABLE required: - name - archetype_node_id UMDvDuration: title: DV_DURATION required: - _type type: object properties: _type: enum: - DV_DURATION type: string x-discriminator-value: DV_DURATION UMGenericId: title: GENERIC_ID required: - value - scheme - _type type: object properties: _type: enum: - GENERIC_ID type: string value: type: string scheme: type: string x-discriminator-value: GENERIC_ID examples: - _type: GENERIC_ID value: c7ec861c-c413-39ff-9965-a198ebf44747 scheme: pid ItemTree: title: ITEM_TREE type: object properties: name: $ref: '#/components/schemas/UDvText_2' archetype_node_id: type: string xml: attribute: true uid: $ref: '#/components/schemas/UUidBasedId' links: type: array items: $ref: '#/components/schemas/Link' archetype_details: $ref: '#/components/schemas/Archetyped' feeder_audit: $ref: '#/components/schemas/FeederAudit' _type: type: string default: ITEM_TREE items: type: array items: $ref: '#/components/schemas/UItem' x-discriminator-value: ITEM_TREE required: - name - archetype_node_id Participation: title: PARTICIPATION required: - function - performer type: object properties: function: $ref: '#/components/schemas/UDvText_2' mode: $ref: '#/components/schemas/DvCodedText_2' performer: $ref: '#/components/schemas/UPartyProxy_2' time: $ref: '#/components/schemas/DvIntervalOfDateTime' TerminologyId_2: title: TERMINOLOGY_ID type: object properties: _type: type: string default: TERMINOLOGY_ID value: type: string x-discriminator-value: TERMINOLOGY_ID required: - value Clstr: title: CLUSTER required: - name - archetype_node_id - items type: object properties: name: $ref: '#/components/schemas/UDvText_2' archetype_node_id: type: string xml: attribute: true uid: $ref: '#/components/schemas/UUidBasedId' links: type: array items: $ref: '#/components/schemas/Link' archetype_details: $ref: '#/components/schemas/Archetyped' feeder_audit: $ref: '#/components/schemas/FeederAudit' _type: type: string default: CLUSTER items: type: array items: $ref: '#/components/schemas/UItem' x-discriminator-value: CLUSTER UMObjectVersionId_2: title: OBJECT_VERSION_ID required: - value - _type type: object properties: _type: enum: - OBJECT_VERSION_ID type: string value: type: string examples: - 6cb19121-4307-4648-9da0-d62e4d51f19b::cataniamc.prod.cadasto.com::2 x-discriminator-value: OBJECT_VERSION_ID examples: - _type: OBJECT_VERSION_ID value: 6cb19121-4307-4648-9da0-d62e4d51f19b::cataniamc.prod.cadasto.com::2 ItemList: title: ITEM_LIST type: object properties: name: $ref: '#/components/schemas/UDvText_2' archetype_node_id: type: string xml: attribute: true uid: $ref: '#/components/schemas/UUidBasedId' links: type: array items: $ref: '#/components/schemas/Link' archetype_details: $ref: '#/components/schemas/Archetyped' feeder_audit: $ref: '#/components/schemas/FeederAudit' _type: type: string default: ITEM_LIST items: type: array items: $ref: '#/components/schemas/Element' x-discriminator-value: ITEM_LIST required: - name - archetype_node_id UDvText_2: title: DV_TEXT oneOf: - $ref: '#/components/schemas/UMDvText' - $ref: '#/components/schemas/UMDvCodedText' discriminator: propertyName: _type mapping: DV_TEXT: '#/components/schemas/UMDvText' DV_CODED_TEXT: '#/components/schemas/UMDvCodedText' examples: - _type: DV_TEXT value: Text value CodePhrase_2: title: CODE_PHRASE required: - terminology_id - code_string type: object properties: terminology_id: $ref: '#/components/schemas/TerminologyId_2' code_string: type: string preferred_term: type: string examples: - terminology_id: value: local code_string: at0001 DvCodedText_2: title: DV_CODED_TEXT required: - value - defining_code type: object properties: _type: type: string default: DV_CODED_TEXT value: type: string hyperlink: $ref: '#/components/schemas/UDvUri_2' formatting: type: string mappings: type: array items: $ref: '#/components/schemas/TermMapping_2' language: $ref: '#/components/schemas/CodePhrase_2' encoding: $ref: '#/components/schemas/CodePhrase_2' defining_code: $ref: '#/components/schemas/CodePhrase_2' x-discriminator-value: DV_CODED_TEXT examples: - value: Coded text value defining_code: terminology_id: value: local code_string: at0001 UMDvMultimedia: title: DV_MULTIMEDIA required: - _type - media_type - size type: object properties: _type: enum: - DV_MULTIMEDIA type: string charset: $ref: '#/components/schemas/CodePhrase_2' language: $ref: '#/components/schemas/CodePhrase_2' alternate_text: type: string uri: $ref: '#/components/schemas/UDvUri_2' data: type: string media_type: $ref: '#/components/schemas/CodePhrase_2' compression_algorithm: $ref: '#/components/schemas/CodePhrase_2' integrity_check: type: string integrity_check_algorithm: $ref: '#/components/schemas/CodePhrase_2' thumbnail: $ref: '#/components/schemas/DvMultimedia_2' size: type: integer x-discriminator-value: DV_MULTIMEDIA UMDvQuantity: title: DV_QUANTITY required: - magnitude - units - _type type: object properties: _type: enum: - DV_QUANTITY type: string magnitude: type: number precision: type: integer units: type: string units_system: type: string units_display_name: type: string x-discriminator-value: DV_QUANTITY UDvEncapsulated: title: DV_ENCAPSULATED oneOf: - $ref: '#/components/schemas/UMDvMultimedia' - $ref: '#/components/schemas/UMDvParsable' discriminator: propertyName: _type mapping: DV_MULTIMEDIA: '#/components/schemas/UMDvMultimedia' DV_PARSABLE: '#/components/schemas/UMDvParsable' DvParsable: title: DV_PARSABLE required: - _type - value - formalism type: object properties: _type: type: string default: DV_PARSABLE charset: $ref: '#/components/schemas/CodePhrase_2' language: $ref: '#/components/schemas/CodePhrase_2' value: type: string formalism: type: string x-discriminator-value: DV_PARSABLE InstructionDetails: title: INSTRUCTION_DETAILS required: - instruction_id - activity_id type: object properties: _type: type: string default: INSTRUCTION_DETAILS instruction_id: $ref: '#/components/schemas/LocatableRef' activity_id: type: string wf_details: $ref: '#/components/schemas/UItemStructure' x-discriminator-value: INSTRUCTION_DETAILS UItem: title: ITEM oneOf: - $ref: '#/components/schemas/Element' - $ref: '#/components/schemas/Clstr' discriminator: propertyName: _type mapping: ELEMENT: '#/components/schemas/Element' CLUSTER: '#/components/schemas/Clstr' LocatableRef: title: LOCATABLE_REF required: - namespace - type - id type: object properties: namespace: type: string type: type: string id: $ref: '#/components/schemas/UUidBasedId' path: type: string UMAdminEntry: title: ADMIN_ENTRY required: - name - archetype_node_id - language - encoding - subject - data - _type type: object properties: name: $ref: '#/components/schemas/UDvText_2' archetype_node_id: type: string xml: attribute: true uid: $ref: '#/components/schemas/UUidBasedId' links: type: array items: $ref: '#/components/schemas/Link' archetype_details: $ref: '#/components/schemas/Archetyped' feeder_audit: $ref: '#/components/schemas/FeederAudit' language: $ref: '#/components/schemas/CodePhrase_2' encoding: $ref: '#/components/schemas/CodePhrase_2' other_participations: type: array items: $ref: '#/components/schemas/Participation' workflow_id: $ref: '#/components/schemas/ObjectRef' subject: $ref: '#/components/schemas/UPartyProxy_2' provider: $ref: '#/components/schemas/UPartyProxy_2' _type: enum: - ADMIN_ENTRY type: string data: $ref: '#/components/schemas/UItemStructure' x-discriminator-value: ADMIN_ENTRY UMDvEhrUri: title: DV_EHR_URI required: - value - _type type: object properties: _type: enum: - DV_EHR_URI type: string value: type: string x-discriminator-value: DV_EHR_URI examples: - _type: DV_EHR_URI value: ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure UMDvText: title: DV_TEXT required: - value - _type type: object properties: _type: enum: - DV_TEXT type: string value: type: string hyperlink: $ref: '#/components/schemas/UDvUri_2' formatting: type: string mappings: type: array items: $ref: '#/components/schemas/TermMapping_2' language: $ref: '#/components/schemas/CodePhrase_2' encoding: $ref: '#/components/schemas/CodePhrase_2' x-discriminator-value: DV_TEXT Contribution_2: title: CONTRIBUTION required: - uid - versions - audit type: object properties: uid: $ref: '#/components/schemas/HierObjectId_2' versions: type: array items: $ref: '#/components/schemas/ObjectRef' audit: $ref: '#/components/schemas/AuditDetails_2' description: A CONTRIBUTION resource examples: - uid: value: 0826851c-c4c2-4d61-92b9-410fb8275ff0 versions: - _type: OBJECT_REF id: _type: OBJECT_VERSION_ID value: fb458d9c-1323-42bc-b7f8-787f3660a0b5::cataniamc.prod.cadasto.com::1 namespace: local type: COMPOSITION - _type: OBJECT_REF id: _type: OBJECT_VERSION_ID value: abcdefgh-1323-42bc-b7f8-787f3660a0ba::cataniamc.prod.cadasto.com::1 namespace: local type: FOLDER audit: system_id: 9624982A-9F42-41A5-9318-AE13D5F5031F committer: _type: PARTY_IDENTIFIED name: A user name time_committed: value: '2017-08-15T10:37:15.422+02:00' change_type: value: creation defining_code: terminology_id: value: openehr code_string: '249' description: value: Description text IsmTransition: title: ISM_TRANSITION required: - current_state type: object properties: _type: type: string default: ISM_TRANSITION current_state: $ref: '#/components/schemas/DvCodedText_2' transition: $ref: '#/components/schemas/DvCodedText_2' careflow_step: $ref: '#/components/schemas/DvCodedText_2' reason: type: array items: $ref: '#/components/schemas/UDvText_2' x-discriminator-value: ISM_TRANSITION PartyRef: title: PARTY_REF required: - namespace - type - id type: object properties: namespace: type: string type: pattern: ^PERSON|ORGANISATION|GROUP|AGENT|ROLE|PARTY|ACTOR$ type: string id: $ref: '#/components/schemas/UObjectId' description: Identifier for parties in a demographic or identity service. examples: - id: _type: OBJECT_VERSION_ID value: b52b9408-7048-4ec8-94bd-831fb0727e67::cataniamc.prod.cadasto.com::1 namespace: local type: PERSON NewContribution_2: title: NewContribution required: - versions - audit type: object properties: uid: $ref: '#/components/schemas/HierObjectId_2' versions: type: array items: $ref: '#/components/schemas/UpdateVersion' audit: $ref: '#/components/schemas/UpdateAudit_2' description: A new (un-committed) CONTRIBUTION resource UMDvOrdinal: title: DV_ORDINAL required: - symbol - value - _type type: object properties: _type: enum: - DV_ORDINAL type: string symbol: $ref: '#/components/schemas/DvCodedText_2' value: type: integer x-discriminator-value: DV_ORDINAL UMDvParsable: title: DV_PARSABLE required: - _type - value - formalism type: object properties: _type: enum: - DV_PARSABLE type: string charset: $ref: '#/components/schemas/CodePhrase_2' language: $ref: '#/components/schemas/CodePhrase_2' value: type: string formalism: type: string x-discriminator-value: DV_PARSABLE Error_2: title: Error required: - message - validationErrors type: object properties: message: type: string validationErrors: type: array items: type: string description: '' examples: - message: Error message validationErrors: - error1 - error2 UpdateAudit_2: title: UPDATE_AUDIT required: - change_type - committer type: object properties: _type: type: string default: UPDATE_AUDIT change_type: $ref: '#/components/schemas/TerminologyCode_2' description: $ref: '#/components/schemas/UDvText_2' committer: $ref: '#/components/schemas/UPartyProxy_2' description: The set of attributes required to document the committal of an information item to a repository. Used by the server to create an AUDIT_DETAILS object. x-discriminator-value: UPDATE_AUDIT examples: - change_type: value: creation defining_code: terminology_id: openehr code_string: '249' description: Description text committer: _type: PARTY_IDENTIFIED name: A user name UMDvScale: title: DV_SCALE required: - symbol - value - _type type: object properties: _type: enum: - DV_SCALE type: string symbol: $ref: '#/components/schemas/DvCodedText_2' value: type: number x-discriminator-value: DV_SCALE DvDateTime_2: title: DV_DATE_TIME required: - value type: object properties: _type: type: string default: DV_DATE_TIME value: type: string format: date-time x-discriminator-value: DV_DATE_TIME examples: - _type: DV_DATE_TIME value: '2017-08-15T10:37:15.422+02:00' ObjectRef: title: OBJECT_REF required: - namespace - type - id type: object properties: namespace: type: string type: type: string id: $ref: '#/components/schemas/UObjectId' examples: - id: _type: OBJECT_VERSION_ID value: fb458d9c-1323-42bc-b7f8-787f3660a0b5::cataniamc.prod.cadasto.com::1 namespace: local type: COMPOSITION Link: title: LINK required: - meaning - type - target type: object properties: meaning: $ref: '#/components/schemas/UDvText_2' type: $ref: '#/components/schemas/UDvText_2' target: $ref: '#/components/schemas/DvEhrUri_2' ItemSingle: title: ITEM_SINGLE required: - name - archetype_node_id - item type: object properties: name: $ref: '#/components/schemas/UDvText_2' archetype_node_id: type: string xml: attribute: true uid: $ref: '#/components/schemas/UUidBasedId' links: type: array items: $ref: '#/components/schemas/Link' archetype_details: $ref: '#/components/schemas/Archetyped' feeder_audit: $ref: '#/components/schemas/FeederAudit' _type: type: string default: ITEM_SINGLE item: $ref: '#/components/schemas/Element' x-discriminator-value: ITEM_SINGLE UMDvCodedText: title: DV_CODED_TEXT required: - value - defining_code - _type type: object properties: _type: enum: - DV_CODED_TEXT type: string value: type: string hyperlink: $ref: '#/components/schemas/UDvUri_2' formatting: type: string mappings: type: array items: $ref: '#/components/schemas/TermMapping_2' language: $ref: '#/components/schemas/CodePhrase_2' encoding: $ref: '#/components/schemas/CodePhrase_2' defining_code: $ref: '#/components/schemas/CodePhrase_2' x-discriminator-value: DV_CODED_TEXT examples: - value: Coded text value defining_code: terminology_id: value: local code_string: at0001 UPartyProxy_2: title: PARTY_PROXY oneOf: - $ref: '#/components/schemas/UMPartySelf' - $ref: '#/components/schemas/UMPartyIdentified' discriminator: propertyName: _type mapping: PARTY_SELF: '#/components/schemas/UMPartySelf' PARTY_IDENTIFIED: '#/components/schemas/UMPartyIdentified' PARTY_RELATED: '#/components/schemas/UMPartyRelated' Element: title: ELEMENT type: object properties: name: $ref: '#/components/schemas/UDvText_2' archetype_node_id: type: string xml: attribute: true uid: $ref: '#/components/schemas/UUidBasedId' links: type: array items: $ref: '#/components/schemas/Link' archetype_details: $ref: '#/components/schemas/Archetyped' feeder_audit: $ref: '#/components/schemas/FeederAudit' _type: type: string default: ELEMENT null_flavour: $ref: '#/components/schemas/DvCodedText_2' value: $ref: '#/components/schemas/UDataValue' null_reason: $ref: '#/components/schemas/UDvText_2' x-discriminator-value: ELEMENT required: - name - archetype_node_id UMDvDate: title: DV_DATE required: - value - _type type: object properties: _type: enum: - DV_DATE type: string value: type: string format: date x-discriminator-value: DV_DATE examples: - _type: DV_DATE value: '2017-08-15' DvDuration_2: title: DV_DURATION type: object properties: _type: type: string default: DV_DURATION x-discriminator-value: DV_DURATION UItemStructure: title: ITEM_STRUCTURE oneOf: - $ref: '#/components/schemas/ItemSingle' - $ref: '#/components/schemas/ItemList' - $ref: '#/components/schemas/ItemTable' - $ref: '#/components/schemas/ItemTree' discriminator: propertyName: _type mapping: ITEM_SINGLE: '#/components/schemas/ItemSingle' ITEM_LIST: '#/components/schemas/ItemList' ITEM_TABLE: '#/components/schemas/ItemTable' ITEM_TREE: '#/components/schemas/ItemTree' EventContext: title: EVENT_CONTEXT required: - start_time - setting type: object properties: start_time: $ref: '#/components/schemas/DvDateTime_2' end_time: $ref: '#/components/schemas/DvDateTime_2' location: type: string setting: $ref: '#/components/schemas/DvCodedText_2' other_context: $ref: '#/components/schemas/UItemStructure' health_care_facility: $ref: '#/components/schemas/UPartyIdentified' participations: type: array items: $ref: '#/components/schemas/Participation' x-discriminator-value: EVENT_CONTEXT TerminologyCode_2: title: TERMINOLOGY_CODE required: - terminology_id - code_string type: object properties: terminology_id: type: string terminology_version: type: string code_string: type: string uri: type: string format: uri examples: - terminology_id: snomed_ct code_string: '308335008' Composition: title: COMPOSITION required: - name - archetype_node_id - language - territory - category - context - composer - content type: object properties: name: $ref: '#/components/schemas/UDvText_2' archetype_node_id: type: string xml: attribute: true uid: $ref: '#/components/schemas/UUidBasedId' links: type: array items: $ref: '#/components/schemas/Link' archetype_details: $ref: '#/components/schemas/Archetyped' feeder_audit: $ref: '#/components/schemas/FeederAudit' _type: type: string default: COMPOSITION language: $ref: '#/components/schemas/CodePhrase_2' territory: $ref: '#/components/schemas/CodePhrase_2' category: $ref: '#/components/schemas/DvCodedText_2' context: $ref: '#/components/schemas/EventContext' composer: $ref: '#/components/schemas/UPartyProxy_2' content: type: array items: $ref: '#/components/schemas/UContentItem' description: A COMPOSITION resource x-discriminator-value: COMPOSITION 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: [] UMPartyIdentified: title: PARTY_IDENTIFIED required: - _type type: object properties: _type: enum: - PARTY_IDENTIFIED type: string external_ref: $ref: '#/components/schemas/PartyRef' identifiers: type: array items: $ref: '#/components/schemas/DvIdentifier' x-discriminator-value: PARTY_IDENTIFIED examples: - _type: PARTY_IDENTIFIED external_ref: id: _type: GENERIC_ID value: 16b74749-e6aa-4945-b760-b42bdc07098a scheme: pid namespace: cataniamc.prod.cadasto.com type: PERSON DvEhrUri_2: title: DV_EHR_URI type: object properties: _type: type: string default: DV_EHR_URI value: type: string x-discriminator-value: DV_EHR_URI required: - value examples: - _type: DV_EHR_URI value: ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure UMInstruction: title: INSTRUCTION required: - name - archetype_node_id - language - encoding - subject - narrative - _type type: object properties: name: $ref: '#/components/schemas/UDvText_2' archetype_node_id: type: string xml: attribute: true uid: $ref: '#/components/schemas/UUidBasedId' links: type: array items: $ref: '#/components/schemas/Link' archetype_details: $ref: '#/components/schemas/Archetyped' feeder_audit: $ref: '#/components/schemas/FeederAudit' language: $ref: '#/components/schemas/CodePhrase_2' encoding: $ref: '#/components/schemas/CodePhrase_2' other_participations: type: array items: $ref: '#/components/schemas/Participation' workflow_id: $ref: '#/components/schemas/ObjectRef' subject: $ref: '#/components/schemas/UPartyProxy_2' provider: $ref: '#/components/schemas/UPartyProxy_2' protocol: $ref: '#/components/schemas/UItemStructure' guideline_id: $ref: '#/components/schemas/ObjectRef' _type: enum: - INSTRUCTION type: string narrative: $ref: '#/components/schemas/UDvText_2' expiry_time: $ref: '#/components/schemas/DvDateTime_2' wf_definition: $ref: '#/components/schemas/DvParsable' activities: type: array items: $ref: '#/components/schemas/Activity' x-discriminator-value: INSTRUCTION UContentItem: title: CONTENT_ITEM oneOf: - $ref: '#/components/schemas/UMAdminEntry' - $ref: '#/components/schemas/UMObservation' - $ref: '#/components/schemas/UMEvaluation' - $ref: '#/components/schemas/UMInstruction' - $ref: '#/components/schemas/UMAction' discriminator: propertyName: _type mapping: ADMIN_ENTRY: '#/components/schemas/UMAdminEntry' OBSERVATION: '#/components/schemas/UMObservation' EVALUATION: '#/components/schemas/UMEvaluation' INSTRUCTION: '#/components/schemas/UMInstruction' ACTION: '#/components/schemas/UMAction' UMPartySelf: title: PARTY_SELF required: - _type type: object properties: _type: enum: - PARTY_SELF type: string external_ref: $ref: '#/components/schemas/PartyRef' x-discriminator-value: PARTY_SELF TemplateId: title: TEMPLATE_ID type: object properties: _type: type: string default: TEMPLATE_ID value: type: string x-discriminator-value: TEMPLATE_ID required: - value UMObservation: title: OBSERVATION required: - name - archetype_node_id - language - encoding - subject - data - _type type: object properties: name: $ref: '#/components/schemas/UDvText_2' archetype_node_id: type: string xml: attribute: true uid: $ref: '#/components/schemas/UUidBasedId' links: type: array items: $ref: '#/components/schemas/Link' archetype_details: $ref: '#/components/schemas/Archetyped' feeder_audit: $ref: '#/components/schemas/FeederAudit' language: $ref: '#/components/schemas/CodePhrase_2' encoding: $ref: '#/components/schemas/CodePhrase_2' other_participations: type: array items: $ref: '#/components/schemas/Participation' workflow_id: $ref: '#/components/schemas/ObjectRef' subject: $ref: '#/components/schemas/UPartyProxy_2' provider: $ref: '#/components/schemas/UPartyProxy_2' protocol: $ref: '#/components/schemas/UItemStructure' guideline_id: $ref: '#/components/schemas/ObjectRef' _type: enum: - OBSERVATION type: string data: $ref: '#/components/schemas/History' state: $ref: '#/components/schemas/History' x-discriminator-value: OBSERVATION UMDvProportion: title: DV_PROPORTION required: - numerator - denominator - semantic_type - _type type: object properties: _type: enum: - DV_PROPORTION type: string numerator: type: number denominator: type: number semantic_type: type: integer precision: type: integer x-discriminator-value: DV_PROPORTION UMTemplateId: title: TEMPLATE_ID required: - value - _type type: object properties: _type: enum: - TEMPLATE_ID type: string value: type: string x-discriminator-value: TEMPLATE_ID parameters: Prefer: name: Prefer in: header description: 'RFC 7240 preference header. Multiple tokens may be sent in a single header as a comma-separated list (e.g. `Prefer: return=representation, include_item_tags`) or as repeated headers. Cadasto recognises the following tokens: | Token | Where it applies | Effect | |-------|------------------|--------| | `return=representation` | write endpoints | Return the full updated resource in the response body. | | `return=identifier` | write endpoints | Return only the resource identifier (e.g. the `uid`). | | `return=minimal` (default on writes) | write endpoints | Empty response body. | | `include_item_tags` *(Cadasto extension)* | read endpoints, and write endpoints when the request does not already carry an `openehr-item-tag` header | Emit the `openehr-item-tag` response header with the current tags. On writes that ship `openehr-item-tag` in the request, the token is implied — the response always echoes the tags. Omitted by default on reads. See the [ITEM_TAG guide](/docs/guides/item-tag) for details. | The `Preference-Applied` response header echoes the tokens the server actually honoured (`return=`, plus `include_item_tags` / `resolve_refs` when applied). ' required: false style: simple schema: type: string contribution_uid: name: contribution_uid in: path description: 'The CONTRIBUTION uid. ' required: true style: simple schema: type: string format: uuid contribution_uid_2: name: contribution_uid in: path description: 'The CONTRIBUTION uid. ' required: true style: simple schema: type: string examples: - 0826851c-c4c2-4d61-92b9-410fb8275ff0 ehr_id: name: ehr_id in: path description: 'EHR identifier taken from EHR.ehr_id.value. ' required: true style: simple schema: type: string examples: - 7d44b88c-4199-4bad-97dc-d78268e01398 Prefer_2: name: Prefer in: header description: 'RFC 7240 preference header. Multiple tokens may be sent in a single header as a comma-separated list (e.g. `Prefer: return=representation, include_item_tags`) or as repeated headers. Cadasto recognises the following tokens: | Token | Where it applies | Effect | |-------|------------------|--------| | `return=representation` | write endpoints | Return the full updated resource in the response body. | | `return=minimal` (default on writes) | write endpoints | Empty response body. | | `include_item_tags` *(Cadasto extension)* | read endpoints, and write endpoints when the request does not already carry an `openehr-item-tag` header | Emit the `openehr-item-tag` response header with the current tags. On writes that ship `openehr-item-tag` in the request, the token is implied — the response always echoes the tags. Omitted by default on reads. See the [ITEM_TAG guide](/docs/guides/item-tag) for details. | The `Preference-Applied` response header echoes the tokens the server actually honoured (`return=`, plus `include_item_tags` / `resolve_refs` when applied). ' required: false style: simple schema: type: string examples: - return=representation, include_item_tags responses: 200_CONTRIBUTION: description: '`200 OK` is returned when the CONTRIBUTION is successfully retrieved. ' content: application/json: schema: $ref: '#/components/schemas/Contribution' 400_CONTRIBUTION: description: '`400 Bad Request` is returned when the request could not be parsed or is invalid (e.g. malformed request URL syntax, missing required header or parameter, or syntactically invalid header, parameter or content, or the modification type does not match the operation - i.e. first version of a MODIFICATION). The response body MAY contain error details. ' content: application/json: schema: $ref: '#/components/schemas/Error' 201_demographic_CONTRIBUTION: description: "`201 Created` is returned when the CONTRIBUTION is successfully created. \nIf `Prefer` header is `return=representation`, the full resource is included in the response body; if is `return=identifier`, only its unique identifier is included. \nIf the `Prefer` header is missing or set to `return=minimal`, the body is empty.\n" headers: ETag: $ref: '#/components/headers/ETag_CONTRIBUTION' Location: $ref: '#/components/headers/Location_demographic_CONTRIBUTION' content: application/json: schema: oneOf: - $ref: '#/components/schemas/Contribution' - $ref: '#/components/schemas/Identifier' '409': description: '`409 Conflict` is returned when a resource with same identifier(s) already exists. ' 404_demographic_CONTRIBUTION: description: '`404 Not Found` is returned when a CONTRIBUTION with `contribution_uid` does not exist. ' 400_CONTRIBUTION_2: description: '`400 Bad Request` is returned when the request URL or body could not be parsed or has invalid content (e.g. invalid `ehr_id`, or either the body of the request not be converted to a valid CONTRIBUTION object, or the modification type doesn’t match the operation - i.e. first version of a composition with MODIFICATION). ' content: application/json: schema: $ref: '#/components/schemas/Error_2' 404_CONTRIBUTION: description: '`404 Not Found` is returned when an EHR with `ehr_id` does not exist, or when a CONTRIBUTION with `contribution_uid` does not exist. ' 201_CONTRIBUTION: description: "`201 Created` is returned when the CONTRIBUTION was created. \nContent body is only returned when `Prefer` header has `return=representation`, otherwise only headers are returned.\n" headers: ETag: $ref: '#/components/headers/ETag_CONTRIBUTION_2' Location: $ref: '#/components/headers/Location_CONTRIBUTION' content: application/json: schema: $ref: '#/components/schemas/Contribution_2' 404_unknown_ehr_id: description: '`404 Not Found` is returned when an EHR with `ehr_id` does not exist. ' headers: Location_demographic_CONTRIBUTION: description: 'The `Location` response header indicates the URL of the CONTRIBUTION resource. ' schema: type: string format: url ETag_CONTRIBUTION: description: 'The `ETag` (i.e. entity tag) response header is the `contribution_uid` identifier, enclosed by double quotes. ' schema: type: string Location_CONTRIBUTION: description: 'The `Location` response header indicates the URL of the CONTRIBUTION resource. ' schema: type: string format: url examples: - https://cataniamc.prod.cadasto.com/v1/ehr/7d44b88c-4199-4bad-97dc-d78268e01398/contribution/0826851c-c4c2-4d61-92b9-410fb8275ff0 ETag_CONTRIBUTION_2: description: 'The `ETag` (i.e. entity tag) response header is the `contribution_uid` identifier, enclosed by double quotes. ' schema: type: string examples: - '"0826851c-c4c2-4d61-92b9-410fb8275ff0"' x-refined-from: - cadasto-demographic-api-openapi.json - cadasto-ehr-api-openapi.json x-tagGroups: - name: Resource endpoints tags: - EHR x-ext-urls: {}