Endpoint: /Patient/Get

This endpoint will be used to retrieve patient information for a given x-scope / group / customer.

Request: JSON

{
    "PatientEventID": int,
    "AdditionalData": string
}

Field	Data Type	Required	Comments
PatientEventID	Integer	Required	The GEHRIMED Patient ID
AdditionalData	String	Not Required	A comma seperated list of extra data to include in the result set. Current valid values are SmokingStatus, GenderIdentity, and SexualOrientation.

Response: JSON

{
    "Metadata": {
        "ApiSender": string,
        "ApiConsumer": string,
        "MessageDateTime": DateTime
    },
    "Data": {
        "Patient": {
            "PatientID": int,
            "PatientExternalID": string,
            "PatientSecondaryExternalID": string,
            "PatientEventID": int,
            "PatientStatus": string,
            "PatientFirst": string,
            "PatientMiddle": string,
            "PatientLast": string,
            "PatientDOB": DateTime,
            "PatientEmail": string,
            "DeceasedDate": DateTime,
            "PatientSSN": string,
            "PatientGender": string,
            "PatientEthnicity": [
                {
                    "EthnicityName": string,
                    "HL7Code": string,
                    "UniqueIdentifier": string,
                    "HierarchicalCode": string
                }
            ],
            "PatientRace": [
                {
                    "RaceName": string,
                    "HL7RaceCode": string,
                    "HierarchicalCode": string
                }
            ],
            "PatientAddress": {
                "AddressLine1": string,
                "AddressLine2": string,
                "City": string,
                "State": string,
                "Zip": string
            },
            "PatientPhone": string,
            "PatientMobilePhone": string,
            "PatientFloor": string,
            "PatientRoom": string,
            "PatientAdmitDate": DateTime,
            "PatientDischargeDate": DateTime,
            "PatientSmokingStatus": string,
            "PatientGenderIdentity": string,
            "PatientSexualOrientation": string,
            "Facility": {
                "FacilityName": string,
                "PlaceOfServiceCode": int,
                "NPI": string,
                "ExternalID": string,
                "FacilityAddress": {
                    "AddressLine1": string,
                    "AddressLine2": string,
                    "City": string,
                    "State": string,
                    "Zip": string
                }
            },
            "ProblemList": [
                {
                    "ICD10": string,
                    "SNOMED": long,
                    "Status": int,
                    "StatusText": string
                }
            ],
            "Insurance": [
                {
                    "InsuranceSetID": int,
                    "InsuranceCode": string,
                    "CompanyName": string,
                    "CompanyAddress": {
                        "AddressLine1": string,
                        "AddressLine2": string,
                        "City": string,
                        "State": string,
                        "Zip": string
                    },
                    "CompanyContact": string,
                    "CompanyContactPhone": string,
                    "GroupNumber": string,
                    "GroupName": string,
                    "GroupEmployerID": string,
                    "PlanEffectiveDate": DateTime,
                    "PlanExpirationDate": DateTime,
                    "InsuranceType": string,
                    "SubscriberFirst": string,
                    "SubscriberLast": string,
                    "SubscriberGender": string,
                    "SubscriberRelationToPatient": string,
                    "SubscriberAddress": {
                        "AddressLine1": string,
                        "AddressLine2": string,
                        "City": string,
                        "State": string,
                        "Zip": string
                    },
                    "AssignmentOfBenefits": DateTime,
                    "InsurancePriority": string,
                    "PolicyNumber": string,
                    "SubscriberEmployerAddress": {
                        "AddressLine1": string,
                        "AddressLine2": string,
                        "City": string,
                        "State": string,
                        "Zip": string
                    }
                }
            ],
            "PatientLanguage": {
                "LanguageName": string,
                "Code_639_1": string,
                "Code_639_2": string
            },
            "IsACO": bool,
            "PatientSmokingCessation": string,
            "PatientSmokingStatusDateChange": DateTime,
            "PatientGenderIdentityOther": string,
            "PatientSexualOrientationOther": string,
            "PatientEnrollments": [
                {
                    "ProgramCode": string,
                    "EndDate": DateTime,
                    "StartDate": DateTime,
                    "Status": bool,
                    "ProgramCodeAlias": string,
                    "ExistingEnrollmentID": int
                }
            ],
            "MedicareNumber": string,
            "MedicaidNumber": string
        }
    }
}