--- title: "DELETE /settings/organizations/{organizationName}/receivers/{receiverName}" method: DELETE path: "/settings/organizations/{organizationName}/receivers/{receiverName}" --- # DELETE /settings/organizations/{organizationName}/receivers/{receiverName} `DELETE /settings/organizations/{organizationName}/receivers/{receiverName}` Delete a receiver ## Path parameters - `organizationName` string, required - `receiverName` string, required ## Response `200` OK, the receiver was deleted - Receiver — A receiver of reports from the data hub - `description` string, required — Display ready description of the receiver - `jurisdictionalFilters` object[] — What items to include in the report. - `doesNotMatch` boolean — Ensure that the result does not match - `matchFields` 'FACILITY_OR_PATIENT_ADDRESS' | 'FACILITY_ADDRESS' | 'FACILITY_NAME' | 'ABNORMAL_VALUE' — What fields to match in the filter - `matchValues` string[] — What is the value to match against - `meta` SettingMetadata — The metadata associated with an setting - `createdAt` string, time-date — the time that the particular revision was created - `createdBy` string — the user who created the particular revision - `version` number — the version number of the object - `name` string, required — The unique name for the receiver. Should include the organization name as a prefix. - `organizationName` string — The name of the organization that this receiver belongs to - `timing` object, required — When the report is sent if not immediately - `dailyAt` number — The UTC hour to send a daily batch - `frequency` 'REAL_TIME' | 'HOURLY' | 'DAILY', required — How often send a report - `topic` string, required — The topic of for this receiver. Must match the supported topics. - `translations` union[] — How the report is translated from the sender. A report can be sent in multiple ways. - union - CustomConfiguration — A custom configuration for a custom schema - `format` 'CSV' | 'HL7', required — The format of the serializer - `nameFormat` string — The format to use for the file name generated by the translation - `receivingOrganization` string — The name of the receiving organization in the message - `schemaName` string, required — The name of the custom schema - `transport` union, required — The transport to use - SFTPTransport — Describes a single SFTP connection in all of it variations - `filePath` string, required — The file path to place the report - `host` string, required — Host name and domain - `port` number, required — The port to use - `type` string, required — The discriminator - AS2Transport — Describes a single AS2 connection in all of it variations - `contentDescription` string — A description of the content of the message. Usually, the same for all messages. - `mimeType` string — The MIME type of the message - `receiverId` string, required — The AS2 id of the receiver. Usually, the same for all senders. - `receiverUrl` string, required — The URL to the AS2 end-point - `senderEmail` string — The email address to contact someone about the message - `senderId` string, required — The AS2 id of the sender. Usually, assigned by receiver to PRIME. - `type` string, required — The discriminator - BlobStoreTransport — Moves results to a Azure Blob Store. Typcially used for HHS Protect interfaces. - `containerName` string, required — This name of the Azure container - `storageName` string, required — This looks for an env var with this name. env var value is the connection string - `type` string, required — The discriminator - NullTransport — A transport type that does not do anything - `dummy` string — A dummy value - `type` string, required — The discriminator - `type` string, required — The discrimenator - StandardHL7Configuration — A standard HL7 configuration - `convertTimestampToDateTime` string — A comma delimited list of HL7 fields to convert to the yyyMMddHHmmss format - `defaultAoeToUnknown` boolean — Default the AOE result to UNK - `includeAOE` boolean, required — Include the AOE - `nameFormat` string — The format to use for the file name generated by the translation - `phoneNumberFormatting` 'STANDARD' | 'ONLY_DIGITS_IN_COMPONENT_ONE' | 'AREA_LOCAL_IN_COMPONENT_ONE' — How to format phone numbers (XTN fields) - `receivingApplicationName` string — The receiving application name (needed for HL7 formats) - `receivingApplicationOID` string — The receiving application OID - `receivingFacilityName` string — The receiving facility name - `receivingFacilityOID` string — The receiving facility name - `receivingOrganization` string — The name of the receiving organization in the message - `reportingFacilityId` string — The reporting facility id (if different from CDC PRIME's OID) - `reportingFacilityIdType` string — The reporting facility id type (if different from OID) - `reportingFacilityName` string — The reporting facility name (if different from CDC PRIME) - `suppressAoe` boolean — Suppress the AOE OBX results - `suppressHl7Fields` string — A comma delimited list of HL7 fields to suppress - `suppressQstForAoe` boolean — Suppress QST component is AOE OBX segments - `transport` union, required - SFTPTransport — Describes a single SFTP connection in all of it variations - `filePath` string, required — The file path to place the report - `host` string, required — Host name and domain - `port` number, required — The port to use - `type` string, required — The discriminator - AS2Transport — Describes a single AS2 connection in all of it variations - `contentDescription` string — A description of the content of the message. Usually, the same for all messages. - `mimeType` string — The MIME type of the message - `receiverId` string, required — The AS2 id of the receiver. Usually, the same for all senders. - `receiverUrl` string, required — The URL to the AS2 end-point - `senderEmail` string — The email address to contact someone about the message - `senderId` string, required — The AS2 id of the sender. Usually, assigned by receiver to PRIME. - `type` string, required — The discriminator - BlobStoreTransport — Moves results to a Azure Blob Store. Typcially used for HHS Protect interfaces. - `containerName` string, required — This name of the Azure container - `storageName` string, required — This looks for an env var with this name. env var value is the connection string - `type` string, required — The discriminator - NullTransport — A transport type that does not do anything - `dummy` string — A dummy value - `type` string, required — The discriminator - `truncateHDNamespaceIds` boolean — Truncate the HD fields to HD_TRUNCATION_LIMIT - `type` string, required — The discrimenator - `useBatchHeaders` boolean, required — Use BHS and FHS header - `useBlankInsteadOfUnknown` string — A comma delimited list of element names that should use blank instead of unknown - `usePid14ForPatientEmail` boolean — Use the PID-14 field for patient email instead of the standard PID-13 field - `useTestProcessingMode` boolean — Set a test process mode flag - unknown ## Other responses - `400` — Bad Request - `401` — Unauthorized --- [API](https://skmtc.net/cdcgov/apis/prime-data-hub.md) · [All operations](https://skmtc.net/cdcgov/apis/prime-data-hub/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cdcgov/prime-data-hub/versions/c3d0b945fe18/schema)