Jump to

• Request
• Response

Create an Event

post

/v1/{tenantId}/events

Validates user access and creates an Event in Revenue Cycle with all supported fields.

Request

Path Parameters

• tenantId(required): string
  The unique identifier for the client or tenant account.

Header Parameters

• Authorization(required):
  The authorization scheme to authenticate the resource. Supports OAuth1 and OAuth2.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Event object sent in request body that has to be written.

Show Source

• date(required): string (YYYY-MM-DDTHH:MM:SS:SSSZ)
  Date and time of the event occurred.

  Example: 2020-02-13T18:24:49Z
• identifier(required): object identifier
  Business identifier for the event.
• payload(required): string
  Message payload for an event.

  Example: Address Inconsistencies between Patient, Guarantor and Subscriber ??? 336
• subject(required): object subject
  PersonId/encounterId/accountId/claimId reference object associated with the event request.
• type(required): object type
  Type of an event.
• uri: array uri
  Uri associated to event occurrence.

{
    "description":"Event object sent in request body that has to be written.",
    "type":"object",
    "required":[
        "identifier",
        "type",
        "subject",
        "date",
        "payload"
    ],
    "properties":{
        "identifier":{
            "description":"Business identifier for the event.",
            "type":"object",
            "allOf":[
                {
                    "$ref":"#/components/schemas/Identifier"
                }
            ]
        },
        "uri":{
            "description":"Uri associated to event occurrence.",
            "type":"array",
            "items":{
                "type":"string",
                "example":"http://partner.com/solution/7589712"
            }
        },
        "type":{
            "description":"Type of an event.",
            "type":"object",
            "allOf":[
                {
                    "$ref":"#/components/schemas/Type"
                }
            ]
        },
        "subject":{
            "description":"PersonId/encounterId/accountId/claimId reference object associated with the event request.",
            "type":"object",
            "allOf":[
                {
                    "$ref":"#/components/schemas/ReferenceEntity"
                }
            ]
        },
        "date":{
            "description":"Date and time of the event occurred.",
            "type":"string",
            "example":"2020-02-13T18:24:49Z",
            "format":"YYYY-MM-DDTHH:MM:SS:SSSZ"
        },
        "payload":{
            "description":"Message payload for an event.",
            "type":"string",
            "example":"Address Inconsistencies between Patient, Guarantor and Subscriber ??? 336"
        }
    }
}

Nested Schema : identifier

Type: object

Business identifier for the event.

Match All

Show Source

• object Identifier

{
    "description":"Business identifier for the event.",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/Identifier"
        }
    ]
}

Nested Schema : subject

Type: object

PersonId/encounterId/accountId/claimId reference object associated with the event request.

Match All

Show Source

• object ReferenceEntity

{
    "description":"PersonId/encounterId/accountId/claimId reference object associated with the event request.",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/ReferenceEntity"
        }
    ]
}

Nested Schema : type

Type: object

Type of an event.

Match All

Show Source

• object Type

{
    "description":"Type of an event.",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/Type"
        }
    ]
}

Nested Schema : uri

Type: array

Uri associated to event occurrence.

Show Source

• Array of: string
  Example: http://partner.com/solution/7589712

{
    "description":"Uri associated to event occurrence.",
    "type":"array",
    "items":{
        "type":"string",
        "example":"http://partner.com/solution/7589712"
    }
}

Nested Schema : Identifier

Type: object

Show Source

• value(required): string
  Unique business identifier for the event.

  Example: 7589712

{
    "type":"object",
    "required":[
        "value"
    ],
    "properties":{
        "value":{
            "description":"Unique business identifier for the event.",
            "type":"string",
            "example":"7589712"
        }
    }
}

Nested Schema : ReferenceEntity

Type: object

Show Source

• reference(required): string
  Account IDs must be prefixed with the following pattern if they come from source other than Cerner's FHIR resources. Financial (Patient) Accounts = F Insurance Balance Accounts = I

  Example: Encounter/2261599

{
    "type":"object",
    "required":[
        "reference"
    ],
    "properties":{
        "reference":{
            "description":" Account IDs must be prefixed with the following pattern if they come from source other than Cerner's FHIR resources. \n\n Financial (Patient) Accounts = F \n\n Insurance Balance Accounts = I",
            "type":"string",
            "example":"Encounter/2261599"
        }
    }
}

Nested Schema : Type

Type: object

Show Source

• coding(required): array coding
  Coding object of an event.

{
    "type":"object",
    "required":[
        "coding"
    ],
    "properties":{
        "coding":{
            "description":"Coding object of an event.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Coding"
            }
        }
    }
}

Nested Schema : coding

Type: array

Coding object of an event.

Show Source

• Array of: object Coding

{
    "description":"Coding object of an event.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Coding"
    }
}

Nested Schema : Coding

Type: object

Show Source

• code(required): string
  Event code identifier.

  Example: [ "PAYPLNCREATE", "PAYPLNUPDATE", "PAYPLNREMOVE", "AUTHCREATE", "AUTHUPDATE", "REGQAINFO", "REGQAEDIT", "REGQANOEDIT" ]

{
    "type":"object",
    "required":[
        "code"
    ],
    "properties":{
        "code":{
            "description":"Event code identifier.",
            "type":"string",
            "example":[
                "PAYPLNCREATE",
                "PAYPLNUPDATE",
                "PAYPLNREMOVE",
                "AUTHCREATE",
                "AUTHUPDATE",
                "REGQAINFO",
                "REGQAEDIT",
                "REGQANOEDIT"
            ]
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

Creates an Event and returns the Last-Modified and Location headers.

Headers

• Last-Modified(required):
  The modification date and time for the event prior to calling to this endpoint in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format. For example: 2020-04-23T06:08:25.748Z
• Location(required):
  Identifier for the Event.
• X-Request-Id(required):
  The trace ID for the request.

400 Response

Bad Request for missing required fields or invalid reference type.

Body ()

Root Schema : EventResponse

Type: object

Event response object

Show Source

• error(required): string
  Error definition/message.

  Example: Request body is missing: identifier

{
    "description":"Event response object",
    "type":"object",
    "required":[
        "error"
    ],
    "properties":{
        "error":{
            "description":"Error definition/message.",
            "type":"string",
            "example":"Request body is missing: identifier"
        }
    }
}

401 Response

Unauthorized for an expired access token or no access token.

Body ()

Root Schema : EventResponse

Type: object

Event response object

Show Source

• error(required): string
  Error definition/message.

  Example: Request body is missing: identifier

{
    "description":"Event response object",
    "type":"object",
    "required":[
        "error"
    ],
    "properties":{
        "error":{
            "description":"Error definition/message.",
            "type":"string",
            "example":"Request body is missing: identifier"
        }
    }
}

403 Response

Forbidden if OAuth2 scope in the authorization token does not have access.

Body ()

Root Schema : EventResponse

Type: object

Event response object

Show Source

• error(required): string
  Error definition/message.

  Example: Request body is missing: identifier

{
    "description":"Event response object",
    "type":"object",
    "required":[
        "error"
    ],
    "properties":{
        "error":{
            "description":"Error definition/message.",
            "type":"string",
            "example":"Request body is missing: identifier"
        }
    }
}

422 Response

Unsupported Media Type if Content-Type header provides an unsupported value.

Body ()

Root Schema : EventResponse

Type: object

Event response object

Show Source

• error(required): string
  Error definition/message.

  Example: Request body is missing: identifier

{
    "description":"Event response object",
    "type":"object",
    "required":[
        "error"
    ],
    "properties":{
        "error":{
            "description":"Error definition/message.",
            "type":"string",
            "example":"Request body is missing: identifier"
        }
    }
}

500 Response

Internal Server Error if an error occurs while creating the event.

Body ()

Root Schema : EventResponse

Type: object

Event response object

Show Source

• error(required): string
  Error definition/message.

  Example: Request body is missing: identifier

{
    "description":"Event response object",
    "type":"object",
    "required":[
        "error"
    ],
    "properties":{
        "error":{
            "description":"Error definition/message.",
            "type":"string",
            "example":"Request body is missing: identifier"
        }
    }
}

Back to Top