Update patient identifiers via webservices.rest api

preethi.s · July 27, 2016, 6:08am

We are looking for a way to edit extra identifiers of a patient via webservices.rest. When patient is configured to have extra identifiers( which might be optional) like Driving license, National ID, etc… currently Webservices rest forces to add the identifiers when the patient is getting created. We would need the ability to add or edit identifiers at a later point of time after a patient is created.

The code which forces to add identifiers:

github.com

openmrs/openmrs-module-webservices.rest/blob/master/omod-1.8/src/main/java/org/openmrs/module/webservices/rest/web/v1_0/resource/openmrs1_8/PatientResource1_8.java#L87


	public static Set<PatientIdentifier> getIdentifiers(Patient instance) {
		return new LinkedHashSet<PatientIdentifier>(instance.getActiveIdentifiers());
	}
	
	@PropertySetter("identifiers")
	public static void setIdentifiers(Patient instance, List<PatientIdentifier> identifiers)
	        throws ResourceDoesNotSupportOperationException {
		if (instance.getIdentifiers() != null && instance.getIdentifiers().containsAll(identifiers)) {
			return;
		}
		if (instance.getIdentifiers() != null && !instance.getIdentifiers().isEmpty()) {
			throw new ResourceDoesNotSupportOperationException("Identifiers can only be set for newly created objects!");
		}
		if (identifiers == null || identifiers.isEmpty()) {
			throw new ResourceDoesNotSupportOperationException("At least one identifier required");
		}
		
		boolean hasPreferred = false;
		for (PatientIdentifier identifier : identifiers) {
			if (identifier.isPreferred()) {
				if (!hasPreferred) {

Also we found that PatientService in openmrs core supports editing a patient identifier

github.com

openmrs/openmrs-core/blob/master/api/src/main/java/org/openmrs/api/impl/PatientServiceImpl.java#L1353


	@Override
	@Transactional(readOnly = true)
	public PatientIdentifier getPatientIdentifier(Integer patientIdentifierId) throws APIException {
		return dao.getPatientIdentifier(patientIdentifierId);
	}
	
	/**
	 * @see org.openmrs.api.PatientService#voidPatientIdentifier(org.openmrs.PatientIdentifier,
	 *      java.lang.String)
	 */
	@Override
	public PatientIdentifier voidPatientIdentifier(PatientIdentifier patientIdentifier, String reason) throws APIException {
		
		if (patientIdentifier == null || StringUtils.isBlank(reason)) {
			throw new APIException("Patient.identifier.cannot.be.null", (Object[]) null);
		}
		return Context.getPatientService().savePatientIdentifier(patientIdentifier);
		
	}
	
	/**

Is there a reason for not supporting update of patient identifiers and adding patient identifiers while editing a patient?

pascal · July 27, 2016, 6:41am

Can you use the PatientIdentifierResource?

github.com

openmrs/openmrs-module-webservices.rest/blob/master/omod-1.8/src/main/java/org/openmrs/module/webservices/rest/web/v1_0/resource/openmrs1_8/PatientIdentifierResource1_8.java#L155


			        .property("identifier", new StringProperty())
			        .property("preferred", new BooleanProperty()._default(false))
			        .property("voided", new BooleanProperty());
		}
		if (rep instanceof DefaultRepresentation) {
			model
			        .property("identifierType", new RefProperty("#/definitions/PatientidentifiertypeGetRef"))
			        .property("location", new RefProperty("#/definitions/LocationGetRef"));
		} else if (rep instanceof FullRepresentation) {
			model
			        .property("identifierType", new RefProperty("#/definitions/PatientidentifiertypeGet"))
			        .property("location", new RefProperty("#/definitions/LocationGet"));
		}
		return model;
	}
	
	@Override
	public Model getCREATEModel(Representation rep) {
		ModelImpl model = new ModelImpl()
		        .property("identifier", new StringProperty())
		        .property("identifierType", new StringProperty().example("uuid"))

Docs here: https://psbrandt.io/openmrs-contrib-apidocs/#operation--patient--parent-uuid--identifier--uuid--post

darius · July 27, 2016, 7:36pm

Hi @preethi_s! As @pascal says, the intended behavior for these collection subresources is that you can create any number of them the first time you create the patient (or concept, or location, etc), but afterwards you need to interact with the subresource directly to add/edit/delete. Hopefully this addresses your issue.

FYI we recently ran into a scenario where this approach wasn’t good enough, because they needed to edit multiple concept names in a single transaction. If your scenario requires it, we’re open to you expanding the current implementation in the same way.

You can read about it in this thread: