blob: b52fb9bf10ff087117c110b63eb18bd0f11783ab [file] [log] [blame]
/**
*/
package org.hl7.fhir;
/**
* <!-- begin-user-doc -->
* A representation of the model object '<em><b>Provenance Entity</b></em>'.
* <!-- end-user-doc -->
*
* <!-- begin-model-doc -->
* Provenance of a resource is a record that describes entities and processes involved in producing and delivering or otherwise influencing that resource. Provenance provides a critical foundation for assessing authenticity, enabling trust, and allowing reproducibility. Provenance assertions are a form of contextual metadata and can themselves become important records with their own provenance. Provenance statement indicates clinical significance in terms of confidence in authenticity, reliability, and trustworthiness, integrity, and stage in lifecycle (e.g. Document Completion - has the artifact been legally authenticated), all of which may impact security, privacy, and trust policies.
* <!-- end-model-doc -->
*
* <p>
* The following features are supported:
* </p>
* <ul>
* <li>{@link org.hl7.fhir.ProvenanceEntity#getRole <em>Role</em>}</li>
* <li>{@link org.hl7.fhir.ProvenanceEntity#getType <em>Type</em>}</li>
* <li>{@link org.hl7.fhir.ProvenanceEntity#getReference <em>Reference</em>}</li>
* <li>{@link org.hl7.fhir.ProvenanceEntity#getDisplay <em>Display</em>}</li>
* <li>{@link org.hl7.fhir.ProvenanceEntity#getAgent <em>Agent</em>}</li>
* </ul>
*
* @see org.hl7.fhir.FhirPackage#getProvenanceEntity()
* @model extendedMetaData="name='Provenance.Entity' kind='elementOnly'"
* @generated
*/
public interface ProvenanceEntity extends BackboneElement {
/**
* Returns the value of the '<em><b>Role</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* How the entity was used during the activity.
* <!-- end-model-doc -->
* @return the value of the '<em>Role</em>' containment reference.
* @see #setRole(ProvenanceEntityRole)
* @see org.hl7.fhir.FhirPackage#getProvenanceEntity_Role()
* @model containment="true" required="true"
* extendedMetaData="kind='element' name='role' namespace='##targetNamespace'"
* @generated
*/
ProvenanceEntityRole getRole();
/**
* Sets the value of the '{@link org.hl7.fhir.ProvenanceEntity#getRole <em>Role</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Role</em>' containment reference.
* @see #getRole()
* @generated
*/
void setRole(ProvenanceEntityRole value);
/**
* Returns the value of the '<em><b>Type</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* The type of the entity. If the entity is a resource, then this is a resource type.
* <!-- end-model-doc -->
* @return the value of the '<em>Type</em>' containment reference.
* @see #setType(Coding)
* @see org.hl7.fhir.FhirPackage#getProvenanceEntity_Type()
* @model containment="true" required="true"
* extendedMetaData="kind='element' name='type' namespace='##targetNamespace'"
* @generated
*/
Coding getType();
/**
* Sets the value of the '{@link org.hl7.fhir.ProvenanceEntity#getType <em>Type</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Type</em>' containment reference.
* @see #getType()
* @generated
*/
void setType(Coding value);
/**
* Returns the value of the '<em><b>Reference</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* Identity of the Entity used. May be a logical or physical uri and maybe absolute or relative.
* <!-- end-model-doc -->
* @return the value of the '<em>Reference</em>' containment reference.
* @see #setReference(Uri)
* @see org.hl7.fhir.FhirPackage#getProvenanceEntity_Reference()
* @model containment="true" required="true"
* extendedMetaData="kind='element' name='reference' namespace='##targetNamespace'"
* @generated
*/
Uri getReference();
/**
* Sets the value of the '{@link org.hl7.fhir.ProvenanceEntity#getReference <em>Reference</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Reference</em>' containment reference.
* @see #getReference()
* @generated
*/
void setReference(Uri value);
/**
* Returns the value of the '<em><b>Display</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* Human-readable description of the entity.
* <!-- end-model-doc -->
* @return the value of the '<em>Display</em>' containment reference.
* @see #setDisplay(org.hl7.fhir.String)
* @see org.hl7.fhir.FhirPackage#getProvenanceEntity_Display()
* @model containment="true"
* extendedMetaData="kind='element' name='display' namespace='##targetNamespace'"
* @generated
*/
org.hl7.fhir.String getDisplay();
/**
* Sets the value of the '{@link org.hl7.fhir.ProvenanceEntity#getDisplay <em>Display</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Display</em>' containment reference.
* @see #getDisplay()
* @generated
*/
void setDisplay(org.hl7.fhir.String value);
/**
* Returns the value of the '<em><b>Agent</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* The entity is attributed to an agent to express the agent's responsibility for that entity, possibly along with other agents. This description can be understood as shorthand for saying that the agent was responsible for the activity which generated the entity.
* <!-- end-model-doc -->
* @return the value of the '<em>Agent</em>' containment reference.
* @see #setAgent(ProvenanceAgent)
* @see org.hl7.fhir.FhirPackage#getProvenanceEntity_Agent()
* @model containment="true"
* extendedMetaData="kind='element' name='agent' namespace='##targetNamespace'"
* @generated
*/
ProvenanceAgent getAgent();
/**
* Sets the value of the '{@link org.hl7.fhir.ProvenanceEntity#getAgent <em>Agent</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Agent</em>' containment reference.
* @see #getAgent()
* @generated
*/
void setAgent(ProvenanceAgent value);
} // ProvenanceEntity