AGHA.FHIR.GENCLIPR\Deidentified Patient

Genomics Clinical Picture Repository Implementation Guide
0.1.0 - ci-build

Genomics Clinical Picture Repository Implementation Guide - Local Development build (v0.1.0). See the Directory of published versions

Resource Profile: Deidentified Patient

Official URL: http://aehrc.github.io/genclipr-fhir-ig/StructureDefinition/DeidentifiedPatient				Version: 0.1.0
Active as of 2022-03-21				Computable Name: DeidentifiedPatient
Copyright/Legal: Australian Genomics

A deidentified patient whose clinical picture is being stored in the repository.

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

Text Summary
Differential Table
Snapshot Table
Snapshot Table (Must Support)
All

This structure is derived from Patient

Summary

Mandatory: 2 elements
Must-Support: 3 elements
Prohibited: 7 elements

This structure is derived from Patient

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	Patient	Information about an individual or animal receiving health care services
identifier	S	1..*	Identifier	An identifier for this patient
type		0..1	CodeableConcept	Description of identifier Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
code		1..1	code	Symbol in syntax defined by the system Fixed Value: PI
name		0..0
telecom		0..0
gender	S	0..1	code	male \| female \| other \| unknown
birthDate	S	1..1	date	The date of birth for the individual
address		0..0
maritalStatus		0..0
photo		0..0
contact		0..0
generalPractitioner		0..0
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	Patient	Information about an individual or animal receiving health care services
id	Σ	0..1	string	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language.
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	1..*	Identifier	An identifier for this patient
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual \| official \| temp \| secondary \| old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: PI
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
system	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	0..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
gender	SΣ	0..1	code	male \| female \| other \| unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	SΣ	1..1	date	The date of birth for the individual
deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not
deceasedBoolean			boolean
deceasedDateTime			dateTime
multipleBirth[x]		0..1		Whether patient is part of a multiple birth
multipleBirthBoolean			boolean
multipleBirthInteger			integer
communication		0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
language		1..1	CodeableConcept	The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language.
preferred		0..1	boolean	Language preference indicator
managingOrganization	Σ	0..1	Reference(Organization)	Organization that is the custodian of the patient record
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
other	Σ	1..1	Reference(Patient \| RelatedPerson)	The other patient or related person resource that the link refers to
type	Σ	1..1	code	replaced-by \| replaces \| refer \| seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	Patient	Information about an individual or animal receiving health care services
identifier	Σ	1..*	Identifier	An identifier for this patient
gender	Σ	0..1	code	male \| female \| other \| unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	Σ	1..1	date	The date of birth for the individual
Documentation for this format

This structure is derived from Patient

Summary

Mandatory: 2 elements
Must-Support: 3 elements
Prohibited: 7 elements

Differential View

This structure is derived from Patient

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	Patient	Information about an individual or animal receiving health care services
identifier	S	1..*	Identifier	An identifier for this patient
type		0..1	CodeableConcept	Description of identifier Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
code		1..1	code	Symbol in syntax defined by the system Fixed Value: PI
name		0..0
telecom		0..0
gender	S	0..1	code	male \| female \| other \| unknown
birthDate	S	1..1	date	The date of birth for the individual
address		0..0
maritalStatus		0..0
photo		0..0
contact		0..0
generalPractitioner		0..0
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	Patient	Information about an individual or animal receiving health care services
id	Σ	0..1	string	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language.
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	1..*	Identifier	An identifier for this patient
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual \| official \| temp \| secondary \| old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: PI
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
system	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	0..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
gender	SΣ	0..1	code	male \| female \| other \| unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	SΣ	1..1	date	The date of birth for the individual
deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not
deceasedBoolean			boolean
deceasedDateTime			dateTime
multipleBirth[x]		0..1		Whether patient is part of a multiple birth
multipleBirthBoolean			boolean
multipleBirthInteger			integer
communication		0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
language		1..1	CodeableConcept	The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language.
preferred		0..1	boolean	Language preference indicator
managingOrganization	Σ	0..1	Reference(Organization)	Organization that is the custodian of the patient record
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
other	Σ	1..1	Reference(Patient \| RelatedPerson)	The other patient or related person resource that the link refers to
type	Σ	1..1	code	replaced-by \| replaces \| refer \| seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

Path	Conformance	ValueSet / Code
Patient.language	preferred	CommonLanguages Max Binding: AllLanguages
Patient.identifier.use	required	IdentifierUse
Patient.identifier.type	extensible	Pattern: PI
Patient.gender	required	AdministrativeGender
Patient.contact.relationship	extensible	PatientContactRelationship
Patient.contact.gender	required	AdministrativeGender
Patient.communication.language	preferred	CommonLanguages Max Binding: AllLanguages
Patient.link.type	required	LinkType

Constraints

Id	Grade	Path	Details	Requirements
dom-2	error	Patient	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Patient	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference \| %resource.descendants().as(canonical) \| %resource.descendants().as(uri) \| %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Patient	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Patient	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	Best Practice	Patient	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	Patient.meta	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Patient.implicitRules	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Patient.language	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Patient.text	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Patient.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	Patient.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	Patient.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	Patient.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	Patient.identifier	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Patient.identifier.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	Patient.identifier.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	Patient.identifier.use	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Patient.identifier.type	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Patient.identifier.system	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Patient.identifier.value	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Patient.identifier.period	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Patient.identifier.assigner	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Patient.active	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Patient.gender	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Patient.birthDate	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Patient.deceased[x]	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Patient.multipleBirth[x]	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Patient.contact.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	Patient.contact.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	Patient.contact.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	Patient.contact.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	Patient.contact.relationship	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Patient.contact.name	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Patient.contact.telecom	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Patient.contact.address	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Patient.contact.gender	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Patient.contact.organization	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Patient.contact.period	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Patient.communication	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Patient.communication.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	Patient.communication.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	Patient.communication.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	Patient.communication.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	Patient.communication.language	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Patient.communication.preferred	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Patient.managingOrganization	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Patient.link	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Patient.link.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	Patient.link.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	Patient.link.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	Patient.link.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	Patient.link.other	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Patient.link.type	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())

IG © 2021+ The Australian e-Health Research Centre. Package agha.fhir.genclipr#0.1.0 based on FHIR 4.0.1. Generated 2022-03-21
Links: Table of Contents | QA Report