MessageDefinition-CDR-PatientSubmit
Overview
A Patient record can be submitted to the CDR by sending a FHIR message Bundle to the $process-message endpoint. The CDR-PatientSubmit MessageDefinition defines the message used to create a new Application Managed Patient record when the patient is not already present in the CDR. This enables submitting systems to establish a local CDR Patient record before submitting associated patient record items. Gold Patient and Silver patient records are created and maintained from the Welsh Demographic Service, or Health Board PAS, and must not be submitted using this message. The message supports upsert behaviour. If a Patient record already exists in the CDR with the same application managed identifier in Patient.identifier, the existing record is updated rather than a duplicate Patient record being created.
Formal Views of Profile Content
- Overview
- Table
- XML
- JSON
| MessageDefinition |
| id : CDR-PatientSubmit |
| url : https://fhir.nhs.wales/MessageDefinition/CDR-PatientSubmit |
| name : CDR-PatientSubmit |
| title : Message Definition - CDR - Patient Submit |
| status : draft |
| experimental : True |
| date : 2026-06-12 |
| publisher : NHS Wales |
| contact |
| name : Data Standards |
| telecom |
| system : email |
| value : data.standards@wales.nhs.uk |
| use : work |
| description : A Patient record can be submitted to the CDR by sending a FHIR message Bundle to the $process-message endpoint. The CDR-PatientSubmit MessageDefinition defines the message used to create a new Application Managed Patient record when the patient is not already present in the CDR. This enables submitting systems to establish a local CDR Patient record before submitting associated patient record items. Gold Patient and Silver patient records are created and maintained from the Welsh Demographic Service, or Health Board PAS, and must not be submitted using this message. The message supports upsert behaviour. If a Patient record already exists in the CDR with the same application managed identifier in Patient.identifier, the existing record is updated rather than a duplicate Patient record being created. |
| event |
| system : https://fhir.nhs.wales/CodeSystem/CDR-MessageEvents |
| code : patient-submit |
| focus |
| code : Patient |
| profile : https://fhir.nhs.wales/StructureDefinition/CDR-Patient-Bronze |
| min : 1 |
| max : 1 |
| MessageDefinition.id[0] | CDR-PatientSubmit |
| MessageDefinition.url[0] | https://fhir.nhs.wales/MessageDefinition/CDR-PatientSubmit |
| MessageDefinition.name[0] | CDR-PatientSubmit |
| MessageDefinition.title[0] | Message Definition - CDR - Patient Submit |
| MessageDefinition.status[0] | draft |
| MessageDefinition.experimental[0] | True |
| MessageDefinition.date[0] | 2026-06-12 |
| MessageDefinition.publisher[0] | NHS Wales |
| MessageDefinition.contact[0].name[0] | Data Standards |
| MessageDefinition.contact[0].telecom[0].system[0] | |
| MessageDefinition.contact[0].telecom[0].value[0] | data.standards@wales.nhs.uk |
| MessageDefinition.contact[0].telecom[0].use[0] | work |
| MessageDefinition.description[0] | A Patient record can be submitted to the CDR by sending a FHIR message Bundle to the $process-message endpoint. The CDR-PatientSubmit MessageDefinition defines the message used to create a new Application Managed Patient record when the patient is not already present in the CDR. This enables submitting systems to establish a local CDR Patient record before submitting associated patient record items. Gold Patient and Silver patient records are created and maintained from the Welsh Demographic Service, or Health Board PAS, and must not be submitted using this message. The message supports upsert behaviour. If a Patient record already exists in the CDR with the same application managed identifier in Patient.identifier, the existing record is updated rather than a duplicate Patient record being created. |
| MessageDefinition.event[0].system[0] | https://fhir.nhs.wales/CodeSystem/CDR-MessageEvents |
| MessageDefinition.event[0].code[0] | patient-submit |
| MessageDefinition.focus[0].code[0] | Patient |
| MessageDefinition.focus[0].profile[0] | https://fhir.nhs.wales/StructureDefinition/CDR-Patient-Bronze |
| MessageDefinition.focus[0].min[0] | 1 |
| MessageDefinition.focus[0].max[0] | 1 |
</telecom>
</contact>
<description value="A Patient record can be submitted to the CDR by sending a FHIR message Bundle to the $process-message endpoint. The CDR-PatientSubmit MessageDefinition defines the message used to create a new Application Managed Patient record when the patient is not already present in the CDR. This enables submitting systems to establish a local CDR Patient record before submitting associated patient record items. Gold Patient and Silver patient records are created and maintained from the Welsh Demographic Service, or Health Board PAS, and must not be submitted using this message. The message supports upsert behaviour. If a Patient record already exists in the CDR with the same application managed identifier in Patient.identifier, the existing record is updated rather than a duplicate Patient record being created." />
</eventCoding>
</focus>
</MessageDefinition>
{
{
]
}
],
"description": "A Patient record can be submitted to the CDR by sending a FHIR message Bundle to the $process-message endpoint. The CDR-PatientSubmit MessageDefinition defines the message used to create a new Application Managed Patient record when the patient is not already present in the CDR. This enables submitting systems to establish a local CDR Patient record before submitting associated patient record items. Gold Patient and Silver patient records are created and maintained from the Welsh Demographic Service, or Health Board PAS, and must not be submitted using this message. The message supports upsert behaviour. If a Patient record already exists in the CDR with the same application managed identifier in Patient.identifier, the existing record is updated rather than a duplicate Patient record being created.",
},
{
}
]
}
Example
Metadata
| Name | Canonical_URL | Status |
|---|---|---|
| CDR-PatientSubmit | https://fhir.nhs.wales/MessageDefinition/CDR-PatientSubmit | draft |